/** * 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, CreateJobRequestBody, JobSchema, JobsSchema, ListJobCandidatesRelationship, UpdateJobRequestBody } from '../models/index'; export interface CreateJobRequest { createJobRequestBody: CreateJobRequestBody; } export interface DeleteJobRequest { jobId: string; } export interface JobCandidatesOptionsRequest { jobId: string; } export interface JobCandidatesRelationshipsOptionsRequest { jobId: string; } export interface JobOptionsRequest { jobId: string; } export interface ListJobCandidatesRequest { jobId: string; } export interface ListJobCandidatesRelationshipRequest { jobId: string; } export interface ListJobsRequest { filterStatus?: ListJobsFilterStatusEnum; filterShortCode?: string; filterCreatedFrom?: Date; filterCreatedTo?: Date; filterModifiedFrom?: Date; filterModifiedTo?: Date; pageSize?: number; pageNumber?: number; pageAfter?: string; pageBefore?: string; } export interface ShowJobRequest { jobId: string; language?: ShowJobLanguageEnum; } export interface UpdateJobRequest { jobId: string; updateJobRequestBody: UpdateJobRequestBody; } /** * */ export declare class JobsApi extends runtime.BaseAPI { /** * Creates request options for createJob without sending the request */ createJobRequestOpts(requestParameters: CreateJobRequest): Promise; /** * Creates a new job in your account. ### Job\'s Attributes Here is a table that describes the attributes of the job object. Fields marked with (T) are translatable - they are stored as language-keyed objects (e.g. `{\"en-US\": ..., \"pl-PL\": ...}`). Supported languages: en-US, pl-PL, de-DE, it-IT, he-IL, fr-FR, cs-CZ. #### Translatable String Fields (T) Language-keyed objects where each language maps to a string value. | Attribute | Type | Description | |-----------|------|-------------| | `title` | object{lang: string} | The title of the job position. **Required.** | | `description` | object{lang: string} | Detailed description of the job role. | | `department` | object{lang: string} | The department where the position is located. | | `specialization` | object{lang: string} | Job specialization area. | #### Translatable Array Fields (T) Language-keyed objects where each language maps to an array of strings. | Attribute | Type | Description | |-----------|------|-------------| | `responsibilities` | object{lang: array[string]} | List of job responsibilities and duties. | | `keywords` | object{lang: array[string]} | Relevant keywords for the position. | | `benefits` | object{lang: array[string]} | List of job benefits. | #### Translatable Criteria Fields (T) Language-keyed objects where each language maps to a criteria object with `name`, `description`, `priority`, `priorityConfidence`, `priorityReasoning`, `comparisonRule`, and `expected` (array of objects or null). | Attribute | Type | Description | |-----------|------|-------------| | `availability` | object{lang: criteria} | Availability requirements. | | `skillsAndExpertise` | object{lang: criteria} | Technical skills and domain expertise. | | `languagesSpoken` | object{lang: criteria} | Language proficiency requirements. | | `workPreferences` | object{lang: criteria} | Work style and schedule preferences. | | `locationPreferences` | object{lang: criteria} | Geographic location requirements. | | `industryExperience` | object{lang: criteria} | Industry sector experience requirements. | | `companyTypeExperience` | object{lang: criteria} | Company type experience requirements. | | `jobPositions` | object{lang: criteria} | Required previous job positions. | | `jobTendencies` | object{lang: criteria} | Career pattern requirements. | | `workAuthorization` | object{lang: criteria} | Work authorization requirements. | | `certifications` | object{lang: criteria} | Professional certifications requirements. | | `licenses` | object{lang: criteria} | Professional licenses requirements. | | `personalityAndSoftSkills` | object{lang: criteria} | Soft skills and personality traits. | | `education` | object{lang: criteria} | Education requirements. | | `experienceAndSeniority` | object{lang: criteria} | Experience and seniority requirements. | | `salaryExpectation` | object{lang: criteria} | Salary and compensation criteria. | #### Translatable Location/Site Fields (T) | Attribute | Type | Description | |-----------|------|-------------| | `locations` | object{lang: array[object]} | Office locations (city, country, region). | | `sites` | object{lang: array[object]} | Work site types (siteId, siteName, siteType). | #### Non-Translatable Fields | Attribute | Type | Description | |-----------|------|-------------| | `companyCulture` | string | Description of the company\'s culture and values. | | `seniority` | string | Seniority level (e.g. junior, mid, senior). | | `shortCode` | string | Unique short identifier for the job. | | `source` | string | Source of the job posting. | | `languageCode` | string | Primary language code for the job posting. | | `status` | string | Current status (active, inactive, draft, pending, archived, failed). | | `organization` | object | Organization details (name, address). | | `settings` | object | Job posting settings. | | `settings.conversation` | object | Conversation settings (email, candidateInterview, personaInterview, tone). | | `settings.criterias` | object | Criteria matching weights and thresholds. | | `settings.operation` | object | Operation automation flags. | | `settings.persona` | object | Persona matching weight. | | `settings.ratingRestrictiveness` | string | Rating restrictiveness level. | | `timestamps.created` | string | Creation date (ISO 8601 format). | | `timestamps.modified` | string | Last modification date (ISO 8601 format). | * Create Job */ createJobRaw(requestParameters: CreateJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new job in your account. ### Job\'s Attributes Here is a table that describes the attributes of the job object. Fields marked with (T) are translatable - they are stored as language-keyed objects (e.g. `{\"en-US\": ..., \"pl-PL\": ...}`). Supported languages: en-US, pl-PL, de-DE, it-IT, he-IL, fr-FR, cs-CZ. #### Translatable String Fields (T) Language-keyed objects where each language maps to a string value. | Attribute | Type | Description | |-----------|------|-------------| | `title` | object{lang: string} | The title of the job position. **Required.** | | `description` | object{lang: string} | Detailed description of the job role. | | `department` | object{lang: string} | The department where the position is located. | | `specialization` | object{lang: string} | Job specialization area. | #### Translatable Array Fields (T) Language-keyed objects where each language maps to an array of strings. | Attribute | Type | Description | |-----------|------|-------------| | `responsibilities` | object{lang: array[string]} | List of job responsibilities and duties. | | `keywords` | object{lang: array[string]} | Relevant keywords for the position. | | `benefits` | object{lang: array[string]} | List of job benefits. | #### Translatable Criteria Fields (T) Language-keyed objects where each language maps to a criteria object with `name`, `description`, `priority`, `priorityConfidence`, `priorityReasoning`, `comparisonRule`, and `expected` (array of objects or null). | Attribute | Type | Description | |-----------|------|-------------| | `availability` | object{lang: criteria} | Availability requirements. | | `skillsAndExpertise` | object{lang: criteria} | Technical skills and domain expertise. | | `languagesSpoken` | object{lang: criteria} | Language proficiency requirements. | | `workPreferences` | object{lang: criteria} | Work style and schedule preferences. | | `locationPreferences` | object{lang: criteria} | Geographic location requirements. | | `industryExperience` | object{lang: criteria} | Industry sector experience requirements. | | `companyTypeExperience` | object{lang: criteria} | Company type experience requirements. | | `jobPositions` | object{lang: criteria} | Required previous job positions. | | `jobTendencies` | object{lang: criteria} | Career pattern requirements. | | `workAuthorization` | object{lang: criteria} | Work authorization requirements. | | `certifications` | object{lang: criteria} | Professional certifications requirements. | | `licenses` | object{lang: criteria} | Professional licenses requirements. | | `personalityAndSoftSkills` | object{lang: criteria} | Soft skills and personality traits. | | `education` | object{lang: criteria} | Education requirements. | | `experienceAndSeniority` | object{lang: criteria} | Experience and seniority requirements. | | `salaryExpectation` | object{lang: criteria} | Salary and compensation criteria. | #### Translatable Location/Site Fields (T) | Attribute | Type | Description | |-----------|------|-------------| | `locations` | object{lang: array[object]} | Office locations (city, country, region). | | `sites` | object{lang: array[object]} | Work site types (siteId, siteName, siteType). | #### Non-Translatable Fields | Attribute | Type | Description | |-----------|------|-------------| | `companyCulture` | string | Description of the company\'s culture and values. | | `seniority` | string | Seniority level (e.g. junior, mid, senior). | | `shortCode` | string | Unique short identifier for the job. | | `source` | string | Source of the job posting. | | `languageCode` | string | Primary language code for the job posting. | | `status` | string | Current status (active, inactive, draft, pending, archived, failed). | | `organization` | object | Organization details (name, address). | | `settings` | object | Job posting settings. | | `settings.conversation` | object | Conversation settings (email, candidateInterview, personaInterview, tone). | | `settings.criterias` | object | Criteria matching weights and thresholds. | | `settings.operation` | object | Operation automation flags. | | `settings.persona` | object | Persona matching weight. | | `settings.ratingRestrictiveness` | string | Rating restrictiveness level. | | `timestamps.created` | string | Creation date (ISO 8601 format). | | `timestamps.modified` | string | Last modification date (ISO 8601 format). | * Create Job */ createJob(requestParameters: CreateJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteJob without sending the request */ deleteJobRequestOpts(requestParameters: DeleteJobRequest): Promise; /** * This endpoint allows you to delete a specific job from your account. Once deleted, the job\'s information will be permanently removed and cannot be recovered. * Delete Job */ deleteJobRaw(requestParameters: DeleteJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to delete a specific job from your account. Once deleted, the job\'s information will be permanently removed and cannot be recovered. * Delete Job */ deleteJob(requestParameters: DeleteJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for jobCandidatesOptions without sending the request */ jobCandidatesOptionsRequestOpts(requestParameters: JobCandidatesOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Job Candidates Options */ jobCandidatesOptionsRaw(requestParameters: JobCandidatesOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Job Candidates Options */ jobCandidatesOptions(requestParameters: JobCandidatesOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for jobCandidatesRelationshipsOptions without sending the request */ jobCandidatesRelationshipsOptionsRequestOpts(requestParameters: JobCandidatesRelationshipsOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Job Candidates Relationships Options */ jobCandidatesRelationshipsOptionsRaw(requestParameters: JobCandidatesRelationshipsOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Job Candidates Relationships Options */ jobCandidatesRelationshipsOptions(requestParameters: JobCandidatesRelationshipsOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for jobOptions without sending the request */ jobOptionsRequestOpts(requestParameters: JobOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Job Options */ jobOptionsRaw(requestParameters: JobOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Job Options */ jobOptions(requestParameters: JobOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for jobsOptions without sending the request */ jobsOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * Jobs Options */ jobsOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Jobs Options */ jobsOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listJobCandidates without sending the request */ listJobCandidatesRequestOpts(requestParameters: ListJobCandidatesRequest): Promise; /** * Returns a collection of candidate resources related to the specified job. ## JSON:API Relationship Info This endpoint provides the _related_ resources rather than only relationship linkages. * List Job Candidates */ listJobCandidatesRaw(requestParameters: ListJobCandidatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of candidate resources related to the specified job. ## JSON:API Relationship Info This endpoint provides the _related_ resources rather than only relationship linkages. * List Job Candidates */ listJobCandidates(requestParameters: ListJobCandidatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listJobCandidatesRelationship without sending the request */ listJobCandidatesRelationshipRequestOpts(requestParameters: ListJobCandidatesRelationshipRequest): Promise; /** * Returns the relationship object for the candidates associated with this job. ## JSON:API Relationship Endpoint This returns only the linkage data (`type` & `id`), plus optional links/meta. * List Job Candidates Relationship */ listJobCandidatesRelationshipRaw(requestParameters: ListJobCandidatesRelationshipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns the relationship object for the candidates associated with this job. ## JSON:API Relationship Endpoint This returns only the linkage data (`type` & `id`), plus optional links/meta. * List Job Candidates Relationship */ listJobCandidatesRelationship(requestParameters: ListJobCandidatesRelationshipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listJobs without sending the request */ listJobsRequestOpts(requestParameters: ListJobsRequest): Promise; /** * Returns a collection of your account jobs ## Overview Returns a collection of your account jobs, sorted by the time they were inserted into the system in ascending order. ### Jobs Endpoints Pagination The jobs 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 Jobs */ listJobsRaw(requestParameters: ListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of your account jobs ## Overview Returns a collection of your account jobs, sorted by the time they were inserted into the system in ascending order. ### Jobs Endpoints Pagination The jobs 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 Jobs */ listJobs(requestParameters?: ListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showJob without sending the request */ showJobRequestOpts(requestParameters: ShowJobRequest): Promise; /** * This endpoint retrieves details of a specific job from your account. You can view information such as name, and other relevant attributes of the job. Translatable fields are returned as per-locale dictionaries (e.g. en-US, pl-PL). * Show Job */ showJobRaw(requestParameters: ShowJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint retrieves details of a specific job from your account. You can view information such as name, and other relevant attributes of the job. Translatable fields are returned as per-locale dictionaries (e.g. en-US, pl-PL). * Show Job */ showJob(requestParameters: ShowJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for updateJob without sending the request */ updateJobRequestOpts(requestParameters: UpdateJobRequest): Promise; /** * This endpoint allows you to update details of a specific job in your account. You can modify information such as name, and other relevant attributes of the job. Only the fields provided in the request will be updated. `settings` is merged one level deep with the stored settings (parity with the tenant PATCH): send only the top-level keys you change; a top-level key sent as null is stored as null and reads as absent; nested keys inside a sent top-level object replace that object wholesale. * Update Job */ updateJobRaw(requestParameters: UpdateJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to update details of a specific job in your account. You can modify information such as name, and other relevant attributes of the job. Only the fields provided in the request will be updated. `settings` is merged one level deep with the stored settings (parity with the tenant PATCH): send only the top-level keys you change; a top-level key sent as null is stored as null and reads as absent; nested keys inside a sent top-level object replace that object wholesale. * Update Job */ updateJob(requestParameters: UpdateJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const ListJobsFilterStatusEnum: { readonly Active: "active"; readonly Archived: "archived"; }; export type ListJobsFilterStatusEnum = typeof ListJobsFilterStatusEnum[keyof typeof ListJobsFilterStatusEnum]; /** * @export */ export declare const ShowJobLanguageEnum: { 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 ShowJobLanguageEnum = typeof ShowJobLanguageEnum[keyof typeof ShowJobLanguageEnum]; //# sourceMappingURL=JobsApi.d.ts.map