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.
- package/dist/cjs/generated/idempotency.gen.js +10 -0
- package/dist/cjs/generated/index.d.ts +1 -1
- package/dist/cjs/generated/sdk.gen.d.ts +185 -1
- package/dist/cjs/generated/sdk.gen.js +385 -0
- package/dist/cjs/generated/types.gen.d.ts +1915 -31
- package/dist/esm/generated/idempotency.gen.js +10 -0
- package/dist/esm/generated/index.d.ts +1 -1
- package/dist/esm/generated/sdk.gen.d.ts +185 -1
- package/dist/esm/generated/sdk.gen.js +385 -0
- package/dist/esm/generated/types.gen.d.ts +1915 -31
- package/package.json +1 -1
|
@@ -1,15 +1,25 @@
|
|
|
1
1
|
// This file is auto-generated by scripts/generate.mjs
|
|
2
2
|
/** `METHOD /path/{template}` of every write that accepts an `Idempotency-Key` header. */
|
|
3
3
|
export const idempotentOperations = new Set([
|
|
4
|
+
'PATCH /agents/{agent_id}',
|
|
4
5
|
'PATCH /contacts/{contact_id}',
|
|
6
|
+
'PATCH /conversations/{conversation_id}/agent',
|
|
5
7
|
'PATCH /conversations/{conversation_id}/assignment',
|
|
8
|
+
'PATCH /knowledge/contacts/{knowledge_contact_id}',
|
|
9
|
+
'PATCH /knowledge/files/{file_id}',
|
|
10
|
+
'PATCH /knowledge/locations/{location_id}',
|
|
6
11
|
'PATCH /workflows/{workflow_id}',
|
|
12
|
+
'POST /agents',
|
|
7
13
|
'POST /contacts',
|
|
8
14
|
'POST /contacts/{contact_id}/notes',
|
|
9
15
|
'POST /conversations',
|
|
10
16
|
'POST /conversations/{conversation_id}/close',
|
|
11
17
|
'POST /conversations/{conversation_id}/messages',
|
|
12
18
|
'POST /conversations/{conversation_id}/reopen',
|
|
19
|
+
'POST /knowledge/contacts',
|
|
20
|
+
'POST /knowledge/files',
|
|
21
|
+
'POST /knowledge/files/{file_id}/complete',
|
|
22
|
+
'POST /knowledge/locations',
|
|
13
23
|
'POST /tags',
|
|
14
24
|
'POST /workflows',
|
|
15
25
|
]);
|
|
@@ -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 {};
|
|
@@ -734,4 +734,389 @@ export class RickyApi extends HeyApiClient {
|
|
|
734
734
|
...options
|
|
735
735
|
});
|
|
736
736
|
}
|
|
737
|
+
/**
|
|
738
|
+
* List agents
|
|
739
|
+
*
|
|
740
|
+
* Active agents, newest first. Archived agents are not listed.
|
|
741
|
+
*
|
|
742
|
+
* Scope: `agents:read`.
|
|
743
|
+
*/
|
|
744
|
+
listAgents(options) {
|
|
745
|
+
return (options?.client ?? this.client).get({
|
|
746
|
+
responseStyle: 'data',
|
|
747
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
748
|
+
url: '/agents',
|
|
749
|
+
...options
|
|
750
|
+
});
|
|
751
|
+
}
|
|
752
|
+
/**
|
|
753
|
+
* Create an agent
|
|
754
|
+
*
|
|
755
|
+
* 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.
|
|
756
|
+
*
|
|
757
|
+
* Scope: `agents:write`.
|
|
758
|
+
*/
|
|
759
|
+
createAgent(options) {
|
|
760
|
+
return (options.client ?? this.client).post({
|
|
761
|
+
responseStyle: 'data',
|
|
762
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
763
|
+
url: '/agents',
|
|
764
|
+
...options,
|
|
765
|
+
headers: {
|
|
766
|
+
'Content-Type': 'application/json',
|
|
767
|
+
...options.headers
|
|
768
|
+
}
|
|
769
|
+
});
|
|
770
|
+
}
|
|
771
|
+
/**
|
|
772
|
+
* Archive an agent
|
|
773
|
+
*
|
|
774
|
+
* 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`.
|
|
775
|
+
*
|
|
776
|
+
* Scope: `agents:write`.
|
|
777
|
+
*/
|
|
778
|
+
archiveAgent(options) {
|
|
779
|
+
return (options.client ?? this.client).delete({
|
|
780
|
+
responseStyle: 'data',
|
|
781
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
782
|
+
url: '/agents/{agent_id}',
|
|
783
|
+
...options
|
|
784
|
+
});
|
|
785
|
+
}
|
|
786
|
+
/**
|
|
787
|
+
* Get an agent
|
|
788
|
+
*
|
|
789
|
+
* One active agent with its full settings.
|
|
790
|
+
*
|
|
791
|
+
* Scope: `agents:read`.
|
|
792
|
+
*/
|
|
793
|
+
getAgent(options) {
|
|
794
|
+
return (options.client ?? this.client).get({
|
|
795
|
+
responseStyle: 'data',
|
|
796
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
797
|
+
url: '/agents/{agent_id}',
|
|
798
|
+
...options
|
|
799
|
+
});
|
|
800
|
+
}
|
|
801
|
+
/**
|
|
802
|
+
* Update an agent
|
|
803
|
+
*
|
|
804
|
+
* Changes only the fields in the body. `capabilities` and `handoff_user_ids` replace their whole sets.
|
|
805
|
+
*
|
|
806
|
+
* Scope: `agents:write`.
|
|
807
|
+
*/
|
|
808
|
+
updateAgent(options) {
|
|
809
|
+
return (options.client ?? this.client).patch({
|
|
810
|
+
responseStyle: 'data',
|
|
811
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
812
|
+
url: '/agents/{agent_id}',
|
|
813
|
+
...options,
|
|
814
|
+
headers: {
|
|
815
|
+
'Content-Type': 'application/json',
|
|
816
|
+
...options.headers
|
|
817
|
+
}
|
|
818
|
+
});
|
|
819
|
+
}
|
|
820
|
+
/**
|
|
821
|
+
* Get agent options
|
|
822
|
+
*
|
|
823
|
+
* The models, voices and capabilities an agent can be configured with.
|
|
824
|
+
*
|
|
825
|
+
* Scope: `agents:read`.
|
|
826
|
+
*/
|
|
827
|
+
getAgentOptions(options) {
|
|
828
|
+
return (options?.client ?? this.client).get({
|
|
829
|
+
responseStyle: 'data',
|
|
830
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
831
|
+
url: '/agent-options',
|
|
832
|
+
...options
|
|
833
|
+
});
|
|
834
|
+
}
|
|
835
|
+
/**
|
|
836
|
+
* Set the AI agent of a conversation
|
|
837
|
+
*
|
|
838
|
+
* 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.
|
|
839
|
+
*
|
|
840
|
+
* Scope: `conversations:write`.
|
|
841
|
+
*/
|
|
842
|
+
assignConversationAgent(options) {
|
|
843
|
+
return (options.client ?? this.client).patch({
|
|
844
|
+
responseStyle: 'data',
|
|
845
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
846
|
+
url: '/conversations/{conversation_id}/agent',
|
|
847
|
+
...options,
|
|
848
|
+
headers: {
|
|
849
|
+
'Content-Type': 'application/json',
|
|
850
|
+
...options.headers
|
|
851
|
+
}
|
|
852
|
+
});
|
|
853
|
+
}
|
|
854
|
+
/**
|
|
855
|
+
* List locations
|
|
856
|
+
*
|
|
857
|
+
* Branches and places, newest first.
|
|
858
|
+
*
|
|
859
|
+
* Scope: `knowledge:read`.
|
|
860
|
+
*/
|
|
861
|
+
listKnowledgeLocations(options) {
|
|
862
|
+
return (options?.client ?? this.client).get({
|
|
863
|
+
responseStyle: 'data',
|
|
864
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
865
|
+
url: '/knowledge/locations',
|
|
866
|
+
...options
|
|
867
|
+
});
|
|
868
|
+
}
|
|
869
|
+
/**
|
|
870
|
+
* Create a location
|
|
871
|
+
*
|
|
872
|
+
* Adds a branch or place the agents can share.
|
|
873
|
+
*
|
|
874
|
+
* Scope: `knowledge:write`.
|
|
875
|
+
*/
|
|
876
|
+
createKnowledgeLocation(options) {
|
|
877
|
+
return (options.client ?? this.client).post({
|
|
878
|
+
responseStyle: 'data',
|
|
879
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
880
|
+
url: '/knowledge/locations',
|
|
881
|
+
...options,
|
|
882
|
+
headers: {
|
|
883
|
+
'Content-Type': 'application/json',
|
|
884
|
+
...options.headers
|
|
885
|
+
}
|
|
886
|
+
});
|
|
887
|
+
}
|
|
888
|
+
/**
|
|
889
|
+
* Delete a location
|
|
890
|
+
*
|
|
891
|
+
* Deletes it for good and answers it as it was.
|
|
892
|
+
*
|
|
893
|
+
* Scope: `knowledge:write`.
|
|
894
|
+
*/
|
|
895
|
+
deleteKnowledgeLocation(options) {
|
|
896
|
+
return (options.client ?? this.client).delete({
|
|
897
|
+
responseStyle: 'data',
|
|
898
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
899
|
+
url: '/knowledge/locations/{location_id}',
|
|
900
|
+
...options
|
|
901
|
+
});
|
|
902
|
+
}
|
|
903
|
+
/**
|
|
904
|
+
* Get a location
|
|
905
|
+
*
|
|
906
|
+
* One location.
|
|
907
|
+
*
|
|
908
|
+
* Scope: `knowledge:read`.
|
|
909
|
+
*/
|
|
910
|
+
getKnowledgeLocation(options) {
|
|
911
|
+
return (options.client ?? this.client).get({
|
|
912
|
+
responseStyle: 'data',
|
|
913
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
914
|
+
url: '/knowledge/locations/{location_id}',
|
|
915
|
+
...options
|
|
916
|
+
});
|
|
917
|
+
}
|
|
918
|
+
/**
|
|
919
|
+
* Update a location
|
|
920
|
+
*
|
|
921
|
+
* Changes only the fields in the body.
|
|
922
|
+
*
|
|
923
|
+
* Scope: `knowledge:write`.
|
|
924
|
+
*/
|
|
925
|
+
updateKnowledgeLocation(options) {
|
|
926
|
+
return (options.client ?? this.client).patch({
|
|
927
|
+
responseStyle: 'data',
|
|
928
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
929
|
+
url: '/knowledge/locations/{location_id}',
|
|
930
|
+
...options,
|
|
931
|
+
headers: {
|
|
932
|
+
'Content-Type': 'application/json',
|
|
933
|
+
...options.headers
|
|
934
|
+
}
|
|
935
|
+
});
|
|
936
|
+
}
|
|
937
|
+
/**
|
|
938
|
+
* List directory contacts
|
|
939
|
+
*
|
|
940
|
+
* Contact cards of the knowledge directory, by display name. These are not CRM contacts.
|
|
941
|
+
*
|
|
942
|
+
* Scope: `knowledge:read`.
|
|
943
|
+
*/
|
|
944
|
+
listKnowledgeContacts(options) {
|
|
945
|
+
return (options?.client ?? this.client).get({
|
|
946
|
+
responseStyle: 'data',
|
|
947
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
948
|
+
url: '/knowledge/contacts',
|
|
949
|
+
...options
|
|
950
|
+
});
|
|
951
|
+
}
|
|
952
|
+
/**
|
|
953
|
+
* Create a directory contact
|
|
954
|
+
*
|
|
955
|
+
* Adds a contact card the agents can send to customers.
|
|
956
|
+
*
|
|
957
|
+
* Scope: `knowledge:write`.
|
|
958
|
+
*/
|
|
959
|
+
createKnowledgeContact(options) {
|
|
960
|
+
return (options.client ?? this.client).post({
|
|
961
|
+
responseStyle: 'data',
|
|
962
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
963
|
+
url: '/knowledge/contacts',
|
|
964
|
+
...options,
|
|
965
|
+
headers: {
|
|
966
|
+
'Content-Type': 'application/json',
|
|
967
|
+
...options.headers
|
|
968
|
+
}
|
|
969
|
+
});
|
|
970
|
+
}
|
|
971
|
+
/**
|
|
972
|
+
* Delete a directory contact
|
|
973
|
+
*
|
|
974
|
+
* Deletes it for good and answers it as it was.
|
|
975
|
+
*
|
|
976
|
+
* Scope: `knowledge:write`.
|
|
977
|
+
*/
|
|
978
|
+
deleteKnowledgeContact(options) {
|
|
979
|
+
return (options.client ?? this.client).delete({
|
|
980
|
+
responseStyle: 'data',
|
|
981
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
982
|
+
url: '/knowledge/contacts/{knowledge_contact_id}',
|
|
983
|
+
...options
|
|
984
|
+
});
|
|
985
|
+
}
|
|
986
|
+
/**
|
|
987
|
+
* Get a directory contact
|
|
988
|
+
*
|
|
989
|
+
* One contact card.
|
|
990
|
+
*
|
|
991
|
+
* Scope: `knowledge:read`.
|
|
992
|
+
*/
|
|
993
|
+
getKnowledgeContact(options) {
|
|
994
|
+
return (options.client ?? this.client).get({
|
|
995
|
+
responseStyle: 'data',
|
|
996
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
997
|
+
url: '/knowledge/contacts/{knowledge_contact_id}',
|
|
998
|
+
...options
|
|
999
|
+
});
|
|
1000
|
+
}
|
|
1001
|
+
/**
|
|
1002
|
+
* Update a directory contact
|
|
1003
|
+
*
|
|
1004
|
+
* Changes only the fields in the body.
|
|
1005
|
+
*
|
|
1006
|
+
* Scope: `knowledge:write`.
|
|
1007
|
+
*/
|
|
1008
|
+
updateKnowledgeContact(options) {
|
|
1009
|
+
return (options.client ?? this.client).patch({
|
|
1010
|
+
responseStyle: 'data',
|
|
1011
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1012
|
+
url: '/knowledge/contacts/{knowledge_contact_id}',
|
|
1013
|
+
...options,
|
|
1014
|
+
headers: {
|
|
1015
|
+
'Content-Type': 'application/json',
|
|
1016
|
+
...options.headers
|
|
1017
|
+
}
|
|
1018
|
+
});
|
|
1019
|
+
}
|
|
1020
|
+
/**
|
|
1021
|
+
* List files
|
|
1022
|
+
*
|
|
1023
|
+
* Documents and images the agents can consult or send, newest first.
|
|
1024
|
+
*
|
|
1025
|
+
* Scope: `knowledge:read`.
|
|
1026
|
+
*/
|
|
1027
|
+
listKnowledgeFiles(options) {
|
|
1028
|
+
return (options?.client ?? this.client).get({
|
|
1029
|
+
responseStyle: 'data',
|
|
1030
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1031
|
+
url: '/knowledge/files',
|
|
1032
|
+
...options
|
|
1033
|
+
});
|
|
1034
|
+
}
|
|
1035
|
+
/**
|
|
1036
|
+
* Upload a file
|
|
1037
|
+
*
|
|
1038
|
+
* 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`.
|
|
1039
|
+
*
|
|
1040
|
+
* Scope: `knowledge:write`.
|
|
1041
|
+
*/
|
|
1042
|
+
createKnowledgeFile(options) {
|
|
1043
|
+
return (options.client ?? this.client).post({
|
|
1044
|
+
responseStyle: 'data',
|
|
1045
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1046
|
+
url: '/knowledge/files',
|
|
1047
|
+
...options,
|
|
1048
|
+
headers: {
|
|
1049
|
+
'Content-Type': 'application/json',
|
|
1050
|
+
...options.headers
|
|
1051
|
+
}
|
|
1052
|
+
});
|
|
1053
|
+
}
|
|
1054
|
+
/**
|
|
1055
|
+
* Complete an upload
|
|
1056
|
+
*
|
|
1057
|
+
* 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.
|
|
1058
|
+
*
|
|
1059
|
+
* Scope: `knowledge:write`.
|
|
1060
|
+
*/
|
|
1061
|
+
completeKnowledgeFile(options) {
|
|
1062
|
+
return (options.client ?? this.client).post({
|
|
1063
|
+
responseStyle: 'data',
|
|
1064
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1065
|
+
url: '/knowledge/files/{file_id}/complete',
|
|
1066
|
+
...options,
|
|
1067
|
+
headers: {
|
|
1068
|
+
'Content-Type': 'application/json',
|
|
1069
|
+
...options.headers
|
|
1070
|
+
}
|
|
1071
|
+
});
|
|
1072
|
+
}
|
|
1073
|
+
/**
|
|
1074
|
+
* Delete a file
|
|
1075
|
+
*
|
|
1076
|
+
* Deletes it for good and answers it as it was. Copies already sent in conversations stay there.
|
|
1077
|
+
*
|
|
1078
|
+
* Scope: `knowledge:write`.
|
|
1079
|
+
*/
|
|
1080
|
+
deleteKnowledgeFile(options) {
|
|
1081
|
+
return (options.client ?? this.client).delete({
|
|
1082
|
+
responseStyle: 'data',
|
|
1083
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1084
|
+
url: '/knowledge/files/{file_id}',
|
|
1085
|
+
...options
|
|
1086
|
+
});
|
|
1087
|
+
}
|
|
1088
|
+
/**
|
|
1089
|
+
* Get a file
|
|
1090
|
+
*
|
|
1091
|
+
* One file; a `ready` one carries a `download_url`.
|
|
1092
|
+
*
|
|
1093
|
+
* Scope: `knowledge:read`.
|
|
1094
|
+
*/
|
|
1095
|
+
getKnowledgeFile(options) {
|
|
1096
|
+
return (options.client ?? this.client).get({
|
|
1097
|
+
responseStyle: 'data',
|
|
1098
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1099
|
+
url: '/knowledge/files/{file_id}',
|
|
1100
|
+
...options
|
|
1101
|
+
});
|
|
1102
|
+
}
|
|
1103
|
+
/**
|
|
1104
|
+
* Update a file
|
|
1105
|
+
*
|
|
1106
|
+
* Changes its title, description or what the agents may do with it. Only a `ready` file changes; otherwise `409 conflict`.
|
|
1107
|
+
*
|
|
1108
|
+
* Scope: `knowledge:write`.
|
|
1109
|
+
*/
|
|
1110
|
+
updateKnowledgeFile(options) {
|
|
1111
|
+
return (options.client ?? this.client).patch({
|
|
1112
|
+
responseStyle: 'data',
|
|
1113
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1114
|
+
url: '/knowledge/files/{file_id}',
|
|
1115
|
+
...options,
|
|
1116
|
+
headers: {
|
|
1117
|
+
'Content-Type': 'application/json',
|
|
1118
|
+
...options.headers
|
|
1119
|
+
}
|
|
1120
|
+
});
|
|
1121
|
+
}
|
|
737
1122
|
}
|