getricky 0.1.4 → 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 +10 -0
- package/dist/cjs/generated/index.d.ts +1 -1
- package/dist/cjs/generated/sdk.gen.d.ts +114 -2
- package/dist/cjs/generated/sdk.gen.js +235 -1
- package/dist/cjs/generated/types.gen.d.ts +2774 -1795
- 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 +114 -2
- package/dist/esm/generated/sdk.gen.js +235 -1
- package/dist/esm/generated/types.gen.d.ts +2774 -1795
- package/package.json +1 -1
|
@@ -4,25 +4,35 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
4
4
|
exports.idempotentOperations = void 0;
|
|
5
5
|
/** `METHOD /path/{template}` of every write that accepts an `Idempotency-Key` header. */
|
|
6
6
|
exports.idempotentOperations = new Set([
|
|
7
|
+
'DELETE /contact-fields/{field_id}',
|
|
8
|
+
'DELETE /quick-replies/{quick_reply_id}',
|
|
9
|
+
'DELETE /tags/{tag_id}',
|
|
7
10
|
'PATCH /agents/{agent_id}',
|
|
8
11
|
'PATCH /contacts/{contact_id}',
|
|
9
12
|
'PATCH /conversations/{conversation_id}/agent',
|
|
10
13
|
'PATCH /conversations/{conversation_id}/assignment',
|
|
14
|
+
'PATCH /conversations/{conversation_id}/tags',
|
|
11
15
|
'PATCH /knowledge/contacts/{knowledge_contact_id}',
|
|
12
16
|
'PATCH /knowledge/files/{file_id}',
|
|
13
17
|
'PATCH /knowledge/locations/{location_id}',
|
|
18
|
+
'PATCH /quick-replies/{quick_reply_id}',
|
|
19
|
+
'PATCH /tags/{tag_id}',
|
|
14
20
|
'PATCH /workflows/{workflow_id}',
|
|
15
21
|
'POST /agents',
|
|
22
|
+
'POST /contact-fields',
|
|
16
23
|
'POST /contacts',
|
|
24
|
+
'POST /contacts/tags',
|
|
17
25
|
'POST /contacts/{contact_id}/notes',
|
|
18
26
|
'POST /conversations',
|
|
19
27
|
'POST /conversations/{conversation_id}/close',
|
|
20
28
|
'POST /conversations/{conversation_id}/messages',
|
|
29
|
+
'POST /conversations/{conversation_id}/read',
|
|
21
30
|
'POST /conversations/{conversation_id}/reopen',
|
|
22
31
|
'POST /knowledge/contacts',
|
|
23
32
|
'POST /knowledge/files',
|
|
24
33
|
'POST /knowledge/files/{file_id}/complete',
|
|
25
34
|
'POST /knowledge/locations',
|
|
35
|
+
'POST /quick-replies',
|
|
26
36
|
'POST /tags',
|
|
27
37
|
'POST /workflows',
|
|
28
38
|
]);
|
|
@@ -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, 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';
|
|
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, 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';
|
|
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
|
/**
|
|
@@ -567,5 +575,109 @@ export declare class RickyApi extends HeyApiClient {
|
|
|
567
575
|
* Scope: `knowledge:write`.
|
|
568
576
|
*/
|
|
569
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'>;
|
|
570
682
|
}
|
|
571
683
|
export {};
|
|
@@ -131,6 +131,25 @@ class RickyApi extends HeyApiClient {
|
|
|
131
131
|
...options
|
|
132
132
|
});
|
|
133
133
|
}
|
|
134
|
+
/**
|
|
135
|
+
* Create a contact field
|
|
136
|
+
*
|
|
137
|
+
* Adds a custom field to every contact, after the existing ones. A name already in use, in any case, answers `409 conflict`.
|
|
138
|
+
*
|
|
139
|
+
* Scope: `contacts:write`.
|
|
140
|
+
*/
|
|
141
|
+
createContactField(options) {
|
|
142
|
+
return (options.client ?? this.client).post({
|
|
143
|
+
responseStyle: 'data',
|
|
144
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
145
|
+
url: '/contact-fields',
|
|
146
|
+
...options,
|
|
147
|
+
headers: {
|
|
148
|
+
'Content-Type': 'application/json',
|
|
149
|
+
...options.headers
|
|
150
|
+
}
|
|
151
|
+
});
|
|
152
|
+
}
|
|
134
153
|
/**
|
|
135
154
|
* List conversations
|
|
136
155
|
*
|
|
@@ -347,7 +366,7 @@ class RickyApi extends HeyApiClient {
|
|
|
347
366
|
*
|
|
348
367
|
* Creates a contact tag. Apply it with `tag_ids` on a contact. A name already in use, in any case, answers `409 conflict`.
|
|
349
368
|
*
|
|
350
|
-
* Scope: `contacts:write`.
|
|
369
|
+
* Scope: `tags:write` or, on older keys, `contacts:write`.
|
|
351
370
|
*/
|
|
352
371
|
createTag(options) {
|
|
353
372
|
return (options.client ?? this.client).post({
|
|
@@ -1122,5 +1141,220 @@ class RickyApi extends HeyApiClient {
|
|
|
1122
1141
|
}
|
|
1123
1142
|
});
|
|
1124
1143
|
}
|
|
1144
|
+
/**
|
|
1145
|
+
* Change tags on many contacts
|
|
1146
|
+
*
|
|
1147
|
+
* 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.
|
|
1148
|
+
*
|
|
1149
|
+
* Scope: `contacts:write`.
|
|
1150
|
+
*/
|
|
1151
|
+
changeContactsTags(options) {
|
|
1152
|
+
return (options.client ?? this.client).post({
|
|
1153
|
+
responseStyle: 'data',
|
|
1154
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1155
|
+
url: '/contacts/tags',
|
|
1156
|
+
...options,
|
|
1157
|
+
headers: {
|
|
1158
|
+
'Content-Type': 'application/json',
|
|
1159
|
+
...options.headers
|
|
1160
|
+
}
|
|
1161
|
+
});
|
|
1162
|
+
}
|
|
1163
|
+
/**
|
|
1164
|
+
* Delete a contact field
|
|
1165
|
+
*
|
|
1166
|
+
* Deletes the field and its value on every contact, and answers the field as it was. It cannot be undone.
|
|
1167
|
+
*
|
|
1168
|
+
* Scope: `contacts:write`.
|
|
1169
|
+
*/
|
|
1170
|
+
deleteContactField(options) {
|
|
1171
|
+
return (options.client ?? this.client).delete({
|
|
1172
|
+
responseStyle: 'data',
|
|
1173
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1174
|
+
url: '/contact-fields/{field_id}',
|
|
1175
|
+
...options
|
|
1176
|
+
});
|
|
1177
|
+
}
|
|
1178
|
+
/**
|
|
1179
|
+
* Delete a tag
|
|
1180
|
+
*
|
|
1181
|
+
* Deletes the tag and removes it from every contact, and answers the tag as it was. It cannot be undone.
|
|
1182
|
+
*
|
|
1183
|
+
* Scope: `tags:write`.
|
|
1184
|
+
*/
|
|
1185
|
+
deleteTag(options) {
|
|
1186
|
+
return (options.client ?? this.client).delete({
|
|
1187
|
+
responseStyle: 'data',
|
|
1188
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1189
|
+
url: '/tags/{tag_id}',
|
|
1190
|
+
...options
|
|
1191
|
+
});
|
|
1192
|
+
}
|
|
1193
|
+
/**
|
|
1194
|
+
* Update a tag
|
|
1195
|
+
*
|
|
1196
|
+
* Renames or recolors a tag on every contact that has it. A name already in use, in any case, answers `409 conflict`.
|
|
1197
|
+
*
|
|
1198
|
+
* Scope: `tags:write`.
|
|
1199
|
+
*/
|
|
1200
|
+
updateTag(options) {
|
|
1201
|
+
return (options.client ?? this.client).patch({
|
|
1202
|
+
responseStyle: 'data',
|
|
1203
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1204
|
+
url: '/tags/{tag_id}',
|
|
1205
|
+
...options,
|
|
1206
|
+
headers: {
|
|
1207
|
+
'Content-Type': 'application/json',
|
|
1208
|
+
...options.headers
|
|
1209
|
+
}
|
|
1210
|
+
});
|
|
1211
|
+
}
|
|
1212
|
+
/**
|
|
1213
|
+
* Search conversations
|
|
1214
|
+
*
|
|
1215
|
+
* Conversations whose contact or messages contain the text, latest activity first. Answers one page of at most `limit`; `next_cursor` is always null.
|
|
1216
|
+
*
|
|
1217
|
+
* Scope: `conversations:read`.
|
|
1218
|
+
*/
|
|
1219
|
+
searchConversations(options) {
|
|
1220
|
+
return (options.client ?? this.client).get({
|
|
1221
|
+
responseStyle: 'data',
|
|
1222
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1223
|
+
url: '/conversations/search',
|
|
1224
|
+
...options
|
|
1225
|
+
});
|
|
1226
|
+
}
|
|
1227
|
+
/**
|
|
1228
|
+
* Change a conversation's tags
|
|
1229
|
+
*
|
|
1230
|
+
* Tags belong to the conversation's contact: this adds and removes tags on it and answers the contact.
|
|
1231
|
+
*
|
|
1232
|
+
* Scope: `contacts:write`.
|
|
1233
|
+
*/
|
|
1234
|
+
changeConversationTags(options) {
|
|
1235
|
+
return (options.client ?? this.client).patch({
|
|
1236
|
+
responseStyle: 'data',
|
|
1237
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1238
|
+
url: '/conversations/{conversation_id}/tags',
|
|
1239
|
+
...options,
|
|
1240
|
+
headers: {
|
|
1241
|
+
'Content-Type': 'application/json',
|
|
1242
|
+
...options.headers
|
|
1243
|
+
}
|
|
1244
|
+
});
|
|
1245
|
+
}
|
|
1246
|
+
/**
|
|
1247
|
+
* Mark a conversation read
|
|
1248
|
+
*
|
|
1249
|
+
* 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.
|
|
1250
|
+
*
|
|
1251
|
+
* Scope: `conversations:write`.
|
|
1252
|
+
*/
|
|
1253
|
+
markConversationRead(options) {
|
|
1254
|
+
return (options.client ?? this.client).post({
|
|
1255
|
+
responseStyle: 'data',
|
|
1256
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1257
|
+
url: '/conversations/{conversation_id}/read',
|
|
1258
|
+
...options
|
|
1259
|
+
});
|
|
1260
|
+
}
|
|
1261
|
+
/**
|
|
1262
|
+
* Search messages
|
|
1263
|
+
*
|
|
1264
|
+
* Messages of every conversation that contain the words, newest first. Answers one page of at most `limit`; `next_cursor` is always null.
|
|
1265
|
+
*
|
|
1266
|
+
* Scope: `conversations:read`.
|
|
1267
|
+
*/
|
|
1268
|
+
searchMessages(options) {
|
|
1269
|
+
return (options.client ?? this.client).get({
|
|
1270
|
+
responseStyle: 'data',
|
|
1271
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1272
|
+
url: '/messages/search',
|
|
1273
|
+
...options
|
|
1274
|
+
});
|
|
1275
|
+
}
|
|
1276
|
+
/**
|
|
1277
|
+
* List quick replies
|
|
1278
|
+
*
|
|
1279
|
+
* Every quick reply of the organization, by title.
|
|
1280
|
+
*
|
|
1281
|
+
* Scope: `quick_replies:read`.
|
|
1282
|
+
*/
|
|
1283
|
+
listQuickReplies(options) {
|
|
1284
|
+
return (options?.client ?? this.client).get({
|
|
1285
|
+
responseStyle: 'data',
|
|
1286
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1287
|
+
url: '/quick-replies',
|
|
1288
|
+
...options
|
|
1289
|
+
});
|
|
1290
|
+
}
|
|
1291
|
+
/**
|
|
1292
|
+
* Create a quick reply
|
|
1293
|
+
*
|
|
1294
|
+
* Saves an answer operators can insert in the inbox. A title already in use, in any case, answers `409 conflict`.
|
|
1295
|
+
*
|
|
1296
|
+
* Scope: `quick_replies:write`.
|
|
1297
|
+
*/
|
|
1298
|
+
createQuickReply(options) {
|
|
1299
|
+
return (options.client ?? this.client).post({
|
|
1300
|
+
responseStyle: 'data',
|
|
1301
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1302
|
+
url: '/quick-replies',
|
|
1303
|
+
...options,
|
|
1304
|
+
headers: {
|
|
1305
|
+
'Content-Type': 'application/json',
|
|
1306
|
+
...options.headers
|
|
1307
|
+
}
|
|
1308
|
+
});
|
|
1309
|
+
}
|
|
1310
|
+
/**
|
|
1311
|
+
* Delete a quick reply
|
|
1312
|
+
*
|
|
1313
|
+
* Deletes it and answers it as it was. It cannot be undone.
|
|
1314
|
+
*
|
|
1315
|
+
* Scope: `quick_replies:write`.
|
|
1316
|
+
*/
|
|
1317
|
+
deleteQuickReply(options) {
|
|
1318
|
+
return (options.client ?? this.client).delete({
|
|
1319
|
+
responseStyle: 'data',
|
|
1320
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1321
|
+
url: '/quick-replies/{quick_reply_id}',
|
|
1322
|
+
...options
|
|
1323
|
+
});
|
|
1324
|
+
}
|
|
1325
|
+
/**
|
|
1326
|
+
* Get a quick reply
|
|
1327
|
+
*
|
|
1328
|
+
* One quick reply.
|
|
1329
|
+
*
|
|
1330
|
+
* Scope: `quick_replies:read`.
|
|
1331
|
+
*/
|
|
1332
|
+
getQuickReply(options) {
|
|
1333
|
+
return (options.client ?? this.client).get({
|
|
1334
|
+
responseStyle: 'data',
|
|
1335
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1336
|
+
url: '/quick-replies/{quick_reply_id}',
|
|
1337
|
+
...options
|
|
1338
|
+
});
|
|
1339
|
+
}
|
|
1340
|
+
/**
|
|
1341
|
+
* Update a quick reply
|
|
1342
|
+
*
|
|
1343
|
+
* Changes only the fields in the body. A title already in use, in any case, answers `409 conflict`.
|
|
1344
|
+
*
|
|
1345
|
+
* Scope: `quick_replies:write`.
|
|
1346
|
+
*/
|
|
1347
|
+
updateQuickReply(options) {
|
|
1348
|
+
return (options.client ?? this.client).patch({
|
|
1349
|
+
responseStyle: 'data',
|
|
1350
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1351
|
+
url: '/quick-replies/{quick_reply_id}',
|
|
1352
|
+
...options,
|
|
1353
|
+
headers: {
|
|
1354
|
+
'Content-Type': 'application/json',
|
|
1355
|
+
...options.headers
|
|
1356
|
+
}
|
|
1357
|
+
});
|
|
1358
|
+
}
|
|
1125
1359
|
}
|
|
1126
1360
|
exports.RickyApi = RickyApi;
|