/** * 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 { CandidateSchema, CandidatesSchema, CreateCandidateRequestBody, JobsSchema, ListCandidateJobsRelationship, ListCandidateTalentsRelationship, TalentsSchema, UpdateCandidateRequestBody } from '../models/index'; export interface CandidateJobsOptionsRequest { candidateId: string; } export interface CandidateJobsRelationshipsOptionsRequest { candidateId: string; } export interface CandidateOptionsRequest { candidateId: string; } export interface CandidateTalentsOptionsRequest { candidateId: string; } export interface CandidateTalentsRelationshipsOptionsRequest { candidateId: string; } export interface CreateCandidateRequest { createCandidateRequestBody: CreateCandidateRequestBody; } export interface DeleteCandidateRequest { candidateId: string; } export interface ListCandidateJobsRequest { candidateId: string; } export interface ListCandidateJobsRelationshipRequest { candidateId: string; } export interface ListCandidateTalentsRequest { candidateId: string; } export interface ListCandidateTalentsRelationshipRequest { candidateId: string; } export interface ListCandidatesRequest { filterStatus?: ListCandidatesFilterStatusEnum; filterShortCode?: string; filterJobId?: string; filterEmail?: string; filterPhone?: string; filterCreatedFrom?: Date; filterCreatedTo?: Date; filterModifiedFrom?: Date; filterModifiedTo?: Date; pageSize?: number; pageNumber?: number; pageAfter?: string; pageBefore?: string; } export interface ShowCandidateRequest { candidateId: string; language?: ShowCandidateLanguageEnum; } export interface UpdateCandidateRequest { candidateId: string; updateCandidateRequestBody: UpdateCandidateRequestBody; } /** * */ export declare class CandidatesApi extends runtime.BaseAPI { /** * Creates request options for candidateJobsOptions without sending the request */ candidateJobsOptionsRequestOpts(requestParameters: CandidateJobsOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Candidate Jobs Options */ candidateJobsOptionsRaw(requestParameters: CandidateJobsOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Candidate Jobs Options */ candidateJobsOptions(requestParameters: CandidateJobsOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for candidateJobsRelationshipsOptions without sending the request */ candidateJobsRelationshipsOptionsRequestOpts(requestParameters: CandidateJobsRelationshipsOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Candidate Jobs Relationships Options */ candidateJobsRelationshipsOptionsRaw(requestParameters: CandidateJobsRelationshipsOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Candidate Jobs Relationships Options */ candidateJobsRelationshipsOptions(requestParameters: CandidateJobsRelationshipsOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for candidateOptions without sending the request */ candidateOptionsRequestOpts(requestParameters: CandidateOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Candidate Options */ candidateOptionsRaw(requestParameters: CandidateOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Candidate Options */ candidateOptions(requestParameters: CandidateOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for candidateTalentsOptions without sending the request */ candidateTalentsOptionsRequestOpts(requestParameters: CandidateTalentsOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Candidate Talents Options */ candidateTalentsOptionsRaw(requestParameters: CandidateTalentsOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Candidate Talents Options */ candidateTalentsOptions(requestParameters: CandidateTalentsOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for candidateTalentsRelationshipsOptions without sending the request */ candidateTalentsRelationshipsOptionsRequestOpts(requestParameters: CandidateTalentsRelationshipsOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Candidate Talents Relationships Options */ candidateTalentsRelationshipsOptionsRaw(requestParameters: CandidateTalentsRelationshipsOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Candidate Talents Relationships Options */ candidateTalentsRelationshipsOptions(requestParameters: CandidateTalentsRelationshipsOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for candidatesOptions without sending the request */ candidatesOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * Candidates Options */ candidatesOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Candidates Options */ candidatesOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for createCandidate without sending the request */ createCandidateRequestOpts(requestParameters: CreateCandidateRequest): Promise; /** * Creates a new candidate in your account. ### Candidate\'s Attributes Here is a table that describes the attributes of the candidate object: | Attribute | Type | Description | |------------------------------|---------|--------------------------------------------------------------------------------| | `name` | string | The full name of the candidate. **Required.** | | `email` | string | Primary email address. **Required.** | | `secondaryEmail` | string | Secondary email address. | | `workEmail` | string | Work email address. | | `phone` | string | Primary phone number. | | `workPhone` | string | Work phone number. | | `status` | string | Status: active, paused, withdrawn, rejected, hired, archived. Deprecated values still accepted: inactive, onHold, offerExtended, offerDeclined, futureConsideration. | | `stage` | string | Pipeline stage: sourcing, screening, assessment, interview, offer, hired, onboarding, evaluation. Deprecated values still accepted: sourced, applied, initial, prescreened, screened, assessed, contacted, interviewed, offered, onboarded, evaluated. | | `age` | string | Candidate age. | | `gender` | string | Candidate gender. | | `source` | string | Where the candidate originated (e.g., careerPage, jobBoard, linkedin, talentPool). | | `channel` | string | How the candidate entered the system: form, email, call, chat, api, agent. | | `shortCode` | string | Short code identifier. | | `languageCode` | string | Preferred language code (e.g., en-US, pl-PL). | | `recommendationStatusCode` | integer | Numeric recommendation status code. | | `overallMatchRating` | integer | Overall match rating (0-5). | | `prevOverallMatchRating` | integer | Previous overall match rating before recalculation. | | `ttl` | string | Time-to-live expiration timestamp. | | `alumni` | object | Alumni/former employee info (isFormerEmployee, previousTenureMonths, wantsToReturn). | | `referral` | object | Referral info (isReferred, referralCode, referrer). | | `jobPositionTitle` | object | Language-keyed job position title (e.g., `{\"en-US\": \"...\"}`). | | `rejectionTicket` | object | Language-keyed rejection ticket text. | | `recommendationStatus` | object | Language-keyed recommendation status. | | `overallAssessment` | object | Language-keyed overall assessment. | | `nextSteps` | object | Language-keyed next steps recommendations. | | `insightsAndAnalysis` | object | Language-keyed insights and analysis. | | `keywords` | object | Language-keyed extracted keywords. | | `skillsAndExpertise` | object | Language-keyed comparison criteria (expected, received, rating, etc.). | | `personalityAndSoftSkills` | object | Language-keyed comparison criteria. | | `experienceAndSeniority` | object | Language-keyed comparison criteria. | | `education` | object | Language-keyed comparison criteria. | | `certifications` | object | Language-keyed comparison criteria. | | `languagesSpoken` | object | Language-keyed comparison criteria. | | `availability` | object | Language-keyed comparison criteria. | | `salaryExpectation` | object | Language-keyed comparison criteria. | | `workPreferences` | object | Language-keyed comparison criteria. | | `locationPreferences` | object | Language-keyed comparison criteria. | | `workAuthorization` | object | Language-keyed comparison criteria. | | `industryExperience` | object | Language-keyed comparison criteria. | | `companyTypeExperience` | object | Language-keyed comparison criteria. | | `jobPositions` | object | Language-keyed comparison criteria. | | `jobTendencies` | object | Language-keyed comparison criteria. | | `licenses` | object | Language-keyed comparison criteria. | | `timestamps.created` | string | When the candidate was created (ISO 8601). | | `timestamps.modified` | string | When the candidate was last modified (ISO 8601). | * Create Candidate */ createCandidateRaw(requestParameters: CreateCandidateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new candidate in your account. ### Candidate\'s Attributes Here is a table that describes the attributes of the candidate object: | Attribute | Type | Description | |------------------------------|---------|--------------------------------------------------------------------------------| | `name` | string | The full name of the candidate. **Required.** | | `email` | string | Primary email address. **Required.** | | `secondaryEmail` | string | Secondary email address. | | `workEmail` | string | Work email address. | | `phone` | string | Primary phone number. | | `workPhone` | string | Work phone number. | | `status` | string | Status: active, paused, withdrawn, rejected, hired, archived. Deprecated values still accepted: inactive, onHold, offerExtended, offerDeclined, futureConsideration. | | `stage` | string | Pipeline stage: sourcing, screening, assessment, interview, offer, hired, onboarding, evaluation. Deprecated values still accepted: sourced, applied, initial, prescreened, screened, assessed, contacted, interviewed, offered, onboarded, evaluated. | | `age` | string | Candidate age. | | `gender` | string | Candidate gender. | | `source` | string | Where the candidate originated (e.g., careerPage, jobBoard, linkedin, talentPool). | | `channel` | string | How the candidate entered the system: form, email, call, chat, api, agent. | | `shortCode` | string | Short code identifier. | | `languageCode` | string | Preferred language code (e.g., en-US, pl-PL). | | `recommendationStatusCode` | integer | Numeric recommendation status code. | | `overallMatchRating` | integer | Overall match rating (0-5). | | `prevOverallMatchRating` | integer | Previous overall match rating before recalculation. | | `ttl` | string | Time-to-live expiration timestamp. | | `alumni` | object | Alumni/former employee info (isFormerEmployee, previousTenureMonths, wantsToReturn). | | `referral` | object | Referral info (isReferred, referralCode, referrer). | | `jobPositionTitle` | object | Language-keyed job position title (e.g., `{\"en-US\": \"...\"}`). | | `rejectionTicket` | object | Language-keyed rejection ticket text. | | `recommendationStatus` | object | Language-keyed recommendation status. | | `overallAssessment` | object | Language-keyed overall assessment. | | `nextSteps` | object | Language-keyed next steps recommendations. | | `insightsAndAnalysis` | object | Language-keyed insights and analysis. | | `keywords` | object | Language-keyed extracted keywords. | | `skillsAndExpertise` | object | Language-keyed comparison criteria (expected, received, rating, etc.). | | `personalityAndSoftSkills` | object | Language-keyed comparison criteria. | | `experienceAndSeniority` | object | Language-keyed comparison criteria. | | `education` | object | Language-keyed comparison criteria. | | `certifications` | object | Language-keyed comparison criteria. | | `languagesSpoken` | object | Language-keyed comparison criteria. | | `availability` | object | Language-keyed comparison criteria. | | `salaryExpectation` | object | Language-keyed comparison criteria. | | `workPreferences` | object | Language-keyed comparison criteria. | | `locationPreferences` | object | Language-keyed comparison criteria. | | `workAuthorization` | object | Language-keyed comparison criteria. | | `industryExperience` | object | Language-keyed comparison criteria. | | `companyTypeExperience` | object | Language-keyed comparison criteria. | | `jobPositions` | object | Language-keyed comparison criteria. | | `jobTendencies` | object | Language-keyed comparison criteria. | | `licenses` | object | Language-keyed comparison criteria. | | `timestamps.created` | string | When the candidate was created (ISO 8601). | | `timestamps.modified` | string | When the candidate was last modified (ISO 8601). | * Create Candidate */ createCandidate(requestParameters: CreateCandidateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteCandidate without sending the request */ deleteCandidateRequestOpts(requestParameters: DeleteCandidateRequest): Promise; /** * This endpoint allows you to delete a specific candidate from your account. Once deleted, the candidate\'s information will be permanently removed and cannot be recovered. * Delete Candidate */ deleteCandidateRaw(requestParameters: DeleteCandidateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to delete a specific candidate from your account. Once deleted, the candidate\'s information will be permanently removed and cannot be recovered. * Delete Candidate */ deleteCandidate(requestParameters: DeleteCandidateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listCandidateJobs without sending the request */ listCandidateJobsRequestOpts(requestParameters: ListCandidateJobsRequest): Promise; /** * Returns a collection of job resources related to the specified candidate. ## JSON:API Relationship Info This endpoint provides the _related_ resources rather than only relationship linkages. * List Candidate Jobs */ listCandidateJobsRaw(requestParameters: ListCandidateJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of job resources related to the specified candidate. ## JSON:API Relationship Info This endpoint provides the _related_ resources rather than only relationship linkages. * List Candidate Jobs */ listCandidateJobs(requestParameters: ListCandidateJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listCandidateJobsRelationship without sending the request */ listCandidateJobsRelationshipRequestOpts(requestParameters: ListCandidateJobsRelationshipRequest): Promise; /** * Returns the relationship object for the jobs associated with this candidate. ## JSON:API Relationship Endpoint This returns only the linkage data (`type` & `id`), plus optional links/meta. * List Candidate Jobs Relationship */ listCandidateJobsRelationshipRaw(requestParameters: ListCandidateJobsRelationshipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns the relationship object for the jobs associated with this candidate. ## JSON:API Relationship Endpoint This returns only the linkage data (`type` & `id`), plus optional links/meta. * List Candidate Jobs Relationship */ listCandidateJobsRelationship(requestParameters: ListCandidateJobsRelationshipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listCandidateTalents without sending the request */ listCandidateTalentsRequestOpts(requestParameters: ListCandidateTalentsRequest): Promise; /** * Returns a collection of talent resources related to the specified candidate. ## JSON:API Relationship Info This endpoint provides the _related_ resources rather than only relationship linkages. * List Candidate Talents */ listCandidateTalentsRaw(requestParameters: ListCandidateTalentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of talent resources related to the specified candidate. ## JSON:API Relationship Info This endpoint provides the _related_ resources rather than only relationship linkages. * List Candidate Talents */ listCandidateTalents(requestParameters: ListCandidateTalentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listCandidateTalentsRelationship without sending the request */ listCandidateTalentsRelationshipRequestOpts(requestParameters: ListCandidateTalentsRelationshipRequest): Promise; /** * Returns the relationship object for the talents associated with this candidate. ## JSON:API Relationship Endpoint This returns only the linkage data (`type` & `id`), plus optional links/meta. * List Candidate Talents Relationship */ listCandidateTalentsRelationshipRaw(requestParameters: ListCandidateTalentsRelationshipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns the relationship object for the talents associated with this candidate. ## JSON:API Relationship Endpoint This returns only the linkage data (`type` & `id`), plus optional links/meta. * List Candidate Talents Relationship */ listCandidateTalentsRelationship(requestParameters: ListCandidateTalentsRelationshipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listCandidates without sending the request */ listCandidatesRequestOpts(requestParameters: ListCandidatesRequest): Promise; /** * Returns a collection of your account candidates ## Overview Returns a collection of your account candidates, sorted by the time they were inserted into the system in ascending order. ### Candidates Endpoints Pagination The candidates 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 Candidates */ listCandidatesRaw(requestParameters: ListCandidatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of your account candidates ## Overview Returns a collection of your account candidates, sorted by the time they were inserted into the system in ascending order. ### Candidates Endpoints Pagination The candidates 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 Candidates */ listCandidates(requestParameters?: ListCandidatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showCandidate without sending the request */ showCandidateRequestOpts(requestParameters: ShowCandidateRequest): Promise; /** * This endpoint retrieves details of a specific candidate from your account. You can view information such as name, and other relevant attributes of the candidate. Translatable fields are returned as per-locale dictionaries (e.g. en-US, pl-PL). * Show Candidate */ showCandidateRaw(requestParameters: ShowCandidateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint retrieves details of a specific candidate from your account. You can view information such as name, and other relevant attributes of the candidate. Translatable fields are returned as per-locale dictionaries (e.g. en-US, pl-PL). * Show Candidate */ showCandidate(requestParameters: ShowCandidateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for updateCandidate without sending the request */ updateCandidateRequestOpts(requestParameters: UpdateCandidateRequest): Promise; /** * This endpoint allows you to update details of a specific candidate in your account. You can modify information such as name, and other relevant attributes of the candidate. Only the fields provided in the request will be updated. * Update Candidate */ updateCandidateRaw(requestParameters: UpdateCandidateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to update details of a specific candidate in your account. You can modify information such as name, and other relevant attributes of the candidate. Only the fields provided in the request will be updated. * Update Candidate */ updateCandidate(requestParameters: UpdateCandidateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const ListCandidatesFilterStatusEnum: { readonly Active: "active"; readonly Archived: "archived"; }; export type ListCandidatesFilterStatusEnum = typeof ListCandidatesFilterStatusEnum[keyof typeof ListCandidatesFilterStatusEnum]; /** * @export */ export declare const ShowCandidateLanguageEnum: { 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 ShowCandidateLanguageEnum = typeof ShowCandidateLanguageEnum[keyof typeof ShowCandidateLanguageEnum]; //# sourceMappingURL=CandidatesApi.d.ts.map