/** * SmartyMeet Dev03 API REST * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.0.1 * Contact: developer@smartymeet.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { CandidatesSchema, CreateTalentRequestBody, ListTalentCandidatesRelationship, TalentSchema, TalentsSchema, UpdateTalentRequestBody } from '../models/index'; export interface CreateTalentRequest { createTalentRequestBody: CreateTalentRequestBody; } export interface DeleteTalentRequest { talentId: string; } export interface ListTalentCandidatesRequest { talentId: string; } export interface ListTalentCandidatesRelationshipRequest { talentId: string; } export interface ListTalentsRequest { filterStatus?: ListTalentsFilterStatusEnum; filterShortCode?: string; filterEmail?: string; filterPhone?: string; filterCreatedFrom?: Date; filterCreatedTo?: Date; filterModifiedFrom?: Date; filterModifiedTo?: Date; pageSize?: number; pageNumber?: number; pageAfter?: string; pageBefore?: string; } export interface ShowTalentRequest { talentId: string; language?: ShowTalentLanguageEnum; } export interface TalentCandidatesOptionsRequest { talentId: string; } export interface TalentCandidatesRelationshipsOptionsRequest { talentId: string; } export interface TalentOptionsRequest { talentId: string; } export interface UpdateTalentRequest { talentId: string; updateTalentRequestBody: UpdateTalentRequestBody; } /** * */ export declare class TalentsApi extends runtime.BaseAPI { /** * Creates request options for createTalent without sending the request */ createTalentRequestOpts(requestParameters: CreateTalentRequest): Promise; /** * Creates a new talent in your account. ### Talent\'s Attributes Here is a table that describes the attributes of the talent object: | Attribute | Type | Required | Format | Description | |-----------|------|----------|---------|-------------| | `name` | string | Yes | - | The full name of the talent | | `email` | string | Yes | email | Primary email address of the talent | | `status` | string | No | enum | Current status: active, inactive, pending, archived, failed | | `secondaryEmail` | string | No | email | Secondary email address | | `workEmail` | string | No | email | Work email address | | `phone` | string | No | - | Primary phone number | | `workPhone` | string | No | - | Work phone number | | `profilePictureUrl` | string | No | url | URL to profile picture, can be null | | `availability` | object | No | localized | Language-keyed availability with priority and received items (e.g. `{ \"en-US\": { name, description, priority, received: [...] } }`) | | `desiredContractLength` | object | No | - | Contract length preferences | | `desiredContractLength.duration` | string | No | - | Desired contract duration, can be null | | `desiredContractLength.isAssumed` | boolean | No | - | Whether duration was assumed from context | | `desiredContractLength.confidence` | string | No | enum | Confidence level: Low, Medium, High | | `desiredContractLength.flexibility` | string | No | - | Flexibility in contract length, can be null | | `desiredContractLength.reasoning` | string | No | - | Reasoning for assumed duration | | `employmentType` | object | No | - | Employment type preferences | | `employmentType.status` | string | No | - | Current employment status | | `employmentType.isAssumed` | boolean | No | - | Whether status was assumed | | `employmentType.confidence` | string | No | enum | Confidence level: Low, Medium, High | | `employmentType.additionalContext` | string | No | - | Additional context, can be null | | `employmentType.reasoning` | string | No | - | Reasoning for assumptions, can be null | | `experienceAndSeniority` | object | No | localized | Language-keyed experience criteria with `{ name, description, received: [...] }` per locale | | `breakReason` | string | No | - | Reason for career break | | `quickInsights` | object | No | localized | Language-keyed quick insights string (e.g. `{ \"en-US\": \"...\" }`) | | `languagesSpoken` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `socialLinks` | array | No | - | Array of social media profiles | | `socialLinks[].platform` | string | No | - | Social media platform name | | `socialLinks[].url` | string | No | - | Profile URL | | `desiredRole` | array | No | - | Array of desired roles | | `desiredRole[].role` | string | No | - | Desired role title | | `desiredRole[].level` | string | No | - | Desired seniority level | | `desiredRole[].isAssumed` | boolean | No | - | Whether preference was assumed | | `desiredRole[].confidence` | string | No | enum | Confidence level: Low, Medium, High | | `desiredRole[].reasoning` | string | No | - | Reasoning for assumptions | | `workPreferences` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `locationPreferences` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `workAuthorization` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `skillsAndExpertise` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `certifications` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `licenses` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `professionalExperience` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `industryExperience` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `companyTypeExperience` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `jobPositions` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `jobTendencies` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `education` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `projectsAndAchievements` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `personalityAndSoftSkills` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale. Items use `details` (not `evidence`). | | `hobbiesAndInterests` | object | No | localized | Language-keyed string arrays (e.g. `{ \"en-US\": [\"hobby1\", \"hobby2\"] }`) | | `references` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `keywords` | object | No | localized | Language-keyed string arrays (e.g. `{ \"en-US\": [\"keyword1\", \"keyword2\"] }`) | | `salaryExpectation` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `relocationWillingness` | boolean | No | - | Whether willing to relocate | | `requiresSponsorship` | boolean | No | - | Whether requires visa sponsorship | | `careerBreak` | boolean | No | - | Whether currently on career break | | `isTalentPool` | boolean | No | - | Whether this talent is part of a talent pool | | `ttl` | string | No | - | Time-to-live expiration timestamp, can be null | | `alumni` | object | No | - | Alumni/former employee info (`isFormerEmployee`, `previousTenureMonths`, `wantsToReturn`) | | `referral` | object | No | - | Referral info (`isReferred`, `referralCode`, `referrer: { email, fullName }`) | | `age` | string | No | - | Age of the talent | | `gender` | string | No | - | Gender of the talent | | `settings` | object | No | - | Additional settings (free-form) | | `shortCode` | string | No | - | Unique short identifier | | `source` | string | No | - | Source of the talent record | | `timestamps.created` | string | No | date-time | Creation timestamp (ISO 8601) | | `timestamps.modified` | string | No | date-time | Last modification timestamp (ISO 8601) | Localized fields use `additionalProperties` with language-code keys (e.g. `en-US`, `pl-PL`). Most localized fields follow the `TalentReceivedCriteriaSchema` pattern with `{ name, description, received: [objects] }`. The `availability` field additionally includes `priority`, `priorityConfidence`, and `priorityReasoning`. Fields `hobbiesAndInterests` and `keywords` are localized string arrays. The `quickInsights` field is a localized string. * Create Talent */ createTalentRaw(requestParameters: CreateTalentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new talent in your account. ### Talent\'s Attributes Here is a table that describes the attributes of the talent object: | Attribute | Type | Required | Format | Description | |-----------|------|----------|---------|-------------| | `name` | string | Yes | - | The full name of the talent | | `email` | string | Yes | email | Primary email address of the talent | | `status` | string | No | enum | Current status: active, inactive, pending, archived, failed | | `secondaryEmail` | string | No | email | Secondary email address | | `workEmail` | string | No | email | Work email address | | `phone` | string | No | - | Primary phone number | | `workPhone` | string | No | - | Work phone number | | `profilePictureUrl` | string | No | url | URL to profile picture, can be null | | `availability` | object | No | localized | Language-keyed availability with priority and received items (e.g. `{ \"en-US\": { name, description, priority, received: [...] } }`) | | `desiredContractLength` | object | No | - | Contract length preferences | | `desiredContractLength.duration` | string | No | - | Desired contract duration, can be null | | `desiredContractLength.isAssumed` | boolean | No | - | Whether duration was assumed from context | | `desiredContractLength.confidence` | string | No | enum | Confidence level: Low, Medium, High | | `desiredContractLength.flexibility` | string | No | - | Flexibility in contract length, can be null | | `desiredContractLength.reasoning` | string | No | - | Reasoning for assumed duration | | `employmentType` | object | No | - | Employment type preferences | | `employmentType.status` | string | No | - | Current employment status | | `employmentType.isAssumed` | boolean | No | - | Whether status was assumed | | `employmentType.confidence` | string | No | enum | Confidence level: Low, Medium, High | | `employmentType.additionalContext` | string | No | - | Additional context, can be null | | `employmentType.reasoning` | string | No | - | Reasoning for assumptions, can be null | | `experienceAndSeniority` | object | No | localized | Language-keyed experience criteria with `{ name, description, received: [...] }` per locale | | `breakReason` | string | No | - | Reason for career break | | `quickInsights` | object | No | localized | Language-keyed quick insights string (e.g. `{ \"en-US\": \"...\" }`) | | `languagesSpoken` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `socialLinks` | array | No | - | Array of social media profiles | | `socialLinks[].platform` | string | No | - | Social media platform name | | `socialLinks[].url` | string | No | - | Profile URL | | `desiredRole` | array | No | - | Array of desired roles | | `desiredRole[].role` | string | No | - | Desired role title | | `desiredRole[].level` | string | No | - | Desired seniority level | | `desiredRole[].isAssumed` | boolean | No | - | Whether preference was assumed | | `desiredRole[].confidence` | string | No | enum | Confidence level: Low, Medium, High | | `desiredRole[].reasoning` | string | No | - | Reasoning for assumptions | | `workPreferences` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `locationPreferences` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `workAuthorization` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `skillsAndExpertise` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `certifications` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `licenses` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `professionalExperience` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `industryExperience` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `companyTypeExperience` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `jobPositions` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `jobTendencies` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `education` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `projectsAndAchievements` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `personalityAndSoftSkills` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale. Items use `details` (not `evidence`). | | `hobbiesAndInterests` | object | No | localized | Language-keyed string arrays (e.g. `{ \"en-US\": [\"hobby1\", \"hobby2\"] }`) | | `references` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `keywords` | object | No | localized | Language-keyed string arrays (e.g. `{ \"en-US\": [\"keyword1\", \"keyword2\"] }`) | | `salaryExpectation` | object | No | localized | Language-keyed criteria with `{ name, description, received: [...] }` per locale | | `relocationWillingness` | boolean | No | - | Whether willing to relocate | | `requiresSponsorship` | boolean | No | - | Whether requires visa sponsorship | | `careerBreak` | boolean | No | - | Whether currently on career break | | `isTalentPool` | boolean | No | - | Whether this talent is part of a talent pool | | `ttl` | string | No | - | Time-to-live expiration timestamp, can be null | | `alumni` | object | No | - | Alumni/former employee info (`isFormerEmployee`, `previousTenureMonths`, `wantsToReturn`) | | `referral` | object | No | - | Referral info (`isReferred`, `referralCode`, `referrer: { email, fullName }`) | | `age` | string | No | - | Age of the talent | | `gender` | string | No | - | Gender of the talent | | `settings` | object | No | - | Additional settings (free-form) | | `shortCode` | string | No | - | Unique short identifier | | `source` | string | No | - | Source of the talent record | | `timestamps.created` | string | No | date-time | Creation timestamp (ISO 8601) | | `timestamps.modified` | string | No | date-time | Last modification timestamp (ISO 8601) | Localized fields use `additionalProperties` with language-code keys (e.g. `en-US`, `pl-PL`). Most localized fields follow the `TalentReceivedCriteriaSchema` pattern with `{ name, description, received: [objects] }`. The `availability` field additionally includes `priority`, `priorityConfidence`, and `priorityReasoning`. Fields `hobbiesAndInterests` and `keywords` are localized string arrays. The `quickInsights` field is a localized string. * Create Talent */ createTalent(requestParameters: CreateTalentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteTalent without sending the request */ deleteTalentRequestOpts(requestParameters: DeleteTalentRequest): Promise; /** * This endpoint allows you to delete a specific talent from your account. Once deleted, the talent\'s information will be permanently removed and cannot be recovered. * Delete Talent */ deleteTalentRaw(requestParameters: DeleteTalentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to delete a specific talent from your account. Once deleted, the talent\'s information will be permanently removed and cannot be recovered. * Delete Talent */ deleteTalent(requestParameters: DeleteTalentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listTalentCandidates without sending the request */ listTalentCandidatesRequestOpts(requestParameters: ListTalentCandidatesRequest): Promise; /** * Returns a collection of candidate resources related to the specified talent. ## JSON:API Relationship Info This endpoint provides the _related_ resources rather than only relationship linkages. * List Talent Candidates */ listTalentCandidatesRaw(requestParameters: ListTalentCandidatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of candidate resources related to the specified talent. ## JSON:API Relationship Info This endpoint provides the _related_ resources rather than only relationship linkages. * List Talent Candidates */ listTalentCandidates(requestParameters: ListTalentCandidatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listTalentCandidatesRelationship without sending the request */ listTalentCandidatesRelationshipRequestOpts(requestParameters: ListTalentCandidatesRelationshipRequest): Promise; /** * Returns the relationship object for the candidates associated with this talent. ## JSON:API Relationship Endpoint This returns only the linkage data (`type` & `id`), plus optional links/meta. * List Talent Candidates Relationship */ listTalentCandidatesRelationshipRaw(requestParameters: ListTalentCandidatesRelationshipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns the relationship object for the candidates associated with this talent. ## JSON:API Relationship Endpoint This returns only the linkage data (`type` & `id`), plus optional links/meta. * List Talent Candidates Relationship */ listTalentCandidatesRelationship(requestParameters: ListTalentCandidatesRelationshipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listTalents without sending the request */ listTalentsRequestOpts(requestParameters: ListTalentsRequest): Promise; /** * Returns a collection of your account talents ## Overview Returns a collection of your account talents, sorted by the time they were inserted into the system in ascending order. ### Talents Endpoints Pagination The talents endpoints support two versions of pagination: traditional and cursor-based. Note that the parameters for these pagination methods cannot coexist; using them together will result in a bad request error. :::tip Pagination tip Ensure that when using traditional pagination, you use `pageNumber`, and when using cursor-based pagination, you use either `pageAfter` or `pageBefore`, but not both together. ::: #### More information For more information, see the [pagination documentation](/docs/pagination). * List Talents */ listTalentsRaw(requestParameters: ListTalentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of your account talents ## Overview Returns a collection of your account talents, sorted by the time they were inserted into the system in ascending order. ### Talents Endpoints Pagination The talents endpoints support two versions of pagination: traditional and cursor-based. Note that the parameters for these pagination methods cannot coexist; using them together will result in a bad request error. :::tip Pagination tip Ensure that when using traditional pagination, you use `pageNumber`, and when using cursor-based pagination, you use either `pageAfter` or `pageBefore`, but not both together. ::: #### More information For more information, see the [pagination documentation](/docs/pagination). * List Talents */ listTalents(requestParameters?: ListTalentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showTalent without sending the request */ showTalentRequestOpts(requestParameters: ShowTalentRequest): Promise; /** * This endpoint retrieves details of a specific talent from your account. You can view information such as name, and other relevant attributes of the talent. Translatable fields are returned as per-locale dictionaries (e.g. en-US, pl-PL). * Show Talent */ showTalentRaw(requestParameters: ShowTalentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint retrieves details of a specific talent from your account. You can view information such as name, and other relevant attributes of the talent. Translatable fields are returned as per-locale dictionaries (e.g. en-US, pl-PL). * Show Talent */ showTalent(requestParameters: ShowTalentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for talentCandidatesOptions without sending the request */ talentCandidatesOptionsRequestOpts(requestParameters: TalentCandidatesOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Talent Candidates Options */ talentCandidatesOptionsRaw(requestParameters: TalentCandidatesOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Talent Candidates Options */ talentCandidatesOptions(requestParameters: TalentCandidatesOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for talentCandidatesRelationshipsOptions without sending the request */ talentCandidatesRelationshipsOptionsRequestOpts(requestParameters: TalentCandidatesRelationshipsOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Talent Candidates Relationships Options */ talentCandidatesRelationshipsOptionsRaw(requestParameters: TalentCandidatesRelationshipsOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Talent Candidates Relationships Options */ talentCandidatesRelationshipsOptions(requestParameters: TalentCandidatesRelationshipsOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for talentOptions without sending the request */ talentOptionsRequestOpts(requestParameters: TalentOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Talent Options */ talentOptionsRaw(requestParameters: TalentOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Talent Options */ talentOptions(requestParameters: TalentOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for talentsOptions without sending the request */ talentsOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * Talents Options */ talentsOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Talents Options */ talentsOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for updateTalent without sending the request */ updateTalentRequestOpts(requestParameters: UpdateTalentRequest): Promise; /** * This endpoint allows you to update details of a specific talent in your account. You can modify information such as name, and other relevant attributes of the talent. Only the fields provided in the request will be updated. GDPR/RODO consent is written here through consentCurrent / consentFuture - setting consentFuture to false honours a withdrawal and removes the talent from TalentPool search results. * Update Talent */ updateTalentRaw(requestParameters: UpdateTalentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to update details of a specific talent in your account. You can modify information such as name, and other relevant attributes of the talent. Only the fields provided in the request will be updated. GDPR/RODO consent is written here through consentCurrent / consentFuture - setting consentFuture to false honours a withdrawal and removes the talent from TalentPool search results. * Update Talent */ updateTalent(requestParameters: UpdateTalentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const ListTalentsFilterStatusEnum: { readonly Active: "active"; readonly Archived: "archived"; }; export type ListTalentsFilterStatusEnum = typeof ListTalentsFilterStatusEnum[keyof typeof ListTalentsFilterStatusEnum]; /** * @export */ export declare const ShowTalentLanguageEnum: { readonly EnUs: "en-US"; readonly PlPl: "pl-PL"; readonly DeDe: "de-DE"; readonly ItIt: "it-IT"; readonly HeIl: "he-IL"; readonly FrFr: "fr-FR"; readonly CsCz: "cs-CZ"; }; export type ShowTalentLanguageEnum = typeof ShowTalentLanguageEnum[keyof typeof ShowTalentLanguageEnum]; //# sourceMappingURL=TalentsApi.d.ts.map