/** * 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 { ConversationSchema, ConversationsSchema, CreateConversationRequestBody, UpdateConversationRequestBody } from '../models/index'; export interface ConversationOptionsRequest { conversationId: string; } export interface CreateConversationRequest { createConversationRequestBody: CreateConversationRequestBody; } export interface DeleteConversationRequest { conversationId: string; } export interface ListConversationsRequest { filterStatus?: ListConversationsFilterStatusEnum; filterTalentId?: string; filterCandidateId?: string; filterJobId?: string; filterCreatedFrom?: Date; filterCreatedTo?: Date; filterModifiedFrom?: Date; filterModifiedTo?: Date; pageSize?: number; pageNumber?: number; pageAfter?: string; pageBefore?: string; } export interface ShowConversationRequest { conversationId: string; } export interface UpdateConversationRequest { conversationId: string; updateConversationRequestBody: UpdateConversationRequestBody; } /** * */ export declare class ConversationsApi extends runtime.BaseAPI { /** * Creates request options for conversationOptions without sending the request */ conversationOptionsRequestOpts(requestParameters: ConversationOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Conversation Options */ conversationOptionsRaw(requestParameters: ConversationOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Conversation Options */ conversationOptions(requestParameters: ConversationOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for conversationsOptions without sending the request */ conversationsOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * Conversations Options */ conversationsOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Conversations Options */ conversationsOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for createConversation without sending the request */ createConversationRequestOpts(requestParameters: CreateConversationRequest): Promise; /** * Creates a new conversation in your account. ### Conversation\'s Attributes Here is a table that describes the attributes of the conversation object: | Attribute | Type | Description | |----------------------------|---------|-----------------------------------------------------------------------------| | `name` | string | The full name of the conversation. | | `type` | string | Conversation type (e.g., candidates, jobs, talents, personas). | | `status` | string | The current status of the conversation (e.g., active, inactive, pending). | | `summary` | object | Multilingual summary keyed by language code. | | `source` | string | Source of the conversation. | | `languageCode` | string | Preferred language code (e.g., en-US, pl-PL). | | `isConversationEnd` | boolean | Whether the conversation has ended. | | `settings` | object | Conversation settings inherited from job. | | `ttl` | string | Time-to-live expiration timestamp. | | `timestamps.created` | string | The date and time when the conversation was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the conversation was last modified (ISO 8601 format).| * Create Conversation */ createConversationRaw(requestParameters: CreateConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new conversation in your account. ### Conversation\'s Attributes Here is a table that describes the attributes of the conversation object: | Attribute | Type | Description | |----------------------------|---------|-----------------------------------------------------------------------------| | `name` | string | The full name of the conversation. | | `type` | string | Conversation type (e.g., candidates, jobs, talents, personas). | | `status` | string | The current status of the conversation (e.g., active, inactive, pending). | | `summary` | object | Multilingual summary keyed by language code. | | `source` | string | Source of the conversation. | | `languageCode` | string | Preferred language code (e.g., en-US, pl-PL). | | `isConversationEnd` | boolean | Whether the conversation has ended. | | `settings` | object | Conversation settings inherited from job. | | `ttl` | string | Time-to-live expiration timestamp. | | `timestamps.created` | string | The date and time when the conversation was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the conversation was last modified (ISO 8601 format).| * Create Conversation */ createConversation(requestParameters: CreateConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteConversation without sending the request */ deleteConversationRequestOpts(requestParameters: DeleteConversationRequest): Promise; /** * This endpoint allows you to delete a specific conversation from your account. Once deleted, the conversation\'s information will be permanently removed and cannot be recovered. * Delete Conversation */ deleteConversationRaw(requestParameters: DeleteConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to delete a specific conversation from your account. Once deleted, the conversation\'s information will be permanently removed and cannot be recovered. * Delete Conversation */ deleteConversation(requestParameters: DeleteConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listConversations without sending the request */ listConversationsRequestOpts(requestParameters: ListConversationsRequest): Promise; /** * Returns a collection of your account conversations ## Overview Returns a collection of your account conversations, sorted by the time they were inserted into the system in ascending order. ### Conversations Endpoints Pagination The conversations 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 Conversations */ listConversationsRaw(requestParameters: ListConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of your account conversations ## Overview Returns a collection of your account conversations, sorted by the time they were inserted into the system in ascending order. ### Conversations Endpoints Pagination The conversations 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 Conversations */ listConversations(requestParameters?: ListConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showConversation without sending the request */ showConversationRequestOpts(requestParameters: ShowConversationRequest): Promise; /** * This endpoint retrieves details of a specific conversation from your account. You can view information such as name, and other relevant attributes of the conversation. * Show Conversation */ showConversationRaw(requestParameters: ShowConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint retrieves details of a specific conversation from your account. You can view information such as name, and other relevant attributes of the conversation. * Show Conversation */ showConversation(requestParameters: ShowConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for updateConversation without sending the request */ updateConversationRequestOpts(requestParameters: UpdateConversationRequest): Promise; /** * This endpoint allows you to update details of a specific conversation in your account. You can modify information such as name, and other relevant attributes of the conversation. Only the fields provided in the request will be updated. * Update Conversation */ updateConversationRaw(requestParameters: UpdateConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to update details of a specific conversation in your account. You can modify information such as name, and other relevant attributes of the conversation. Only the fields provided in the request will be updated. * Update Conversation */ updateConversation(requestParameters: UpdateConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const ListConversationsFilterStatusEnum: { readonly Active: "active"; readonly Archived: "archived"; }; export type ListConversationsFilterStatusEnum = typeof ListConversationsFilterStatusEnum[keyof typeof ListConversationsFilterStatusEnum]; //# sourceMappingURL=ConversationsApi.d.ts.map