getricky 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4,15 +4,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.idempotentOperations = void 0;
5
5
  /** `METHOD /path/{template}` of every write that accepts an `Idempotency-Key` header. */
6
6
  exports.idempotentOperations = new Set([
7
+ 'PATCH /agents/{agent_id}',
7
8
  'PATCH /contacts/{contact_id}',
9
+ 'PATCH /conversations/{conversation_id}/agent',
8
10
  'PATCH /conversations/{conversation_id}/assignment',
11
+ 'PATCH /knowledge/contacts/{knowledge_contact_id}',
12
+ 'PATCH /knowledge/files/{file_id}',
13
+ 'PATCH /knowledge/locations/{location_id}',
9
14
  'PATCH /workflows/{workflow_id}',
15
+ 'POST /agents',
10
16
  'POST /contacts',
11
17
  'POST /contacts/{contact_id}/notes',
12
18
  'POST /conversations',
13
19
  'POST /conversations/{conversation_id}/close',
14
20
  'POST /conversations/{conversation_id}/messages',
15
21
  'POST /conversations/{conversation_id}/reopen',
22
+ 'POST /knowledge/contacts',
23
+ 'POST /knowledge/files',
24
+ 'POST /knowledge/files/{file_id}/complete',
25
+ 'POST /knowledge/locations',
16
26
  'POST /tags',
17
27
  'POST /workflows',
18
28
  ]);
@@ -1,2 +1,2 @@
1
1
  export { type Options, RickyApi } from './sdk.gen.js';
2
- export type { ActivateWorkflowData, ActivateWorkflowError, ActivateWorkflowErrors, ActivateWorkflowResponse, ActivateWorkflowResponses, AddContactNote, AddContactNoteData, AddContactNoteError, AddContactNoteErrors, AddContactNoteResponse, AddContactNoteResponses, AdsReport, AssignConversation, AssignConversationData, AssignConversationError, AssignConversationErrors, AssignConversationResponse, AssignConversationResponses, BroadcastsReport, Channel, ClientOptions, CloseConversation, CloseConversationData, CloseConversationError, CloseConversationErrors, CloseConversationResponse, CloseConversationResponses, Contact, ContactField, ContactIdentity, Conversation, ConversationsReport, CreateContact, CreateContactData, CreateContactError, CreateContactErrors, CreateContactResponse, CreateContactResponses, CreatedWebhook, CreateTag, CreateTagData, CreateTagError, CreateTagErrors, CreateTagResponse, CreateTagResponses, CreateWebhook, CreateWebhookData, CreateWebhookError, CreateWebhookErrors, CreateWebhookResponse, CreateWebhookResponses, CreateWorkflow, CreateWorkflowData, CreateWorkflowError, CreateWorkflowErrors, CreateWorkflowResponse, CreateWorkflowResponses, DashboardReport, DeleteWorkflowData, DeleteWorkflowError, DeleteWorkflowErrors, DeleteWorkflowResponse, DeleteWorkflowResponses, DisableWebhookData, DisableWebhookError, DisableWebhookErrors, DisableWebhookResponse, DisableWebhookResponses, Error, GetAdsReportData, GetAdsReportError, GetAdsReportErrors, GetAdsReportResponse, GetAdsReportResponses, GetBroadcastsReportData, GetBroadcastsReportError, GetBroadcastsReportErrors, GetBroadcastsReportResponse, GetBroadcastsReportResponses, GetContactData, GetContactError, GetContactErrors, GetContactResponse, GetContactResponses, GetConversationData, GetConversationError, GetConversationErrors, GetConversationResponse, GetConversationResponses, GetConversationsReportData, GetConversationsReportError, GetConversationsReportErrors, GetConversationsReportResponse, GetConversationsReportResponses, GetDashboardReportData, GetDashboardReportError, GetDashboardReportErrors, GetDashboardReportResponse, GetDashboardReportResponses, GetMessageData, GetMessageError, GetMessageErrors, GetMessageResponse, GetMessageResponses, GetMessagesReportData, GetMessagesReportError, GetMessagesReportErrors, GetMessagesReportResponse, GetMessagesReportResponses, GetResolutionsReportData, GetResolutionsReportError, GetResolutionsReportErrors, GetResolutionsReportResponse, GetResolutionsReportResponses, GetResponsesReportData, GetResponsesReportError, GetResponsesReportErrors, GetResponsesReportResponse, GetResponsesReportResponses, GetSendData, GetSendError, GetSendErrors, GetSendResponse, GetSendResponses, GetTeamReportData, GetTeamReportError, GetTeamReportErrors, GetTeamReportResponse, GetTeamReportResponses, GetWorkflowData, GetWorkflowError, GetWorkflowErrors, GetWorkflowResponse, GetWorkflowResponses, IdempotencyKey, ListChannelsData, ListChannelsError, ListChannelsErrors, ListChannelsResponse, ListChannelsResponses, ListContactFieldsData, ListContactFieldsError, ListContactFieldsErrors, ListContactFieldsResponse, ListContactFieldsResponses, ListContactsData, ListContactsError, ListContactsErrors, ListContactsResponse, ListContactsResponses, ListConversationsData, ListConversationsError, ListConversationsErrors, ListConversationsResponse, ListConversationsResponses, ListMembersData, ListMembersError, ListMembersErrors, ListMembersResponse, ListMembersResponses, ListMessagesData, ListMessagesError, ListMessagesErrors, ListMessagesResponse, ListMessagesResponses, ListTagsData, ListTagsError, ListTagsErrors, ListTagsResponse, ListTagsResponses, ListTemplatesData, ListTemplatesError, ListTemplatesErrors, ListTemplatesResponse, ListTemplatesResponses, ListWebhookDeliveriesData, ListWebhookDeliveriesError, ListWebhookDeliveriesErrors, ListWebhookDeliveriesResponse, ListWebhookDeliveriesResponses, ListWebhooksData, ListWebhooksError, ListWebhooksErrors, ListWebhooksResponse, ListWebhooksResponses, ListWorkflowExecutionsData, ListWorkflowExecutionsError, ListWorkflowExecutionsErrors, ListWorkflowExecutionsResponse, ListWorkflowExecutionsResponses, ListWorkflowsData, ListWorkflowsError, ListWorkflowsErrors, ListWorkflowsResponse, ListWorkflowsResponses, MediaMessage, Member, Message, MessagesReport, PauseWorkflowData, PauseWorkflowError, PauseWorkflowErrors, PauseWorkflowResponse, PauseWorkflowResponses, ReopenConversationData, ReopenConversationError, ReopenConversationErrors, ReopenConversationResponse, ReopenConversationResponses, ReportPeriod, ResolutionsReport, ResponsesReport, RetryWebhookDeliveryData, RetryWebhookDeliveryError, RetryWebhookDeliveryErrors, RetryWebhookDeliveryResponse, RetryWebhookDeliveryResponses, RotateWebhookSecret, RotateWebhookSecretData, RotateWebhookSecretError, RotateWebhookSecretErrors, RotateWebhookSecretResponse, RotateWebhookSecretResponses, Send, SendMessage, SendMessageData, SendMessageError, SendMessageErrors, SendMessageResponse, SendMessageResponses, StartConversation, StartConversationData, StartConversationError, StartConversationErrors, StartConversationResponse, StartConversationResponses, Tag, TeamReport, Template, TemplateMessage, TestWebhookData, TestWebhookError, TestWebhookErrors, TestWebhookResponse, TestWebhookResponses, UpdateContact, UpdateContactData, UpdateContactError, UpdateContactErrors, UpdateContactResponse, UpdateContactResponses, UpdateWorkflow, UpdateWorkflowData, UpdateWorkflowError, UpdateWorkflowErrors, UpdateWorkflowResponse, UpdateWorkflowResponses, Webhook, WebhookContactCreatedWebhookPayload, WebhookContactCreatedWebhookRequest, WebhookContactUpdatedWebhookPayload, WebhookContactUpdatedWebhookRequest, WebhookConversationAssignmentChangedWebhookPayload, WebhookConversationAssignmentChangedWebhookRequest, WebhookConversationClosedWebhookPayload, WebhookConversationClosedWebhookRequest, WebhookConversationOpenedWebhookPayload, WebhookConversationOpenedWebhookRequest, WebhookDelivery, WebhookEvent, WebhookMessageDeliveredWebhookPayload, WebhookMessageDeliveredWebhookRequest, WebhookMessageFailedWebhookPayload, WebhookMessageFailedWebhookRequest, WebhookMessageReadWebhookPayload, WebhookMessageReadWebhookRequest, WebhookMessageReceivedWebhookPayload, WebhookMessageReceivedWebhookRequest, WebhookMessageSentWebhookPayload, WebhookMessageSentWebhookRequest, Webhooks, WebhookTestResult, WebhookWebhookTestWebhookPayload, WebhookWebhookTestWebhookRequest, Workflow, WorkflowExecution } from './types.gen.js';
2
+ export type { ActivateWorkflowData, ActivateWorkflowError, ActivateWorkflowErrors, ActivateWorkflowResponse, ActivateWorkflowResponses, AddContactNote, AddContactNoteData, AddContactNoteError, AddContactNoteErrors, AddContactNoteResponse, AddContactNoteResponses, AdsReport, Agent, AgentOptions, ArchiveAgentData, ArchiveAgentError, ArchiveAgentErrors, ArchiveAgentResponse, ArchiveAgentResponses, AssignConversation, AssignConversationAgent, AssignConversationAgentData, AssignConversationAgentError, AssignConversationAgentErrors, AssignConversationAgentResponse, AssignConversationAgentResponses, AssignConversationData, AssignConversationError, AssignConversationErrors, AssignConversationResponse, AssignConversationResponses, BroadcastsReport, Channel, ClientOptions, CloseConversation, CloseConversationData, CloseConversationError, CloseConversationErrors, CloseConversationResponse, CloseConversationResponses, CompleteKnowledgeFile, CompleteKnowledgeFileData, CompleteKnowledgeFileError, CompleteKnowledgeFileErrors, CompleteKnowledgeFileResponse, CompleteKnowledgeFileResponses, Contact, ContactField, ContactIdentity, Conversation, ConversationsReport, CreateAgent, CreateAgentData, CreateAgentError, CreateAgentErrors, CreateAgentResponse, CreateAgentResponses, CreateContact, CreateContactData, CreateContactError, CreateContactErrors, CreateContactResponse, CreateContactResponses, CreatedWebhook, CreateKnowledgeContact, CreateKnowledgeContactData, CreateKnowledgeContactError, CreateKnowledgeContactErrors, CreateKnowledgeContactResponse, CreateKnowledgeContactResponses, CreateKnowledgeFile, CreateKnowledgeFileData, CreateKnowledgeFileError, CreateKnowledgeFileErrors, CreateKnowledgeFileResponse, CreateKnowledgeFileResponses, CreateKnowledgeLocation, CreateKnowledgeLocationData, CreateKnowledgeLocationError, CreateKnowledgeLocationErrors, CreateKnowledgeLocationResponse, CreateKnowledgeLocationResponses, CreateTag, CreateTagData, CreateTagError, CreateTagErrors, CreateTagResponse, CreateTagResponses, CreateWebhook, CreateWebhookData, CreateWebhookError, CreateWebhookErrors, CreateWebhookResponse, CreateWebhookResponses, CreateWorkflow, CreateWorkflowData, CreateWorkflowError, CreateWorkflowErrors, CreateWorkflowResponse, CreateWorkflowResponses, DashboardReport, DeleteKnowledgeContactData, DeleteKnowledgeContactError, DeleteKnowledgeContactErrors, DeleteKnowledgeContactResponse, DeleteKnowledgeContactResponses, DeleteKnowledgeFileData, DeleteKnowledgeFileError, DeleteKnowledgeFileErrors, DeleteKnowledgeFileResponse, DeleteKnowledgeFileResponses, DeleteKnowledgeLocationData, DeleteKnowledgeLocationError, DeleteKnowledgeLocationErrors, DeleteKnowledgeLocationResponse, DeleteKnowledgeLocationResponses, DeleteWorkflowData, DeleteWorkflowError, DeleteWorkflowErrors, DeleteWorkflowResponse, DeleteWorkflowResponses, DisableWebhookData, DisableWebhookError, DisableWebhookErrors, DisableWebhookResponse, DisableWebhookResponses, Error, GetAdsReportData, GetAdsReportError, GetAdsReportErrors, GetAdsReportResponse, GetAdsReportResponses, GetAgentData, GetAgentError, GetAgentErrors, GetAgentOptionsData, GetAgentOptionsError, GetAgentOptionsErrors, GetAgentOptionsResponse, GetAgentOptionsResponses, GetAgentResponse, GetAgentResponses, GetBroadcastsReportData, GetBroadcastsReportError, GetBroadcastsReportErrors, GetBroadcastsReportResponse, GetBroadcastsReportResponses, GetContactData, GetContactError, GetContactErrors, GetContactResponse, GetContactResponses, GetConversationData, GetConversationError, GetConversationErrors, GetConversationResponse, GetConversationResponses, GetConversationsReportData, GetConversationsReportError, GetConversationsReportErrors, GetConversationsReportResponse, GetConversationsReportResponses, GetDashboardReportData, GetDashboardReportError, GetDashboardReportErrors, GetDashboardReportResponse, GetDashboardReportResponses, GetKnowledgeContactData, GetKnowledgeContactError, GetKnowledgeContactErrors, GetKnowledgeContactResponse, GetKnowledgeContactResponses, GetKnowledgeFileData, GetKnowledgeFileError, GetKnowledgeFileErrors, GetKnowledgeFileResponse, GetKnowledgeFileResponses, GetKnowledgeLocationData, GetKnowledgeLocationError, GetKnowledgeLocationErrors, GetKnowledgeLocationResponse, GetKnowledgeLocationResponses, GetMessageData, GetMessageError, GetMessageErrors, GetMessageResponse, GetMessageResponses, GetMessagesReportData, GetMessagesReportError, GetMessagesReportErrors, GetMessagesReportResponse, GetMessagesReportResponses, GetResolutionsReportData, GetResolutionsReportError, GetResolutionsReportErrors, GetResolutionsReportResponse, GetResolutionsReportResponses, GetResponsesReportData, GetResponsesReportError, GetResponsesReportErrors, GetResponsesReportResponse, GetResponsesReportResponses, GetSendData, GetSendError, GetSendErrors, GetSendResponse, GetSendResponses, GetTeamReportData, GetTeamReportError, GetTeamReportErrors, GetTeamReportResponse, GetTeamReportResponses, GetWorkflowData, GetWorkflowError, GetWorkflowErrors, GetWorkflowResponse, GetWorkflowResponses, IdempotencyKey, KnowledgeContact, KnowledgeFile, KnowledgeFileUpload, KnowledgeLocation, ListAgentsData, ListAgentsError, ListAgentsErrors, ListAgentsResponse, ListAgentsResponses, ListChannelsData, ListChannelsError, ListChannelsErrors, ListChannelsResponse, ListChannelsResponses, ListContactFieldsData, ListContactFieldsError, ListContactFieldsErrors, ListContactFieldsResponse, ListContactFieldsResponses, ListContactsData, ListContactsError, ListContactsErrors, ListContactsResponse, ListContactsResponses, ListConversationsData, ListConversationsError, ListConversationsErrors, ListConversationsResponse, ListConversationsResponses, ListKnowledgeContactsData, ListKnowledgeContactsError, ListKnowledgeContactsErrors, ListKnowledgeContactsResponse, ListKnowledgeContactsResponses, ListKnowledgeFilesData, ListKnowledgeFilesError, ListKnowledgeFilesErrors, ListKnowledgeFilesResponse, ListKnowledgeFilesResponses, ListKnowledgeLocationsData, ListKnowledgeLocationsError, ListKnowledgeLocationsErrors, ListKnowledgeLocationsResponse, ListKnowledgeLocationsResponses, ListMembersData, ListMembersError, ListMembersErrors, ListMembersResponse, ListMembersResponses, ListMessagesData, ListMessagesError, ListMessagesErrors, ListMessagesResponse, ListMessagesResponses, ListTagsData, ListTagsError, ListTagsErrors, ListTagsResponse, ListTagsResponses, ListTemplatesData, ListTemplatesError, ListTemplatesErrors, ListTemplatesResponse, ListTemplatesResponses, ListWebhookDeliveriesData, ListWebhookDeliveriesError, ListWebhookDeliveriesErrors, ListWebhookDeliveriesResponse, ListWebhookDeliveriesResponses, ListWebhooksData, ListWebhooksError, ListWebhooksErrors, ListWebhooksResponse, ListWebhooksResponses, ListWorkflowExecutionsData, ListWorkflowExecutionsError, ListWorkflowExecutionsErrors, ListWorkflowExecutionsResponse, ListWorkflowExecutionsResponses, ListWorkflowsData, ListWorkflowsError, ListWorkflowsErrors, ListWorkflowsResponse, ListWorkflowsResponses, MediaMessage, Member, Message, MessagesReport, PauseWorkflowData, PauseWorkflowError, PauseWorkflowErrors, PauseWorkflowResponse, PauseWorkflowResponses, ReopenConversationData, ReopenConversationError, ReopenConversationErrors, ReopenConversationResponse, ReopenConversationResponses, ReportPeriod, ResolutionsReport, ResponsesReport, RetryWebhookDeliveryData, RetryWebhookDeliveryError, RetryWebhookDeliveryErrors, RetryWebhookDeliveryResponse, RetryWebhookDeliveryResponses, RotateWebhookSecret, RotateWebhookSecretData, RotateWebhookSecretError, RotateWebhookSecretErrors, RotateWebhookSecretResponse, RotateWebhookSecretResponses, Send, SendMessage, SendMessageData, SendMessageError, SendMessageErrors, SendMessageResponse, SendMessageResponses, StartConversation, StartConversationData, StartConversationError, StartConversationErrors, StartConversationResponse, StartConversationResponses, Tag, TeamReport, Template, TemplateMessage, TestWebhookData, TestWebhookError, TestWebhookErrors, TestWebhookResponse, TestWebhookResponses, UpdateAgent, UpdateAgentData, UpdateAgentError, UpdateAgentErrors, UpdateAgentResponse, UpdateAgentResponses, UpdateContact, UpdateContactData, UpdateContactError, UpdateContactErrors, UpdateContactResponse, UpdateContactResponses, UpdateKnowledgeContact, UpdateKnowledgeContactData, UpdateKnowledgeContactError, UpdateKnowledgeContactErrors, UpdateKnowledgeContactResponse, UpdateKnowledgeContactResponses, UpdateKnowledgeFile, UpdateKnowledgeFileData, UpdateKnowledgeFileError, UpdateKnowledgeFileErrors, UpdateKnowledgeFileResponse, UpdateKnowledgeFileResponses, UpdateKnowledgeLocation, UpdateKnowledgeLocationData, UpdateKnowledgeLocationError, UpdateKnowledgeLocationErrors, UpdateKnowledgeLocationResponse, UpdateKnowledgeLocationResponses, UpdateWorkflow, UpdateWorkflowData, UpdateWorkflowError, UpdateWorkflowErrors, UpdateWorkflowResponse, UpdateWorkflowResponses, Webhook, WebhookContactCreatedWebhookPayload, WebhookContactCreatedWebhookRequest, WebhookContactUpdatedWebhookPayload, WebhookContactUpdatedWebhookRequest, WebhookConversationAssignmentChangedWebhookPayload, WebhookConversationAssignmentChangedWebhookRequest, WebhookConversationClosedWebhookPayload, WebhookConversationClosedWebhookRequest, WebhookConversationOpenedWebhookPayload, WebhookConversationOpenedWebhookRequest, WebhookDelivery, WebhookEvent, WebhookMessageDeliveredWebhookPayload, WebhookMessageDeliveredWebhookRequest, WebhookMessageFailedWebhookPayload, WebhookMessageFailedWebhookRequest, WebhookMessageReadWebhookPayload, WebhookMessageReadWebhookRequest, WebhookMessageReceivedWebhookPayload, WebhookMessageReceivedWebhookRequest, WebhookMessageSentWebhookPayload, WebhookMessageSentWebhookRequest, Webhooks, WebhookTestResult, WebhookWebhookTestWebhookPayload, WebhookWebhookTestWebhookRequest, Workflow, WorkflowExecution } from './types.gen.js';
@@ -1,5 +1,5 @@
1
1
  import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client/index.js';
2
- import type { ActivateWorkflowData, ActivateWorkflowErrors, ActivateWorkflowResponses, AddContactNoteData, AddContactNoteErrors, AddContactNoteResponses, AssignConversationData, AssignConversationErrors, AssignConversationResponses, CloseConversationData, CloseConversationErrors, CloseConversationResponses, CreateContactData, CreateContactErrors, CreateContactResponses, CreateTagData, CreateTagErrors, CreateTagResponses, CreateWebhookData, CreateWebhookErrors, CreateWebhookResponses, CreateWorkflowData, CreateWorkflowErrors, CreateWorkflowResponses, DeleteWorkflowData, DeleteWorkflowErrors, DeleteWorkflowResponses, DisableWebhookData, DisableWebhookErrors, DisableWebhookResponses, GetAdsReportData, GetAdsReportErrors, GetAdsReportResponses, GetBroadcastsReportData, GetBroadcastsReportErrors, GetBroadcastsReportResponses, GetContactData, GetContactErrors, GetContactResponses, GetConversationData, GetConversationErrors, GetConversationResponses, GetConversationsReportData, GetConversationsReportErrors, GetConversationsReportResponses, GetDashboardReportData, GetDashboardReportErrors, GetDashboardReportResponses, GetMessageData, GetMessageErrors, GetMessageResponses, GetMessagesReportData, GetMessagesReportErrors, GetMessagesReportResponses, GetResolutionsReportData, GetResolutionsReportErrors, GetResolutionsReportResponses, GetResponsesReportData, GetResponsesReportErrors, GetResponsesReportResponses, GetSendData, GetSendErrors, GetSendResponses, GetTeamReportData, GetTeamReportErrors, GetTeamReportResponses, GetWorkflowData, GetWorkflowErrors, GetWorkflowResponses, ListChannelsData, ListChannelsErrors, ListChannelsResponses, ListContactFieldsData, ListContactFieldsErrors, ListContactFieldsResponses, ListContactsData, ListContactsErrors, ListContactsResponses, ListConversationsData, ListConversationsErrors, ListConversationsResponses, ListMembersData, ListMembersErrors, ListMembersResponses, ListMessagesData, ListMessagesErrors, ListMessagesResponses, ListTagsData, ListTagsErrors, ListTagsResponses, ListTemplatesData, ListTemplatesErrors, ListTemplatesResponses, ListWebhookDeliveriesData, ListWebhookDeliveriesErrors, ListWebhookDeliveriesResponses, ListWebhooksData, ListWebhooksErrors, ListWebhooksResponses, ListWorkflowExecutionsData, ListWorkflowExecutionsErrors, ListWorkflowExecutionsResponses, ListWorkflowsData, ListWorkflowsErrors, ListWorkflowsResponses, PauseWorkflowData, PauseWorkflowErrors, PauseWorkflowResponses, ReopenConversationData, ReopenConversationErrors, ReopenConversationResponses, RetryWebhookDeliveryData, RetryWebhookDeliveryErrors, RetryWebhookDeliveryResponses, RotateWebhookSecretData, RotateWebhookSecretErrors, RotateWebhookSecretResponses, SendMessageData, SendMessageErrors, SendMessageResponses, StartConversationData, StartConversationErrors, StartConversationResponses, TestWebhookData, TestWebhookErrors, TestWebhookResponses, UpdateContactData, UpdateContactErrors, UpdateContactResponses, UpdateWorkflowData, UpdateWorkflowErrors, UpdateWorkflowResponses } from './types.gen.js';
2
+ import type { ActivateWorkflowData, ActivateWorkflowErrors, ActivateWorkflowResponses, AddContactNoteData, AddContactNoteErrors, AddContactNoteResponses, ArchiveAgentData, ArchiveAgentErrors, ArchiveAgentResponses, AssignConversationAgentData, AssignConversationAgentErrors, AssignConversationAgentResponses, AssignConversationData, AssignConversationErrors, AssignConversationResponses, CloseConversationData, CloseConversationErrors, CloseConversationResponses, CompleteKnowledgeFileData, CompleteKnowledgeFileErrors, CompleteKnowledgeFileResponses, CreateAgentData, CreateAgentErrors, CreateAgentResponses, CreateContactData, CreateContactErrors, CreateContactResponses, CreateKnowledgeContactData, CreateKnowledgeContactErrors, CreateKnowledgeContactResponses, CreateKnowledgeFileData, CreateKnowledgeFileErrors, CreateKnowledgeFileResponses, CreateKnowledgeLocationData, CreateKnowledgeLocationErrors, CreateKnowledgeLocationResponses, CreateTagData, CreateTagErrors, CreateTagResponses, CreateWebhookData, CreateWebhookErrors, CreateWebhookResponses, CreateWorkflowData, CreateWorkflowErrors, CreateWorkflowResponses, DeleteKnowledgeContactData, DeleteKnowledgeContactErrors, DeleteKnowledgeContactResponses, DeleteKnowledgeFileData, DeleteKnowledgeFileErrors, DeleteKnowledgeFileResponses, DeleteKnowledgeLocationData, DeleteKnowledgeLocationErrors, DeleteKnowledgeLocationResponses, DeleteWorkflowData, DeleteWorkflowErrors, DeleteWorkflowResponses, DisableWebhookData, DisableWebhookErrors, DisableWebhookResponses, GetAdsReportData, GetAdsReportErrors, GetAdsReportResponses, GetAgentData, GetAgentErrors, GetAgentOptionsData, GetAgentOptionsErrors, GetAgentOptionsResponses, GetAgentResponses, GetBroadcastsReportData, GetBroadcastsReportErrors, GetBroadcastsReportResponses, GetContactData, GetContactErrors, GetContactResponses, GetConversationData, GetConversationErrors, GetConversationResponses, GetConversationsReportData, GetConversationsReportErrors, GetConversationsReportResponses, GetDashboardReportData, GetDashboardReportErrors, GetDashboardReportResponses, GetKnowledgeContactData, GetKnowledgeContactErrors, GetKnowledgeContactResponses, GetKnowledgeFileData, GetKnowledgeFileErrors, GetKnowledgeFileResponses, GetKnowledgeLocationData, GetKnowledgeLocationErrors, GetKnowledgeLocationResponses, GetMessageData, GetMessageErrors, GetMessageResponses, GetMessagesReportData, GetMessagesReportErrors, GetMessagesReportResponses, GetResolutionsReportData, GetResolutionsReportErrors, GetResolutionsReportResponses, GetResponsesReportData, GetResponsesReportErrors, GetResponsesReportResponses, GetSendData, GetSendErrors, GetSendResponses, GetTeamReportData, GetTeamReportErrors, GetTeamReportResponses, GetWorkflowData, GetWorkflowErrors, GetWorkflowResponses, ListAgentsData, ListAgentsErrors, ListAgentsResponses, ListChannelsData, ListChannelsErrors, ListChannelsResponses, ListContactFieldsData, ListContactFieldsErrors, ListContactFieldsResponses, ListContactsData, ListContactsErrors, ListContactsResponses, ListConversationsData, ListConversationsErrors, ListConversationsResponses, ListKnowledgeContactsData, ListKnowledgeContactsErrors, ListKnowledgeContactsResponses, ListKnowledgeFilesData, ListKnowledgeFilesErrors, ListKnowledgeFilesResponses, ListKnowledgeLocationsData, ListKnowledgeLocationsErrors, ListKnowledgeLocationsResponses, ListMembersData, ListMembersErrors, ListMembersResponses, ListMessagesData, ListMessagesErrors, ListMessagesResponses, ListTagsData, ListTagsErrors, ListTagsResponses, ListTemplatesData, ListTemplatesErrors, ListTemplatesResponses, ListWebhookDeliveriesData, ListWebhookDeliveriesErrors, ListWebhookDeliveriesResponses, ListWebhooksData, ListWebhooksErrors, ListWebhooksResponses, ListWorkflowExecutionsData, ListWorkflowExecutionsErrors, ListWorkflowExecutionsResponses, ListWorkflowsData, ListWorkflowsErrors, ListWorkflowsResponses, PauseWorkflowData, PauseWorkflowErrors, PauseWorkflowResponses, ReopenConversationData, ReopenConversationErrors, ReopenConversationResponses, RetryWebhookDeliveryData, RetryWebhookDeliveryErrors, RetryWebhookDeliveryResponses, RotateWebhookSecretData, RotateWebhookSecretErrors, RotateWebhookSecretResponses, SendMessageData, SendMessageErrors, SendMessageResponses, StartConversationData, StartConversationErrors, StartConversationResponses, TestWebhookData, TestWebhookErrors, TestWebhookResponses, UpdateAgentData, UpdateAgentErrors, UpdateAgentResponses, UpdateContactData, UpdateContactErrors, UpdateContactResponses, UpdateKnowledgeContactData, UpdateKnowledgeContactErrors, UpdateKnowledgeContactResponses, UpdateKnowledgeFileData, UpdateKnowledgeFileErrors, UpdateKnowledgeFileResponses, UpdateKnowledgeLocationData, UpdateKnowledgeLocationErrors, UpdateKnowledgeLocationResponses, UpdateWorkflowData, UpdateWorkflowErrors, UpdateWorkflowResponses } from './types.gen.js';
3
3
  export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
4
4
  /**
5
5
  * You can provide a client instance returned by `createClient()` instead of
@@ -383,5 +383,189 @@ export declare class RickyApi extends HeyApiClient {
383
383
  * Scope: `reports:read`.
384
384
  */
385
385
  getAdsReport<ThrowOnError extends boolean = true>(options?: Options<GetAdsReportData, ThrowOnError>): RequestResult<GetAdsReportResponses, GetAdsReportErrors, ThrowOnError, 'data'>;
386
+ /**
387
+ * List agents
388
+ *
389
+ * Active agents, newest first. Archived agents are not listed.
390
+ *
391
+ * Scope: `agents:read`.
392
+ */
393
+ listAgents<ThrowOnError extends boolean = true>(options?: Options<ListAgentsData, ThrowOnError>): RequestResult<ListAgentsResponses, ListAgentsErrors, ThrowOnError, 'data'>;
394
+ /**
395
+ * Create an agent
396
+ *
397
+ * Creates an AI agent with its instructions, model, voice and capabilities. It answers no conversation until you assign it to one or make it a channel default in Ricky.
398
+ *
399
+ * Scope: `agents:write`.
400
+ */
401
+ createAgent<ThrowOnError extends boolean = true>(options: Options<CreateAgentData, ThrowOnError>): RequestResult<CreateAgentResponses, CreateAgentErrors, ThrowOnError, 'data'>;
402
+ /**
403
+ * Archive an agent
404
+ *
405
+ * Archives the agent and answers it as it was, with `archived_at`. Its conversations stop being answered by it and workflows that assign it are paused. Archiving twice answers `404`.
406
+ *
407
+ * Scope: `agents:write`.
408
+ */
409
+ archiveAgent<ThrowOnError extends boolean = true>(options: Options<ArchiveAgentData, ThrowOnError>): RequestResult<ArchiveAgentResponses, ArchiveAgentErrors, ThrowOnError, 'data'>;
410
+ /**
411
+ * Get an agent
412
+ *
413
+ * One active agent with its full settings.
414
+ *
415
+ * Scope: `agents:read`.
416
+ */
417
+ getAgent<ThrowOnError extends boolean = true>(options: Options<GetAgentData, ThrowOnError>): RequestResult<GetAgentResponses, GetAgentErrors, ThrowOnError, 'data'>;
418
+ /**
419
+ * Update an agent
420
+ *
421
+ * Changes only the fields in the body. `capabilities` and `handoff_user_ids` replace their whole sets.
422
+ *
423
+ * Scope: `agents:write`.
424
+ */
425
+ updateAgent<ThrowOnError extends boolean = true>(options: Options<UpdateAgentData, ThrowOnError>): RequestResult<UpdateAgentResponses, UpdateAgentErrors, ThrowOnError, 'data'>;
426
+ /**
427
+ * Get agent options
428
+ *
429
+ * The models, voices and capabilities an agent can be configured with.
430
+ *
431
+ * Scope: `agents:read`.
432
+ */
433
+ getAgentOptions<ThrowOnError extends boolean = true>(options?: Options<GetAgentOptionsData, ThrowOnError>): RequestResult<GetAgentOptionsResponses, GetAgentOptionsErrors, ThrowOnError, 'data'>;
434
+ /**
435
+ * Set the AI agent of a conversation
436
+ *
437
+ * Makes an agent answer the conversation, or turns the AI off with `null`. Either way the conversation is no longer assigned to a member; the contact owner stays.
438
+ *
439
+ * Scope: `conversations:write`.
440
+ */
441
+ assignConversationAgent<ThrowOnError extends boolean = true>(options: Options<AssignConversationAgentData, ThrowOnError>): RequestResult<AssignConversationAgentResponses, AssignConversationAgentErrors, ThrowOnError, 'data'>;
442
+ /**
443
+ * List locations
444
+ *
445
+ * Branches and places, newest first.
446
+ *
447
+ * Scope: `knowledge:read`.
448
+ */
449
+ listKnowledgeLocations<ThrowOnError extends boolean = true>(options?: Options<ListKnowledgeLocationsData, ThrowOnError>): RequestResult<ListKnowledgeLocationsResponses, ListKnowledgeLocationsErrors, ThrowOnError, 'data'>;
450
+ /**
451
+ * Create a location
452
+ *
453
+ * Adds a branch or place the agents can share.
454
+ *
455
+ * Scope: `knowledge:write`.
456
+ */
457
+ createKnowledgeLocation<ThrowOnError extends boolean = true>(options: Options<CreateKnowledgeLocationData, ThrowOnError>): RequestResult<CreateKnowledgeLocationResponses, CreateKnowledgeLocationErrors, ThrowOnError, 'data'>;
458
+ /**
459
+ * Delete a location
460
+ *
461
+ * Deletes it for good and answers it as it was.
462
+ *
463
+ * Scope: `knowledge:write`.
464
+ */
465
+ deleteKnowledgeLocation<ThrowOnError extends boolean = true>(options: Options<DeleteKnowledgeLocationData, ThrowOnError>): RequestResult<DeleteKnowledgeLocationResponses, DeleteKnowledgeLocationErrors, ThrowOnError, 'data'>;
466
+ /**
467
+ * Get a location
468
+ *
469
+ * One location.
470
+ *
471
+ * Scope: `knowledge:read`.
472
+ */
473
+ getKnowledgeLocation<ThrowOnError extends boolean = true>(options: Options<GetKnowledgeLocationData, ThrowOnError>): RequestResult<GetKnowledgeLocationResponses, GetKnowledgeLocationErrors, ThrowOnError, 'data'>;
474
+ /**
475
+ * Update a location
476
+ *
477
+ * Changes only the fields in the body.
478
+ *
479
+ * Scope: `knowledge:write`.
480
+ */
481
+ updateKnowledgeLocation<ThrowOnError extends boolean = true>(options: Options<UpdateKnowledgeLocationData, ThrowOnError>): RequestResult<UpdateKnowledgeLocationResponses, UpdateKnowledgeLocationErrors, ThrowOnError, 'data'>;
482
+ /**
483
+ * List directory contacts
484
+ *
485
+ * Contact cards of the knowledge directory, by display name. These are not CRM contacts.
486
+ *
487
+ * Scope: `knowledge:read`.
488
+ */
489
+ listKnowledgeContacts<ThrowOnError extends boolean = true>(options?: Options<ListKnowledgeContactsData, ThrowOnError>): RequestResult<ListKnowledgeContactsResponses, ListKnowledgeContactsErrors, ThrowOnError, 'data'>;
490
+ /**
491
+ * Create a directory contact
492
+ *
493
+ * Adds a contact card the agents can send to customers.
494
+ *
495
+ * Scope: `knowledge:write`.
496
+ */
497
+ createKnowledgeContact<ThrowOnError extends boolean = true>(options: Options<CreateKnowledgeContactData, ThrowOnError>): RequestResult<CreateKnowledgeContactResponses, CreateKnowledgeContactErrors, ThrowOnError, 'data'>;
498
+ /**
499
+ * Delete a directory contact
500
+ *
501
+ * Deletes it for good and answers it as it was.
502
+ *
503
+ * Scope: `knowledge:write`.
504
+ */
505
+ deleteKnowledgeContact<ThrowOnError extends boolean = true>(options: Options<DeleteKnowledgeContactData, ThrowOnError>): RequestResult<DeleteKnowledgeContactResponses, DeleteKnowledgeContactErrors, ThrowOnError, 'data'>;
506
+ /**
507
+ * Get a directory contact
508
+ *
509
+ * One contact card.
510
+ *
511
+ * Scope: `knowledge:read`.
512
+ */
513
+ getKnowledgeContact<ThrowOnError extends boolean = true>(options: Options<GetKnowledgeContactData, ThrowOnError>): RequestResult<GetKnowledgeContactResponses, GetKnowledgeContactErrors, ThrowOnError, 'data'>;
514
+ /**
515
+ * Update a directory contact
516
+ *
517
+ * Changes only the fields in the body.
518
+ *
519
+ * Scope: `knowledge:write`.
520
+ */
521
+ updateKnowledgeContact<ThrowOnError extends boolean = true>(options: Options<UpdateKnowledgeContactData, ThrowOnError>): RequestResult<UpdateKnowledgeContactResponses, UpdateKnowledgeContactErrors, ThrowOnError, 'data'>;
522
+ /**
523
+ * List files
524
+ *
525
+ * Documents and images the agents can consult or send, newest first.
526
+ *
527
+ * Scope: `knowledge:read`.
528
+ */
529
+ listKnowledgeFiles<ThrowOnError extends boolean = true>(options?: Options<ListKnowledgeFilesData, ThrowOnError>): RequestResult<ListKnowledgeFilesResponses, ListKnowledgeFilesErrors, ThrowOnError, 'data'>;
530
+ /**
531
+ * Upload a file
532
+ *
533
+ * Begins an upload in three steps: this call answers the file, `uploading`, and an `upload_url`; `PUT` the bytes there; then call `POST /knowledge/files/{file_id}/complete`.
534
+ *
535
+ * Scope: `knowledge:write`.
536
+ */
537
+ createKnowledgeFile<ThrowOnError extends boolean = true>(options: Options<CreateKnowledgeFileData, ThrowOnError>): RequestResult<CreateKnowledgeFileResponses, CreateKnowledgeFileErrors, ThrowOnError, 'data'>;
538
+ /**
539
+ * Complete an upload
540
+ *
541
+ * Checks the uploaded bytes against the declared type and size, reads the content for the agents and answers the file, `ready`. Reading a long PDF can take minutes. Completing a `ready` file changes nothing.
542
+ *
543
+ * Scope: `knowledge:write`.
544
+ */
545
+ completeKnowledgeFile<ThrowOnError extends boolean = true>(options: Options<CompleteKnowledgeFileData, ThrowOnError>): RequestResult<CompleteKnowledgeFileResponses, CompleteKnowledgeFileErrors, ThrowOnError, 'data'>;
546
+ /**
547
+ * Delete a file
548
+ *
549
+ * Deletes it for good and answers it as it was. Copies already sent in conversations stay there.
550
+ *
551
+ * Scope: `knowledge:write`.
552
+ */
553
+ deleteKnowledgeFile<ThrowOnError extends boolean = true>(options: Options<DeleteKnowledgeFileData, ThrowOnError>): RequestResult<DeleteKnowledgeFileResponses, DeleteKnowledgeFileErrors, ThrowOnError, 'data'>;
554
+ /**
555
+ * Get a file
556
+ *
557
+ * One file; a `ready` one carries a `download_url`.
558
+ *
559
+ * Scope: `knowledge:read`.
560
+ */
561
+ getKnowledgeFile<ThrowOnError extends boolean = true>(options: Options<GetKnowledgeFileData, ThrowOnError>): RequestResult<GetKnowledgeFileResponses, GetKnowledgeFileErrors, ThrowOnError, 'data'>;
562
+ /**
563
+ * Update a file
564
+ *
565
+ * Changes its title, description or what the agents may do with it. Only a `ready` file changes; otherwise `409 conflict`.
566
+ *
567
+ * Scope: `knowledge:write`.
568
+ */
569
+ updateKnowledgeFile<ThrowOnError extends boolean = true>(options: Options<UpdateKnowledgeFileData, ThrowOnError>): RequestResult<UpdateKnowledgeFileResponses, UpdateKnowledgeFileErrors, ThrowOnError, 'data'>;
386
570
  }
387
571
  export {};
@@ -737,5 +737,390 @@ class RickyApi extends HeyApiClient {
737
737
  ...options
738
738
  });
739
739
  }
740
+ /**
741
+ * List agents
742
+ *
743
+ * Active agents, newest first. Archived agents are not listed.
744
+ *
745
+ * Scope: `agents:read`.
746
+ */
747
+ listAgents(options) {
748
+ return (options?.client ?? this.client).get({
749
+ responseStyle: 'data',
750
+ security: [{ scheme: 'bearer', type: 'http' }],
751
+ url: '/agents',
752
+ ...options
753
+ });
754
+ }
755
+ /**
756
+ * Create an agent
757
+ *
758
+ * Creates an AI agent with its instructions, model, voice and capabilities. It answers no conversation until you assign it to one or make it a channel default in Ricky.
759
+ *
760
+ * Scope: `agents:write`.
761
+ */
762
+ createAgent(options) {
763
+ return (options.client ?? this.client).post({
764
+ responseStyle: 'data',
765
+ security: [{ scheme: 'bearer', type: 'http' }],
766
+ url: '/agents',
767
+ ...options,
768
+ headers: {
769
+ 'Content-Type': 'application/json',
770
+ ...options.headers
771
+ }
772
+ });
773
+ }
774
+ /**
775
+ * Archive an agent
776
+ *
777
+ * Archives the agent and answers it as it was, with `archived_at`. Its conversations stop being answered by it and workflows that assign it are paused. Archiving twice answers `404`.
778
+ *
779
+ * Scope: `agents:write`.
780
+ */
781
+ archiveAgent(options) {
782
+ return (options.client ?? this.client).delete({
783
+ responseStyle: 'data',
784
+ security: [{ scheme: 'bearer', type: 'http' }],
785
+ url: '/agents/{agent_id}',
786
+ ...options
787
+ });
788
+ }
789
+ /**
790
+ * Get an agent
791
+ *
792
+ * One active agent with its full settings.
793
+ *
794
+ * Scope: `agents:read`.
795
+ */
796
+ getAgent(options) {
797
+ return (options.client ?? this.client).get({
798
+ responseStyle: 'data',
799
+ security: [{ scheme: 'bearer', type: 'http' }],
800
+ url: '/agents/{agent_id}',
801
+ ...options
802
+ });
803
+ }
804
+ /**
805
+ * Update an agent
806
+ *
807
+ * Changes only the fields in the body. `capabilities` and `handoff_user_ids` replace their whole sets.
808
+ *
809
+ * Scope: `agents:write`.
810
+ */
811
+ updateAgent(options) {
812
+ return (options.client ?? this.client).patch({
813
+ responseStyle: 'data',
814
+ security: [{ scheme: 'bearer', type: 'http' }],
815
+ url: '/agents/{agent_id}',
816
+ ...options,
817
+ headers: {
818
+ 'Content-Type': 'application/json',
819
+ ...options.headers
820
+ }
821
+ });
822
+ }
823
+ /**
824
+ * Get agent options
825
+ *
826
+ * The models, voices and capabilities an agent can be configured with.
827
+ *
828
+ * Scope: `agents:read`.
829
+ */
830
+ getAgentOptions(options) {
831
+ return (options?.client ?? this.client).get({
832
+ responseStyle: 'data',
833
+ security: [{ scheme: 'bearer', type: 'http' }],
834
+ url: '/agent-options',
835
+ ...options
836
+ });
837
+ }
838
+ /**
839
+ * Set the AI agent of a conversation
840
+ *
841
+ * Makes an agent answer the conversation, or turns the AI off with `null`. Either way the conversation is no longer assigned to a member; the contact owner stays.
842
+ *
843
+ * Scope: `conversations:write`.
844
+ */
845
+ assignConversationAgent(options) {
846
+ return (options.client ?? this.client).patch({
847
+ responseStyle: 'data',
848
+ security: [{ scheme: 'bearer', type: 'http' }],
849
+ url: '/conversations/{conversation_id}/agent',
850
+ ...options,
851
+ headers: {
852
+ 'Content-Type': 'application/json',
853
+ ...options.headers
854
+ }
855
+ });
856
+ }
857
+ /**
858
+ * List locations
859
+ *
860
+ * Branches and places, newest first.
861
+ *
862
+ * Scope: `knowledge:read`.
863
+ */
864
+ listKnowledgeLocations(options) {
865
+ return (options?.client ?? this.client).get({
866
+ responseStyle: 'data',
867
+ security: [{ scheme: 'bearer', type: 'http' }],
868
+ url: '/knowledge/locations',
869
+ ...options
870
+ });
871
+ }
872
+ /**
873
+ * Create a location
874
+ *
875
+ * Adds a branch or place the agents can share.
876
+ *
877
+ * Scope: `knowledge:write`.
878
+ */
879
+ createKnowledgeLocation(options) {
880
+ return (options.client ?? this.client).post({
881
+ responseStyle: 'data',
882
+ security: [{ scheme: 'bearer', type: 'http' }],
883
+ url: '/knowledge/locations',
884
+ ...options,
885
+ headers: {
886
+ 'Content-Type': 'application/json',
887
+ ...options.headers
888
+ }
889
+ });
890
+ }
891
+ /**
892
+ * Delete a location
893
+ *
894
+ * Deletes it for good and answers it as it was.
895
+ *
896
+ * Scope: `knowledge:write`.
897
+ */
898
+ deleteKnowledgeLocation(options) {
899
+ return (options.client ?? this.client).delete({
900
+ responseStyle: 'data',
901
+ security: [{ scheme: 'bearer', type: 'http' }],
902
+ url: '/knowledge/locations/{location_id}',
903
+ ...options
904
+ });
905
+ }
906
+ /**
907
+ * Get a location
908
+ *
909
+ * One location.
910
+ *
911
+ * Scope: `knowledge:read`.
912
+ */
913
+ getKnowledgeLocation(options) {
914
+ return (options.client ?? this.client).get({
915
+ responseStyle: 'data',
916
+ security: [{ scheme: 'bearer', type: 'http' }],
917
+ url: '/knowledge/locations/{location_id}',
918
+ ...options
919
+ });
920
+ }
921
+ /**
922
+ * Update a location
923
+ *
924
+ * Changes only the fields in the body.
925
+ *
926
+ * Scope: `knowledge:write`.
927
+ */
928
+ updateKnowledgeLocation(options) {
929
+ return (options.client ?? this.client).patch({
930
+ responseStyle: 'data',
931
+ security: [{ scheme: 'bearer', type: 'http' }],
932
+ url: '/knowledge/locations/{location_id}',
933
+ ...options,
934
+ headers: {
935
+ 'Content-Type': 'application/json',
936
+ ...options.headers
937
+ }
938
+ });
939
+ }
940
+ /**
941
+ * List directory contacts
942
+ *
943
+ * Contact cards of the knowledge directory, by display name. These are not CRM contacts.
944
+ *
945
+ * Scope: `knowledge:read`.
946
+ */
947
+ listKnowledgeContacts(options) {
948
+ return (options?.client ?? this.client).get({
949
+ responseStyle: 'data',
950
+ security: [{ scheme: 'bearer', type: 'http' }],
951
+ url: '/knowledge/contacts',
952
+ ...options
953
+ });
954
+ }
955
+ /**
956
+ * Create a directory contact
957
+ *
958
+ * Adds a contact card the agents can send to customers.
959
+ *
960
+ * Scope: `knowledge:write`.
961
+ */
962
+ createKnowledgeContact(options) {
963
+ return (options.client ?? this.client).post({
964
+ responseStyle: 'data',
965
+ security: [{ scheme: 'bearer', type: 'http' }],
966
+ url: '/knowledge/contacts',
967
+ ...options,
968
+ headers: {
969
+ 'Content-Type': 'application/json',
970
+ ...options.headers
971
+ }
972
+ });
973
+ }
974
+ /**
975
+ * Delete a directory contact
976
+ *
977
+ * Deletes it for good and answers it as it was.
978
+ *
979
+ * Scope: `knowledge:write`.
980
+ */
981
+ deleteKnowledgeContact(options) {
982
+ return (options.client ?? this.client).delete({
983
+ responseStyle: 'data',
984
+ security: [{ scheme: 'bearer', type: 'http' }],
985
+ url: '/knowledge/contacts/{knowledge_contact_id}',
986
+ ...options
987
+ });
988
+ }
989
+ /**
990
+ * Get a directory contact
991
+ *
992
+ * One contact card.
993
+ *
994
+ * Scope: `knowledge:read`.
995
+ */
996
+ getKnowledgeContact(options) {
997
+ return (options.client ?? this.client).get({
998
+ responseStyle: 'data',
999
+ security: [{ scheme: 'bearer', type: 'http' }],
1000
+ url: '/knowledge/contacts/{knowledge_contact_id}',
1001
+ ...options
1002
+ });
1003
+ }
1004
+ /**
1005
+ * Update a directory contact
1006
+ *
1007
+ * Changes only the fields in the body.
1008
+ *
1009
+ * Scope: `knowledge:write`.
1010
+ */
1011
+ updateKnowledgeContact(options) {
1012
+ return (options.client ?? this.client).patch({
1013
+ responseStyle: 'data',
1014
+ security: [{ scheme: 'bearer', type: 'http' }],
1015
+ url: '/knowledge/contacts/{knowledge_contact_id}',
1016
+ ...options,
1017
+ headers: {
1018
+ 'Content-Type': 'application/json',
1019
+ ...options.headers
1020
+ }
1021
+ });
1022
+ }
1023
+ /**
1024
+ * List files
1025
+ *
1026
+ * Documents and images the agents can consult or send, newest first.
1027
+ *
1028
+ * Scope: `knowledge:read`.
1029
+ */
1030
+ listKnowledgeFiles(options) {
1031
+ return (options?.client ?? this.client).get({
1032
+ responseStyle: 'data',
1033
+ security: [{ scheme: 'bearer', type: 'http' }],
1034
+ url: '/knowledge/files',
1035
+ ...options
1036
+ });
1037
+ }
1038
+ /**
1039
+ * Upload a file
1040
+ *
1041
+ * Begins an upload in three steps: this call answers the file, `uploading`, and an `upload_url`; `PUT` the bytes there; then call `POST /knowledge/files/{file_id}/complete`.
1042
+ *
1043
+ * Scope: `knowledge:write`.
1044
+ */
1045
+ createKnowledgeFile(options) {
1046
+ return (options.client ?? this.client).post({
1047
+ responseStyle: 'data',
1048
+ security: [{ scheme: 'bearer', type: 'http' }],
1049
+ url: '/knowledge/files',
1050
+ ...options,
1051
+ headers: {
1052
+ 'Content-Type': 'application/json',
1053
+ ...options.headers
1054
+ }
1055
+ });
1056
+ }
1057
+ /**
1058
+ * Complete an upload
1059
+ *
1060
+ * Checks the uploaded bytes against the declared type and size, reads the content for the agents and answers the file, `ready`. Reading a long PDF can take minutes. Completing a `ready` file changes nothing.
1061
+ *
1062
+ * Scope: `knowledge:write`.
1063
+ */
1064
+ completeKnowledgeFile(options) {
1065
+ return (options.client ?? this.client).post({
1066
+ responseStyle: 'data',
1067
+ security: [{ scheme: 'bearer', type: 'http' }],
1068
+ url: '/knowledge/files/{file_id}/complete',
1069
+ ...options,
1070
+ headers: {
1071
+ 'Content-Type': 'application/json',
1072
+ ...options.headers
1073
+ }
1074
+ });
1075
+ }
1076
+ /**
1077
+ * Delete a file
1078
+ *
1079
+ * Deletes it for good and answers it as it was. Copies already sent in conversations stay there.
1080
+ *
1081
+ * Scope: `knowledge:write`.
1082
+ */
1083
+ deleteKnowledgeFile(options) {
1084
+ return (options.client ?? this.client).delete({
1085
+ responseStyle: 'data',
1086
+ security: [{ scheme: 'bearer', type: 'http' }],
1087
+ url: '/knowledge/files/{file_id}',
1088
+ ...options
1089
+ });
1090
+ }
1091
+ /**
1092
+ * Get a file
1093
+ *
1094
+ * One file; a `ready` one carries a `download_url`.
1095
+ *
1096
+ * Scope: `knowledge:read`.
1097
+ */
1098
+ getKnowledgeFile(options) {
1099
+ return (options.client ?? this.client).get({
1100
+ responseStyle: 'data',
1101
+ security: [{ scheme: 'bearer', type: 'http' }],
1102
+ url: '/knowledge/files/{file_id}',
1103
+ ...options
1104
+ });
1105
+ }
1106
+ /**
1107
+ * Update a file
1108
+ *
1109
+ * Changes its title, description or what the agents may do with it. Only a `ready` file changes; otherwise `409 conflict`.
1110
+ *
1111
+ * Scope: `knowledge:write`.
1112
+ */
1113
+ updateKnowledgeFile(options) {
1114
+ return (options.client ?? this.client).patch({
1115
+ responseStyle: 'data',
1116
+ security: [{ scheme: 'bearer', type: 'http' }],
1117
+ url: '/knowledge/files/{file_id}',
1118
+ ...options,
1119
+ headers: {
1120
+ 'Content-Type': 'application/json',
1121
+ ...options.headers
1122
+ }
1123
+ });
1124
+ }
740
1125
  }
741
1126
  exports.RickyApi = RickyApi;