getricky 0.1.3 → 0.1.5
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 +20 -0
- package/dist/cjs/generated/index.d.ts +1 -1
- package/dist/cjs/generated/sdk.gen.d.ts +298 -2
- package/dist/cjs/generated/sdk.gen.js +620 -1
- package/dist/cjs/generated/types.gen.d.ts +3689 -826
- package/dist/esm/generated/idempotency.gen.js +20 -0
- package/dist/esm/generated/index.d.ts +1 -1
- package/dist/esm/generated/sdk.gen.d.ts +298 -2
- package/dist/esm/generated/sdk.gen.js +620 -1
- package/dist/esm/generated/types.gen.d.ts +3689 -826
- package/package.json +1 -1
|
@@ -1,15 +1,35 @@
|
|
|
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
|
+
'DELETE /contact-fields/{field_id}',
|
|
5
|
+
'DELETE /quick-replies/{quick_reply_id}',
|
|
6
|
+
'DELETE /tags/{tag_id}',
|
|
7
|
+
'PATCH /agents/{agent_id}',
|
|
4
8
|
'PATCH /contacts/{contact_id}',
|
|
9
|
+
'PATCH /conversations/{conversation_id}/agent',
|
|
5
10
|
'PATCH /conversations/{conversation_id}/assignment',
|
|
11
|
+
'PATCH /conversations/{conversation_id}/tags',
|
|
12
|
+
'PATCH /knowledge/contacts/{knowledge_contact_id}',
|
|
13
|
+
'PATCH /knowledge/files/{file_id}',
|
|
14
|
+
'PATCH /knowledge/locations/{location_id}',
|
|
15
|
+
'PATCH /quick-replies/{quick_reply_id}',
|
|
16
|
+
'PATCH /tags/{tag_id}',
|
|
6
17
|
'PATCH /workflows/{workflow_id}',
|
|
18
|
+
'POST /agents',
|
|
19
|
+
'POST /contact-fields',
|
|
7
20
|
'POST /contacts',
|
|
21
|
+
'POST /contacts/tags',
|
|
8
22
|
'POST /contacts/{contact_id}/notes',
|
|
9
23
|
'POST /conversations',
|
|
10
24
|
'POST /conversations/{conversation_id}/close',
|
|
11
25
|
'POST /conversations/{conversation_id}/messages',
|
|
26
|
+
'POST /conversations/{conversation_id}/read',
|
|
12
27
|
'POST /conversations/{conversation_id}/reopen',
|
|
28
|
+
'POST /knowledge/contacts',
|
|
29
|
+
'POST /knowledge/files',
|
|
30
|
+
'POST /knowledge/files/{file_id}/complete',
|
|
31
|
+
'POST /knowledge/locations',
|
|
32
|
+
'POST /quick-replies',
|
|
13
33
|
'POST /tags',
|
|
14
34
|
'POST /workflows',
|
|
15
35
|
]);
|
|
@@ -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, ChangeContactsTags, ChangeContactsTagsData, ChangeContactsTagsError, ChangeContactsTagsErrors, ChangeContactsTagsResponse, ChangeContactsTagsResponses, ChangeConversationTags, ChangeConversationTagsData, ChangeConversationTagsError, ChangeConversationTagsErrors, ChangeConversationTagsResponse, ChangeConversationTagsResponses, Channel, ClientOptions, CloseConversation, CloseConversationData, CloseConversationError, CloseConversationErrors, CloseConversationResponse, CloseConversationResponses, CompleteKnowledgeFile, CompleteKnowledgeFileData, CompleteKnowledgeFileError, CompleteKnowledgeFileErrors, CompleteKnowledgeFileResponse, CompleteKnowledgeFileResponses, Contact, ContactField, ContactIdentity, ContactTagChange, Conversation, ConversationsReport, CreateAgent, CreateAgentData, CreateAgentError, CreateAgentErrors, CreateAgentResponse, CreateAgentResponses, CreateContact, CreateContactData, CreateContactError, CreateContactErrors, CreateContactField, CreateContactFieldData, CreateContactFieldError, CreateContactFieldErrors, CreateContactFieldResponse, CreateContactFieldResponses, CreateContactResponse, CreateContactResponses, CreatedWebhook, CreateKnowledgeContact, CreateKnowledgeContactData, CreateKnowledgeContactError, CreateKnowledgeContactErrors, CreateKnowledgeContactResponse, CreateKnowledgeContactResponses, CreateKnowledgeFile, CreateKnowledgeFileData, CreateKnowledgeFileError, CreateKnowledgeFileErrors, CreateKnowledgeFileResponse, CreateKnowledgeFileResponses, CreateKnowledgeLocation, CreateKnowledgeLocationData, CreateKnowledgeLocationError, CreateKnowledgeLocationErrors, CreateKnowledgeLocationResponse, CreateKnowledgeLocationResponses, CreateQuickReply, CreateQuickReplyData, CreateQuickReplyError, CreateQuickReplyErrors, CreateQuickReplyResponse, CreateQuickReplyResponses, CreateTag, CreateTagData, CreateTagError, CreateTagErrors, CreateTagResponse, CreateTagResponses, CreateWebhook, CreateWebhookData, CreateWebhookError, CreateWebhookErrors, CreateWebhookResponse, CreateWebhookResponses, CreateWorkflow, CreateWorkflowData, CreateWorkflowError, CreateWorkflowErrors, CreateWorkflowResponse, CreateWorkflowResponses, DashboardReport, DeleteContactFieldData, DeleteContactFieldError, DeleteContactFieldErrors, DeleteContactFieldResponse, DeleteContactFieldResponses, DeleteKnowledgeContactData, DeleteKnowledgeContactError, DeleteKnowledgeContactErrors, DeleteKnowledgeContactResponse, DeleteKnowledgeContactResponses, DeleteKnowledgeFileData, DeleteKnowledgeFileError, DeleteKnowledgeFileErrors, DeleteKnowledgeFileResponse, DeleteKnowledgeFileResponses, DeleteKnowledgeLocationData, DeleteKnowledgeLocationError, DeleteKnowledgeLocationErrors, DeleteKnowledgeLocationResponse, DeleteKnowledgeLocationResponses, DeleteQuickReplyData, DeleteQuickReplyError, DeleteQuickReplyErrors, DeleteQuickReplyResponse, DeleteQuickReplyResponses, DeleteTagData, DeleteTagError, DeleteTagErrors, DeleteTagResponse, DeleteTagResponses, 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, GetQuickReplyData, GetQuickReplyError, GetQuickReplyErrors, GetQuickReplyResponse, GetQuickReplyResponses, 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, ListQuickRepliesData, ListQuickRepliesError, ListQuickRepliesErrors, ListQuickRepliesResponse, ListQuickRepliesResponses, 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, MarkConversationReadData, MarkConversationReadError, MarkConversationReadErrors, MarkConversationReadResponse, MarkConversationReadResponses, MediaMessage, Member, Message, MessageSearchResult, MessagesReport, PauseWorkflowData, PauseWorkflowError, PauseWorkflowErrors, PauseWorkflowResponse, PauseWorkflowResponses, QuickReply, ReopenConversationData, ReopenConversationError, ReopenConversationErrors, ReopenConversationResponse, ReopenConversationResponses, ReportPeriod, ResolutionsReport, ResponsesReport, RetryWebhookDeliveryData, RetryWebhookDeliveryError, RetryWebhookDeliveryErrors, RetryWebhookDeliveryResponse, RetryWebhookDeliveryResponses, RotateWebhookSecret, RotateWebhookSecretData, RotateWebhookSecretError, RotateWebhookSecretErrors, RotateWebhookSecretResponse, RotateWebhookSecretResponses, SearchConversationsData, SearchConversationsError, SearchConversationsErrors, SearchConversationsResponse, SearchConversationsResponses, SearchMessagesData, SearchMessagesError, SearchMessagesErrors, SearchMessagesResponse, SearchMessagesResponses, 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, UpdateQuickReply, UpdateQuickReplyData, UpdateQuickReplyError, UpdateQuickReplyErrors, UpdateQuickReplyResponse, UpdateQuickReplyResponses, UpdateTag, UpdateTagData, UpdateTagError, UpdateTagErrors, UpdateTagResponse, UpdateTagResponses, 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, ChangeContactsTagsData, ChangeContactsTagsErrors, ChangeContactsTagsResponses, ChangeConversationTagsData, ChangeConversationTagsErrors, ChangeConversationTagsResponses, CloseConversationData, CloseConversationErrors, CloseConversationResponses, CompleteKnowledgeFileData, CompleteKnowledgeFileErrors, CompleteKnowledgeFileResponses, CreateAgentData, CreateAgentErrors, CreateAgentResponses, CreateContactData, CreateContactErrors, CreateContactFieldData, CreateContactFieldErrors, CreateContactFieldResponses, CreateContactResponses, CreateKnowledgeContactData, CreateKnowledgeContactErrors, CreateKnowledgeContactResponses, CreateKnowledgeFileData, CreateKnowledgeFileErrors, CreateKnowledgeFileResponses, CreateKnowledgeLocationData, CreateKnowledgeLocationErrors, CreateKnowledgeLocationResponses, CreateQuickReplyData, CreateQuickReplyErrors, CreateQuickReplyResponses, CreateTagData, CreateTagErrors, CreateTagResponses, CreateWebhookData, CreateWebhookErrors, CreateWebhookResponses, CreateWorkflowData, CreateWorkflowErrors, CreateWorkflowResponses, DeleteContactFieldData, DeleteContactFieldErrors, DeleteContactFieldResponses, DeleteKnowledgeContactData, DeleteKnowledgeContactErrors, DeleteKnowledgeContactResponses, DeleteKnowledgeFileData, DeleteKnowledgeFileErrors, DeleteKnowledgeFileResponses, DeleteKnowledgeLocationData, DeleteKnowledgeLocationErrors, DeleteKnowledgeLocationResponses, DeleteQuickReplyData, DeleteQuickReplyErrors, DeleteQuickReplyResponses, DeleteTagData, DeleteTagErrors, DeleteTagResponses, 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, GetQuickReplyData, GetQuickReplyErrors, GetQuickReplyResponses, 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, ListQuickRepliesData, ListQuickRepliesErrors, ListQuickRepliesResponses, ListTagsData, ListTagsErrors, ListTagsResponses, ListTemplatesData, ListTemplatesErrors, ListTemplatesResponses, ListWebhookDeliveriesData, ListWebhookDeliveriesErrors, ListWebhookDeliveriesResponses, ListWebhooksData, ListWebhooksErrors, ListWebhooksResponses, ListWorkflowExecutionsData, ListWorkflowExecutionsErrors, ListWorkflowExecutionsResponses, ListWorkflowsData, ListWorkflowsErrors, ListWorkflowsResponses, MarkConversationReadData, MarkConversationReadErrors, MarkConversationReadResponses, PauseWorkflowData, PauseWorkflowErrors, PauseWorkflowResponses, ReopenConversationData, ReopenConversationErrors, ReopenConversationResponses, RetryWebhookDeliveryData, RetryWebhookDeliveryErrors, RetryWebhookDeliveryResponses, RotateWebhookSecretData, RotateWebhookSecretErrors, RotateWebhookSecretResponses, SearchConversationsData, SearchConversationsErrors, SearchConversationsResponses, SearchMessagesData, SearchMessagesErrors, SearchMessagesResponses, SendMessageData, SendMessageErrors, SendMessageResponses, StartConversationData, StartConversationErrors, StartConversationResponses, TestWebhookData, TestWebhookErrors, TestWebhookResponses, UpdateAgentData, UpdateAgentErrors, UpdateAgentResponses, UpdateContactData, UpdateContactErrors, UpdateContactResponses, UpdateKnowledgeContactData, UpdateKnowledgeContactErrors, UpdateKnowledgeContactResponses, UpdateKnowledgeFileData, UpdateKnowledgeFileErrors, UpdateKnowledgeFileResponses, UpdateKnowledgeLocationData, UpdateKnowledgeLocationErrors, UpdateKnowledgeLocationResponses, UpdateQuickReplyData, UpdateQuickReplyErrors, UpdateQuickReplyResponses, UpdateTagData, UpdateTagErrors, UpdateTagResponses, 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
|
|
@@ -79,6 +79,14 @@ export declare class RickyApi extends HeyApiClient {
|
|
|
79
79
|
* Scope: `contacts:read`.
|
|
80
80
|
*/
|
|
81
81
|
listContactFields<ThrowOnError extends boolean = true>(options?: Options<ListContactFieldsData, ThrowOnError>): RequestResult<ListContactFieldsResponses, ListContactFieldsErrors, ThrowOnError, 'data'>;
|
|
82
|
+
/**
|
|
83
|
+
* Create a contact field
|
|
84
|
+
*
|
|
85
|
+
* Adds a custom field to every contact, after the existing ones. A name already in use, in any case, answers `409 conflict`.
|
|
86
|
+
*
|
|
87
|
+
* Scope: `contacts:write`.
|
|
88
|
+
*/
|
|
89
|
+
createContactField<ThrowOnError extends boolean = true>(options: Options<CreateContactFieldData, ThrowOnError>): RequestResult<CreateContactFieldResponses, CreateContactFieldErrors, ThrowOnError, 'data'>;
|
|
82
90
|
/**
|
|
83
91
|
* List conversations
|
|
84
92
|
*
|
|
@@ -188,7 +196,7 @@ export declare class RickyApi extends HeyApiClient {
|
|
|
188
196
|
*
|
|
189
197
|
* Creates a contact tag. Apply it with `tag_ids` on a contact. A name already in use, in any case, answers `409 conflict`.
|
|
190
198
|
*
|
|
191
|
-
* Scope: `contacts:write`.
|
|
199
|
+
* Scope: `tags:write` or, on older keys, `contacts:write`.
|
|
192
200
|
*/
|
|
193
201
|
createTag<ThrowOnError extends boolean = true>(options: Options<CreateTagData, ThrowOnError>): RequestResult<CreateTagResponses, CreateTagErrors, ThrowOnError, 'data'>;
|
|
194
202
|
/**
|
|
@@ -383,5 +391,293 @@ export declare class RickyApi extends HeyApiClient {
|
|
|
383
391
|
* Scope: `reports:read`.
|
|
384
392
|
*/
|
|
385
393
|
getAdsReport<ThrowOnError extends boolean = true>(options?: Options<GetAdsReportData, ThrowOnError>): RequestResult<GetAdsReportResponses, GetAdsReportErrors, ThrowOnError, 'data'>;
|
|
394
|
+
/**
|
|
395
|
+
* List agents
|
|
396
|
+
*
|
|
397
|
+
* Active agents, newest first. Archived agents are not listed.
|
|
398
|
+
*
|
|
399
|
+
* Scope: `agents:read`.
|
|
400
|
+
*/
|
|
401
|
+
listAgents<ThrowOnError extends boolean = true>(options?: Options<ListAgentsData, ThrowOnError>): RequestResult<ListAgentsResponses, ListAgentsErrors, ThrowOnError, 'data'>;
|
|
402
|
+
/**
|
|
403
|
+
* Create an agent
|
|
404
|
+
*
|
|
405
|
+
* 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.
|
|
406
|
+
*
|
|
407
|
+
* Scope: `agents:write`.
|
|
408
|
+
*/
|
|
409
|
+
createAgent<ThrowOnError extends boolean = true>(options: Options<CreateAgentData, ThrowOnError>): RequestResult<CreateAgentResponses, CreateAgentErrors, ThrowOnError, 'data'>;
|
|
410
|
+
/**
|
|
411
|
+
* Archive an agent
|
|
412
|
+
*
|
|
413
|
+
* 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`.
|
|
414
|
+
*
|
|
415
|
+
* Scope: `agents:write`.
|
|
416
|
+
*/
|
|
417
|
+
archiveAgent<ThrowOnError extends boolean = true>(options: Options<ArchiveAgentData, ThrowOnError>): RequestResult<ArchiveAgentResponses, ArchiveAgentErrors, ThrowOnError, 'data'>;
|
|
418
|
+
/**
|
|
419
|
+
* Get an agent
|
|
420
|
+
*
|
|
421
|
+
* One active agent with its full settings.
|
|
422
|
+
*
|
|
423
|
+
* Scope: `agents:read`.
|
|
424
|
+
*/
|
|
425
|
+
getAgent<ThrowOnError extends boolean = true>(options: Options<GetAgentData, ThrowOnError>): RequestResult<GetAgentResponses, GetAgentErrors, ThrowOnError, 'data'>;
|
|
426
|
+
/**
|
|
427
|
+
* Update an agent
|
|
428
|
+
*
|
|
429
|
+
* Changes only the fields in the body. `capabilities` and `handoff_user_ids` replace their whole sets.
|
|
430
|
+
*
|
|
431
|
+
* Scope: `agents:write`.
|
|
432
|
+
*/
|
|
433
|
+
updateAgent<ThrowOnError extends boolean = true>(options: Options<UpdateAgentData, ThrowOnError>): RequestResult<UpdateAgentResponses, UpdateAgentErrors, ThrowOnError, 'data'>;
|
|
434
|
+
/**
|
|
435
|
+
* Get agent options
|
|
436
|
+
*
|
|
437
|
+
* The models, voices and capabilities an agent can be configured with.
|
|
438
|
+
*
|
|
439
|
+
* Scope: `agents:read`.
|
|
440
|
+
*/
|
|
441
|
+
getAgentOptions<ThrowOnError extends boolean = true>(options?: Options<GetAgentOptionsData, ThrowOnError>): RequestResult<GetAgentOptionsResponses, GetAgentOptionsErrors, ThrowOnError, 'data'>;
|
|
442
|
+
/**
|
|
443
|
+
* Set the AI agent of a conversation
|
|
444
|
+
*
|
|
445
|
+
* 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.
|
|
446
|
+
*
|
|
447
|
+
* Scope: `conversations:write`.
|
|
448
|
+
*/
|
|
449
|
+
assignConversationAgent<ThrowOnError extends boolean = true>(options: Options<AssignConversationAgentData, ThrowOnError>): RequestResult<AssignConversationAgentResponses, AssignConversationAgentErrors, ThrowOnError, 'data'>;
|
|
450
|
+
/**
|
|
451
|
+
* List locations
|
|
452
|
+
*
|
|
453
|
+
* Branches and places, newest first.
|
|
454
|
+
*
|
|
455
|
+
* Scope: `knowledge:read`.
|
|
456
|
+
*/
|
|
457
|
+
listKnowledgeLocations<ThrowOnError extends boolean = true>(options?: Options<ListKnowledgeLocationsData, ThrowOnError>): RequestResult<ListKnowledgeLocationsResponses, ListKnowledgeLocationsErrors, ThrowOnError, 'data'>;
|
|
458
|
+
/**
|
|
459
|
+
* Create a location
|
|
460
|
+
*
|
|
461
|
+
* Adds a branch or place the agents can share.
|
|
462
|
+
*
|
|
463
|
+
* Scope: `knowledge:write`.
|
|
464
|
+
*/
|
|
465
|
+
createKnowledgeLocation<ThrowOnError extends boolean = true>(options: Options<CreateKnowledgeLocationData, ThrowOnError>): RequestResult<CreateKnowledgeLocationResponses, CreateKnowledgeLocationErrors, ThrowOnError, 'data'>;
|
|
466
|
+
/**
|
|
467
|
+
* Delete a location
|
|
468
|
+
*
|
|
469
|
+
* Deletes it for good and answers it as it was.
|
|
470
|
+
*
|
|
471
|
+
* Scope: `knowledge:write`.
|
|
472
|
+
*/
|
|
473
|
+
deleteKnowledgeLocation<ThrowOnError extends boolean = true>(options: Options<DeleteKnowledgeLocationData, ThrowOnError>): RequestResult<DeleteKnowledgeLocationResponses, DeleteKnowledgeLocationErrors, ThrowOnError, 'data'>;
|
|
474
|
+
/**
|
|
475
|
+
* Get a location
|
|
476
|
+
*
|
|
477
|
+
* One location.
|
|
478
|
+
*
|
|
479
|
+
* Scope: `knowledge:read`.
|
|
480
|
+
*/
|
|
481
|
+
getKnowledgeLocation<ThrowOnError extends boolean = true>(options: Options<GetKnowledgeLocationData, ThrowOnError>): RequestResult<GetKnowledgeLocationResponses, GetKnowledgeLocationErrors, ThrowOnError, 'data'>;
|
|
482
|
+
/**
|
|
483
|
+
* Update a location
|
|
484
|
+
*
|
|
485
|
+
* Changes only the fields in the body.
|
|
486
|
+
*
|
|
487
|
+
* Scope: `knowledge:write`.
|
|
488
|
+
*/
|
|
489
|
+
updateKnowledgeLocation<ThrowOnError extends boolean = true>(options: Options<UpdateKnowledgeLocationData, ThrowOnError>): RequestResult<UpdateKnowledgeLocationResponses, UpdateKnowledgeLocationErrors, ThrowOnError, 'data'>;
|
|
490
|
+
/**
|
|
491
|
+
* List directory contacts
|
|
492
|
+
*
|
|
493
|
+
* Contact cards of the knowledge directory, by display name. These are not CRM contacts.
|
|
494
|
+
*
|
|
495
|
+
* Scope: `knowledge:read`.
|
|
496
|
+
*/
|
|
497
|
+
listKnowledgeContacts<ThrowOnError extends boolean = true>(options?: Options<ListKnowledgeContactsData, ThrowOnError>): RequestResult<ListKnowledgeContactsResponses, ListKnowledgeContactsErrors, ThrowOnError, 'data'>;
|
|
498
|
+
/**
|
|
499
|
+
* Create a directory contact
|
|
500
|
+
*
|
|
501
|
+
* Adds a contact card the agents can send to customers.
|
|
502
|
+
*
|
|
503
|
+
* Scope: `knowledge:write`.
|
|
504
|
+
*/
|
|
505
|
+
createKnowledgeContact<ThrowOnError extends boolean = true>(options: Options<CreateKnowledgeContactData, ThrowOnError>): RequestResult<CreateKnowledgeContactResponses, CreateKnowledgeContactErrors, ThrowOnError, 'data'>;
|
|
506
|
+
/**
|
|
507
|
+
* Delete a directory contact
|
|
508
|
+
*
|
|
509
|
+
* Deletes it for good and answers it as it was.
|
|
510
|
+
*
|
|
511
|
+
* Scope: `knowledge:write`.
|
|
512
|
+
*/
|
|
513
|
+
deleteKnowledgeContact<ThrowOnError extends boolean = true>(options: Options<DeleteKnowledgeContactData, ThrowOnError>): RequestResult<DeleteKnowledgeContactResponses, DeleteKnowledgeContactErrors, ThrowOnError, 'data'>;
|
|
514
|
+
/**
|
|
515
|
+
* Get a directory contact
|
|
516
|
+
*
|
|
517
|
+
* One contact card.
|
|
518
|
+
*
|
|
519
|
+
* Scope: `knowledge:read`.
|
|
520
|
+
*/
|
|
521
|
+
getKnowledgeContact<ThrowOnError extends boolean = true>(options: Options<GetKnowledgeContactData, ThrowOnError>): RequestResult<GetKnowledgeContactResponses, GetKnowledgeContactErrors, ThrowOnError, 'data'>;
|
|
522
|
+
/**
|
|
523
|
+
* Update a directory contact
|
|
524
|
+
*
|
|
525
|
+
* Changes only the fields in the body.
|
|
526
|
+
*
|
|
527
|
+
* Scope: `knowledge:write`.
|
|
528
|
+
*/
|
|
529
|
+
updateKnowledgeContact<ThrowOnError extends boolean = true>(options: Options<UpdateKnowledgeContactData, ThrowOnError>): RequestResult<UpdateKnowledgeContactResponses, UpdateKnowledgeContactErrors, ThrowOnError, 'data'>;
|
|
530
|
+
/**
|
|
531
|
+
* List files
|
|
532
|
+
*
|
|
533
|
+
* Documents and images the agents can consult or send, newest first.
|
|
534
|
+
*
|
|
535
|
+
* Scope: `knowledge:read`.
|
|
536
|
+
*/
|
|
537
|
+
listKnowledgeFiles<ThrowOnError extends boolean = true>(options?: Options<ListKnowledgeFilesData, ThrowOnError>): RequestResult<ListKnowledgeFilesResponses, ListKnowledgeFilesErrors, ThrowOnError, 'data'>;
|
|
538
|
+
/**
|
|
539
|
+
* Upload a file
|
|
540
|
+
*
|
|
541
|
+
* 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`.
|
|
542
|
+
*
|
|
543
|
+
* Scope: `knowledge:write`.
|
|
544
|
+
*/
|
|
545
|
+
createKnowledgeFile<ThrowOnError extends boolean = true>(options: Options<CreateKnowledgeFileData, ThrowOnError>): RequestResult<CreateKnowledgeFileResponses, CreateKnowledgeFileErrors, ThrowOnError, 'data'>;
|
|
546
|
+
/**
|
|
547
|
+
* Complete an upload
|
|
548
|
+
*
|
|
549
|
+
* 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.
|
|
550
|
+
*
|
|
551
|
+
* Scope: `knowledge:write`.
|
|
552
|
+
*/
|
|
553
|
+
completeKnowledgeFile<ThrowOnError extends boolean = true>(options: Options<CompleteKnowledgeFileData, ThrowOnError>): RequestResult<CompleteKnowledgeFileResponses, CompleteKnowledgeFileErrors, ThrowOnError, 'data'>;
|
|
554
|
+
/**
|
|
555
|
+
* Delete a file
|
|
556
|
+
*
|
|
557
|
+
* Deletes it for good and answers it as it was. Copies already sent in conversations stay there.
|
|
558
|
+
*
|
|
559
|
+
* Scope: `knowledge:write`.
|
|
560
|
+
*/
|
|
561
|
+
deleteKnowledgeFile<ThrowOnError extends boolean = true>(options: Options<DeleteKnowledgeFileData, ThrowOnError>): RequestResult<DeleteKnowledgeFileResponses, DeleteKnowledgeFileErrors, ThrowOnError, 'data'>;
|
|
562
|
+
/**
|
|
563
|
+
* Get a file
|
|
564
|
+
*
|
|
565
|
+
* One file; a `ready` one carries a `download_url`.
|
|
566
|
+
*
|
|
567
|
+
* Scope: `knowledge:read`.
|
|
568
|
+
*/
|
|
569
|
+
getKnowledgeFile<ThrowOnError extends boolean = true>(options: Options<GetKnowledgeFileData, ThrowOnError>): RequestResult<GetKnowledgeFileResponses, GetKnowledgeFileErrors, ThrowOnError, 'data'>;
|
|
570
|
+
/**
|
|
571
|
+
* Update a file
|
|
572
|
+
*
|
|
573
|
+
* Changes its title, description or what the agents may do with it. Only a `ready` file changes; otherwise `409 conflict`.
|
|
574
|
+
*
|
|
575
|
+
* Scope: `knowledge:write`.
|
|
576
|
+
*/
|
|
577
|
+
updateKnowledgeFile<ThrowOnError extends boolean = true>(options: Options<UpdateKnowledgeFileData, ThrowOnError>): RequestResult<UpdateKnowledgeFileResponses, UpdateKnowledgeFileErrors, ThrowOnError, 'data'>;
|
|
578
|
+
/**
|
|
579
|
+
* Change tags on many contacts
|
|
580
|
+
*
|
|
581
|
+
* Adds and removes the same tags on up to 100 contacts and answers one result per contact, in order. A tag ID the organization does not have refuses the whole request before any contact changes.
|
|
582
|
+
*
|
|
583
|
+
* Scope: `contacts:write`.
|
|
584
|
+
*/
|
|
585
|
+
changeContactsTags<ThrowOnError extends boolean = true>(options: Options<ChangeContactsTagsData, ThrowOnError>): RequestResult<ChangeContactsTagsResponses, ChangeContactsTagsErrors, ThrowOnError, 'data'>;
|
|
586
|
+
/**
|
|
587
|
+
* Delete a contact field
|
|
588
|
+
*
|
|
589
|
+
* Deletes the field and its value on every contact, and answers the field as it was. It cannot be undone.
|
|
590
|
+
*
|
|
591
|
+
* Scope: `contacts:write`.
|
|
592
|
+
*/
|
|
593
|
+
deleteContactField<ThrowOnError extends boolean = true>(options: Options<DeleteContactFieldData, ThrowOnError>): RequestResult<DeleteContactFieldResponses, DeleteContactFieldErrors, ThrowOnError, 'data'>;
|
|
594
|
+
/**
|
|
595
|
+
* Delete a tag
|
|
596
|
+
*
|
|
597
|
+
* Deletes the tag and removes it from every contact, and answers the tag as it was. It cannot be undone.
|
|
598
|
+
*
|
|
599
|
+
* Scope: `tags:write`.
|
|
600
|
+
*/
|
|
601
|
+
deleteTag<ThrowOnError extends boolean = true>(options: Options<DeleteTagData, ThrowOnError>): RequestResult<DeleteTagResponses, DeleteTagErrors, ThrowOnError, 'data'>;
|
|
602
|
+
/**
|
|
603
|
+
* Update a tag
|
|
604
|
+
*
|
|
605
|
+
* Renames or recolors a tag on every contact that has it. A name already in use, in any case, answers `409 conflict`.
|
|
606
|
+
*
|
|
607
|
+
* Scope: `tags:write`.
|
|
608
|
+
*/
|
|
609
|
+
updateTag<ThrowOnError extends boolean = true>(options: Options<UpdateTagData, ThrowOnError>): RequestResult<UpdateTagResponses, UpdateTagErrors, ThrowOnError, 'data'>;
|
|
610
|
+
/**
|
|
611
|
+
* Search conversations
|
|
612
|
+
*
|
|
613
|
+
* Conversations whose contact or messages contain the text, latest activity first. Answers one page of at most `limit`; `next_cursor` is always null.
|
|
614
|
+
*
|
|
615
|
+
* Scope: `conversations:read`.
|
|
616
|
+
*/
|
|
617
|
+
searchConversations<ThrowOnError extends boolean = true>(options: Options<SearchConversationsData, ThrowOnError>): RequestResult<SearchConversationsResponses, SearchConversationsErrors, ThrowOnError, 'data'>;
|
|
618
|
+
/**
|
|
619
|
+
* Change a conversation's tags
|
|
620
|
+
*
|
|
621
|
+
* Tags belong to the conversation's contact: this adds and removes tags on it and answers the contact.
|
|
622
|
+
*
|
|
623
|
+
* Scope: `contacts:write`.
|
|
624
|
+
*/
|
|
625
|
+
changeConversationTags<ThrowOnError extends boolean = true>(options: Options<ChangeConversationTagsData, ThrowOnError>): RequestResult<ChangeConversationTagsResponses, ChangeConversationTagsErrors, ThrowOnError, 'data'>;
|
|
626
|
+
/**
|
|
627
|
+
* Mark a conversation read
|
|
628
|
+
*
|
|
629
|
+
* Marks it read for the whole team through its latest message, as opening it in the inbox does. On WhatsApp the contact sees the read receipt. Send no body.
|
|
630
|
+
*
|
|
631
|
+
* Scope: `conversations:write`.
|
|
632
|
+
*/
|
|
633
|
+
markConversationRead<ThrowOnError extends boolean = true>(options: Options<MarkConversationReadData, ThrowOnError>): RequestResult<MarkConversationReadResponses, MarkConversationReadErrors, ThrowOnError, 'data'>;
|
|
634
|
+
/**
|
|
635
|
+
* Search messages
|
|
636
|
+
*
|
|
637
|
+
* Messages of every conversation that contain the words, newest first. Answers one page of at most `limit`; `next_cursor` is always null.
|
|
638
|
+
*
|
|
639
|
+
* Scope: `conversations:read`.
|
|
640
|
+
*/
|
|
641
|
+
searchMessages<ThrowOnError extends boolean = true>(options: Options<SearchMessagesData, ThrowOnError>): RequestResult<SearchMessagesResponses, SearchMessagesErrors, ThrowOnError, 'data'>;
|
|
642
|
+
/**
|
|
643
|
+
* List quick replies
|
|
644
|
+
*
|
|
645
|
+
* Every quick reply of the organization, by title.
|
|
646
|
+
*
|
|
647
|
+
* Scope: `quick_replies:read`.
|
|
648
|
+
*/
|
|
649
|
+
listQuickReplies<ThrowOnError extends boolean = true>(options?: Options<ListQuickRepliesData, ThrowOnError>): RequestResult<ListQuickRepliesResponses, ListQuickRepliesErrors, ThrowOnError, 'data'>;
|
|
650
|
+
/**
|
|
651
|
+
* Create a quick reply
|
|
652
|
+
*
|
|
653
|
+
* Saves an answer operators can insert in the inbox. A title already in use, in any case, answers `409 conflict`.
|
|
654
|
+
*
|
|
655
|
+
* Scope: `quick_replies:write`.
|
|
656
|
+
*/
|
|
657
|
+
createQuickReply<ThrowOnError extends boolean = true>(options: Options<CreateQuickReplyData, ThrowOnError>): RequestResult<CreateQuickReplyResponses, CreateQuickReplyErrors, ThrowOnError, 'data'>;
|
|
658
|
+
/**
|
|
659
|
+
* Delete a quick reply
|
|
660
|
+
*
|
|
661
|
+
* Deletes it and answers it as it was. It cannot be undone.
|
|
662
|
+
*
|
|
663
|
+
* Scope: `quick_replies:write`.
|
|
664
|
+
*/
|
|
665
|
+
deleteQuickReply<ThrowOnError extends boolean = true>(options: Options<DeleteQuickReplyData, ThrowOnError>): RequestResult<DeleteQuickReplyResponses, DeleteQuickReplyErrors, ThrowOnError, 'data'>;
|
|
666
|
+
/**
|
|
667
|
+
* Get a quick reply
|
|
668
|
+
*
|
|
669
|
+
* One quick reply.
|
|
670
|
+
*
|
|
671
|
+
* Scope: `quick_replies:read`.
|
|
672
|
+
*/
|
|
673
|
+
getQuickReply<ThrowOnError extends boolean = true>(options: Options<GetQuickReplyData, ThrowOnError>): RequestResult<GetQuickReplyResponses, GetQuickReplyErrors, ThrowOnError, 'data'>;
|
|
674
|
+
/**
|
|
675
|
+
* Update a quick reply
|
|
676
|
+
*
|
|
677
|
+
* Changes only the fields in the body. A title already in use, in any case, answers `409 conflict`.
|
|
678
|
+
*
|
|
679
|
+
* Scope: `quick_replies:write`.
|
|
680
|
+
*/
|
|
681
|
+
updateQuickReply<ThrowOnError extends boolean = true>(options: Options<UpdateQuickReplyData, ThrowOnError>): RequestResult<UpdateQuickReplyResponses, UpdateQuickReplyErrors, ThrowOnError, 'data'>;
|
|
386
682
|
}
|
|
387
683
|
export {};
|