getricky 0.1.5 → 0.1.7
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 +5 -0
- package/dist/cjs/generated/index.d.ts +1 -1
- package/dist/cjs/generated/sdk.gen.d.ts +105 -9
- package/dist/cjs/generated/sdk.gen.js +211 -15
- package/dist/cjs/generated/types.gen.d.ts +1327 -100
- package/dist/esm/generated/idempotency.gen.js +5 -0
- package/dist/esm/generated/index.d.ts +1 -1
- package/dist/esm/generated/sdk.gen.d.ts +105 -9
- package/dist/esm/generated/sdk.gen.js +211 -15
- package/dist/esm/generated/types.gen.d.ts +1327 -100
- package/package.json +1 -1
|
@@ -7,6 +7,7 @@ exports.idempotentOperations = new Set([
|
|
|
7
7
|
'DELETE /contact-fields/{field_id}',
|
|
8
8
|
'DELETE /quick-replies/{quick_reply_id}',
|
|
9
9
|
'DELETE /tags/{tag_id}',
|
|
10
|
+
'DELETE /templates/{template_id}',
|
|
10
11
|
'PATCH /agents/{agent_id}',
|
|
11
12
|
'PATCH /contacts/{contact_id}',
|
|
12
13
|
'PATCH /conversations/{conversation_id}/agent',
|
|
@@ -17,8 +18,11 @@ exports.idempotentOperations = new Set([
|
|
|
17
18
|
'PATCH /knowledge/locations/{location_id}',
|
|
18
19
|
'PATCH /quick-replies/{quick_reply_id}',
|
|
19
20
|
'PATCH /tags/{tag_id}',
|
|
21
|
+
'PATCH /templates/{template_id}',
|
|
20
22
|
'PATCH /workflows/{workflow_id}',
|
|
21
23
|
'POST /agents',
|
|
24
|
+
'POST /broadcasts',
|
|
25
|
+
'POST /broadcasts/{broadcast_id}/cancel',
|
|
22
26
|
'POST /contact-fields',
|
|
23
27
|
'POST /contacts',
|
|
24
28
|
'POST /contacts/tags',
|
|
@@ -34,5 +38,6 @@ exports.idempotentOperations = new Set([
|
|
|
34
38
|
'POST /knowledge/locations',
|
|
35
39
|
'POST /quick-replies',
|
|
36
40
|
'POST /tags',
|
|
41
|
+
'POST /templates',
|
|
37
42
|
'POST /workflows',
|
|
38
43
|
]);
|
|
@@ -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, 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';
|
|
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, Broadcast, BroadcastRecipient, BroadcastsReport, CancelBroadcastData, CancelBroadcastError, CancelBroadcastErrors, CancelBroadcastResponse, CancelBroadcastResponses, 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, CreateBroadcast, CreateBroadcastData, CreateBroadcastError, CreateBroadcastErrors, CreateBroadcastResponse, CreateBroadcastResponses, 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, CreateTemplate, CreateTemplateData, CreateTemplateError, CreateTemplateErrors, CreateTemplateResponse, CreateTemplateResponses, CreateWebhook, CreateWebhookData, CreateWebhookError, CreateWebhookErrors, CreateWebhookResponse, CreateWebhookResponses, CreateWorkflow, CreateWorkflowData, CreateWorkflowError, CreateWorkflowErrors, CreateWorkflowResponse, CreateWorkflowResponses, DashboardReport, DeleteContactFieldData, DeleteContactFieldError, DeleteContactFieldErrors, DeleteContactFieldResponse, DeleteContactFieldResponses, DeletedTemplate, 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, DeleteTemplateData, DeleteTemplateError, DeleteTemplateErrors, DeleteTemplateResponse, DeleteTemplateResponses, 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, GetBroadcastData, GetBroadcastError, GetBroadcastErrors, GetBroadcastResponse, GetBroadcastResponses, 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, GetTemplateData, GetTemplateError, GetTemplateErrors, GetTemplateResponse, GetTemplateResponses, GetWhatsAppNumberData, GetWhatsAppNumberError, GetWhatsAppNumberErrors, GetWhatsAppNumberResponse, GetWhatsAppNumberResponses, GetWorkflowData, GetWorkflowError, GetWorkflowErrors, GetWorkflowResponse, GetWorkflowResponses, IdempotencyKey, KnowledgeContact, KnowledgeFile, KnowledgeFileUpload, KnowledgeLocation, ListAgentsData, ListAgentsError, ListAgentsErrors, ListAgentsResponse, ListAgentsResponses, ListBroadcastRecipientsData, ListBroadcastRecipientsError, ListBroadcastRecipientsErrors, ListBroadcastRecipientsResponse, ListBroadcastRecipientsResponses, ListBroadcastsData, ListBroadcastsError, ListBroadcastsErrors, ListBroadcastsResponse, ListBroadcastsResponses, 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, ListWhatsAppNumbersData, ListWhatsAppNumbersError, ListWhatsAppNumbersErrors, ListWhatsAppNumbersResponse, ListWhatsAppNumbersResponses, 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, TemplateValidation, 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, UpdateTemplate, UpdateTemplateData, UpdateTemplateError, UpdateTemplateErrors, UpdateTemplateResponse, UpdateTemplateResponses, UpdateWorkflow, UpdateWorkflowData, UpdateWorkflowError, UpdateWorkflowErrors, UpdateWorkflowResponse, UpdateWorkflowResponses, ValidateTemplate, ValidateTemplateData, ValidateTemplateError, ValidateTemplateErrors, ValidateTemplateResponse, ValidateTemplateResponses, 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, WhatsAppNumber, 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, 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';
|
|
2
|
+
import type { ActivateWorkflowData, ActivateWorkflowErrors, ActivateWorkflowResponses, AddContactNoteData, AddContactNoteErrors, AddContactNoteResponses, ArchiveAgentData, ArchiveAgentErrors, ArchiveAgentResponses, AssignConversationAgentData, AssignConversationAgentErrors, AssignConversationAgentResponses, AssignConversationData, AssignConversationErrors, AssignConversationResponses, CancelBroadcastData, CancelBroadcastErrors, CancelBroadcastResponses, ChangeContactsTagsData, ChangeContactsTagsErrors, ChangeContactsTagsResponses, ChangeConversationTagsData, ChangeConversationTagsErrors, ChangeConversationTagsResponses, CloseConversationData, CloseConversationErrors, CloseConversationResponses, CompleteKnowledgeFileData, CompleteKnowledgeFileErrors, CompleteKnowledgeFileResponses, CreateAgentData, CreateAgentErrors, CreateAgentResponses, CreateBroadcastData, CreateBroadcastErrors, CreateBroadcastResponses, CreateContactData, CreateContactErrors, CreateContactFieldData, CreateContactFieldErrors, CreateContactFieldResponses, CreateContactResponses, CreateKnowledgeContactData, CreateKnowledgeContactErrors, CreateKnowledgeContactResponses, CreateKnowledgeFileData, CreateKnowledgeFileErrors, CreateKnowledgeFileResponses, CreateKnowledgeLocationData, CreateKnowledgeLocationErrors, CreateKnowledgeLocationResponses, CreateQuickReplyData, CreateQuickReplyErrors, CreateQuickReplyResponses, CreateTagData, CreateTagErrors, CreateTagResponses, CreateTemplateData, CreateTemplateErrors, CreateTemplateResponses, CreateWebhookData, CreateWebhookErrors, CreateWebhookResponses, CreateWorkflowData, CreateWorkflowErrors, CreateWorkflowResponses, DeleteContactFieldData, DeleteContactFieldErrors, DeleteContactFieldResponses, DeleteKnowledgeContactData, DeleteKnowledgeContactErrors, DeleteKnowledgeContactResponses, DeleteKnowledgeFileData, DeleteKnowledgeFileErrors, DeleteKnowledgeFileResponses, DeleteKnowledgeLocationData, DeleteKnowledgeLocationErrors, DeleteKnowledgeLocationResponses, DeleteQuickReplyData, DeleteQuickReplyErrors, DeleteQuickReplyResponses, DeleteTagData, DeleteTagErrors, DeleteTagResponses, DeleteTemplateData, DeleteTemplateErrors, DeleteTemplateResponses, DeleteWorkflowData, DeleteWorkflowErrors, DeleteWorkflowResponses, DisableWebhookData, DisableWebhookErrors, DisableWebhookResponses, GetAdsReportData, GetAdsReportErrors, GetAdsReportResponses, GetAgentData, GetAgentErrors, GetAgentOptionsData, GetAgentOptionsErrors, GetAgentOptionsResponses, GetAgentResponses, GetBroadcastData, GetBroadcastErrors, GetBroadcastResponses, 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, GetTemplateData, GetTemplateErrors, GetTemplateResponses, GetWhatsAppNumberData, GetWhatsAppNumberErrors, GetWhatsAppNumberResponses, GetWorkflowData, GetWorkflowErrors, GetWorkflowResponses, ListAgentsData, ListAgentsErrors, ListAgentsResponses, ListBroadcastRecipientsData, ListBroadcastRecipientsErrors, ListBroadcastRecipientsResponses, ListBroadcastsData, ListBroadcastsErrors, ListBroadcastsResponses, 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, ListWhatsAppNumbersData, ListWhatsAppNumbersErrors, ListWhatsAppNumbersResponses, 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, UpdateTemplateData, UpdateTemplateErrors, UpdateTemplateResponses, UpdateWorkflowData, UpdateWorkflowErrors, UpdateWorkflowResponses, ValidateTemplateData, ValidateTemplateErrors, ValidateTemplateResponses } 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
|
|
@@ -199,14 +199,6 @@ export declare class RickyApi extends HeyApiClient {
|
|
|
199
199
|
* Scope: `tags:write` or, on older keys, `contacts:write`.
|
|
200
200
|
*/
|
|
201
201
|
createTag<ThrowOnError extends boolean = true>(options: Options<CreateTagData, ThrowOnError>): RequestResult<CreateTagResponses, CreateTagErrors, ThrowOnError, 'data'>;
|
|
202
|
-
/**
|
|
203
|
-
* List templates
|
|
204
|
-
*
|
|
205
|
-
* WhatsApp templates of every connected business account, read live from Meta.
|
|
206
|
-
*
|
|
207
|
-
* Scope: `templates:read`.
|
|
208
|
-
*/
|
|
209
|
-
listTemplates<ThrowOnError extends boolean = true>(options?: Options<ListTemplatesData, ThrowOnError>): RequestResult<ListTemplatesResponses, ListTemplatesErrors, ThrowOnError, 'data'>;
|
|
210
202
|
/**
|
|
211
203
|
* List webhooks
|
|
212
204
|
*
|
|
@@ -679,5 +671,109 @@ export declare class RickyApi extends HeyApiClient {
|
|
|
679
671
|
* Scope: `quick_replies:write`.
|
|
680
672
|
*/
|
|
681
673
|
updateQuickReply<ThrowOnError extends boolean = true>(options: Options<UpdateQuickReplyData, ThrowOnError>): RequestResult<UpdateQuickReplyResponses, UpdateQuickReplyErrors, ThrowOnError, 'data'>;
|
|
674
|
+
/**
|
|
675
|
+
* List templates
|
|
676
|
+
*
|
|
677
|
+
* WhatsApp templates of every connected business account, read live from Meta.
|
|
678
|
+
*
|
|
679
|
+
* Scope: `templates:read`.
|
|
680
|
+
*/
|
|
681
|
+
listTemplates<ThrowOnError extends boolean = true>(options?: Options<ListTemplatesData, ThrowOnError>): RequestResult<ListTemplatesResponses, ListTemplatesErrors, ThrowOnError, 'data'>;
|
|
682
|
+
/**
|
|
683
|
+
* Create a template
|
|
684
|
+
*
|
|
685
|
+
* Submits a template to Meta for review from the business account of `channel_id`. It answers the template as Meta has it, usually `PENDING`; follow it with `GET /templates/{template_id}`. A draft that breaks a rule answers `400` with the first problem; Meta refusing it answers `422 rule_violation` with its reason.
|
|
686
|
+
*
|
|
687
|
+
* Scope: `templates:write`.
|
|
688
|
+
*/
|
|
689
|
+
createTemplate<ThrowOnError extends boolean = true>(options: Options<CreateTemplateData, ThrowOnError>): RequestResult<CreateTemplateResponses, CreateTemplateErrors, ThrowOnError, 'data'>;
|
|
690
|
+
/**
|
|
691
|
+
* Delete a template
|
|
692
|
+
*
|
|
693
|
+
* Deletes the template at Meta. Meta deletes it in every language that shares its name, and the name cannot be used again for 30 days.
|
|
694
|
+
*
|
|
695
|
+
* Scope: `templates:write`.
|
|
696
|
+
*/
|
|
697
|
+
deleteTemplate<ThrowOnError extends boolean = true>(options: Options<DeleteTemplateData, ThrowOnError>): RequestResult<DeleteTemplateResponses, DeleteTemplateErrors, ThrowOnError, 'data'>;
|
|
698
|
+
/**
|
|
699
|
+
* Get a template
|
|
700
|
+
*
|
|
701
|
+
* One template, read live from Meta, with its review `status`: `PENDING` while Meta reviews it, then `APPROVED`, `REJECTED` or `PAUSED`. Read it again to follow Meta's review.
|
|
702
|
+
*
|
|
703
|
+
* Scope: `templates:read`.
|
|
704
|
+
*/
|
|
705
|
+
getTemplate<ThrowOnError extends boolean = true>(options: Options<GetTemplateData, ThrowOnError>): RequestResult<GetTemplateResponses, GetTemplateErrors, ThrowOnError, 'data'>;
|
|
706
|
+
/**
|
|
707
|
+
* Edit a template
|
|
708
|
+
*
|
|
709
|
+
* Changes the category or content of a template and sends it to Meta for review again. Meta allows it only for `APPROVED`, `REJECTED` and `PAUSED` templates, and limits how often an approved one can change; otherwise it answers `422 rule_violation`. Templates with a media header, or with buttons and components Ricky’s editor does not build, cannot be edited here.
|
|
710
|
+
*
|
|
711
|
+
* Scope: `templates:write`.
|
|
712
|
+
*/
|
|
713
|
+
updateTemplate<ThrowOnError extends boolean = true>(options: Options<UpdateTemplateData, ThrowOnError>): RequestResult<UpdateTemplateResponses, UpdateTemplateErrors, ThrowOnError, 'data'>;
|
|
714
|
+
/**
|
|
715
|
+
* Validate a template draft
|
|
716
|
+
*
|
|
717
|
+
* Checks a draft with the rules of Ricky’s template editor and answers every problem found, without submitting anything to Meta. A body that is not a draft answers `400`; a draft that breaks a rule answers `200` with `valid: false`. Meta can still reject a valid draft in its review.
|
|
718
|
+
*
|
|
719
|
+
* Scope: `templates:read`.
|
|
720
|
+
*/
|
|
721
|
+
validateTemplate<ThrowOnError extends boolean = true>(options: Options<ValidateTemplateData, ThrowOnError>): RequestResult<ValidateTemplateResponses, ValidateTemplateErrors, ThrowOnError, 'data'>;
|
|
722
|
+
/**
|
|
723
|
+
* List WhatsApp numbers
|
|
724
|
+
*
|
|
725
|
+
* Every WhatsApp number of the organization, also disconnected ones, with its status, quality rating and messaging limit as Ricky last read them from Meta.
|
|
726
|
+
*
|
|
727
|
+
* Scope: `conversations:read`.
|
|
728
|
+
*/
|
|
729
|
+
listWhatsAppNumbers<ThrowOnError extends boolean = true>(options?: Options<ListWhatsAppNumbersData, ThrowOnError>): RequestResult<ListWhatsAppNumbersResponses, ListWhatsAppNumbersErrors, ThrowOnError, 'data'>;
|
|
730
|
+
/**
|
|
731
|
+
* Get a WhatsApp number
|
|
732
|
+
*
|
|
733
|
+
* One WhatsApp number by its channel ID.
|
|
734
|
+
*
|
|
735
|
+
* Scope: `conversations:read`.
|
|
736
|
+
*/
|
|
737
|
+
getWhatsAppNumber<ThrowOnError extends boolean = true>(options: Options<GetWhatsAppNumberData, ThrowOnError>): RequestResult<GetWhatsAppNumberResponses, GetWhatsAppNumberErrors, ThrowOnError, 'data'>;
|
|
738
|
+
/**
|
|
739
|
+
* List broadcasts
|
|
740
|
+
*
|
|
741
|
+
* Newest first, with how many recipients are in each delivery status.
|
|
742
|
+
*
|
|
743
|
+
* Scope: `broadcasts:read`.
|
|
744
|
+
*/
|
|
745
|
+
listBroadcasts<ThrowOnError extends boolean = true>(options?: Options<ListBroadcastsData, ThrowOnError>): RequestResult<ListBroadcastsResponses, ListBroadcastsErrors, ThrowOnError, 'data'>;
|
|
746
|
+
/**
|
|
747
|
+
* Create a broadcast
|
|
748
|
+
*
|
|
749
|
+
* Sends an approved WhatsApp template to an audience, now or at `scheduled_at`. Ricky fixes the recipient list now and sends through each number’s conversation, as a template sent from the inbox; variables the template maps to contact fields in Ricky are filled per contact. Answers `201` with the broadcast `queued` or `scheduled`; follow it with `GET /broadcasts/{broadcast_id}`. An audience without any WhatsApp number answers `422 rule_violation`.
|
|
750
|
+
*
|
|
751
|
+
* Scope: `broadcasts:write`.
|
|
752
|
+
*/
|
|
753
|
+
createBroadcast<ThrowOnError extends boolean = true>(options: Options<CreateBroadcastData, ThrowOnError>): RequestResult<CreateBroadcastResponses, CreateBroadcastErrors, ThrowOnError, 'data'>;
|
|
754
|
+
/**
|
|
755
|
+
* Get a broadcast
|
|
756
|
+
*
|
|
757
|
+
* One broadcast with how many recipients are in each delivery status.
|
|
758
|
+
*
|
|
759
|
+
* Scope: `broadcasts:read`.
|
|
760
|
+
*/
|
|
761
|
+
getBroadcast<ThrowOnError extends boolean = true>(options: Options<GetBroadcastData, ThrowOnError>): RequestResult<GetBroadcastResponses, GetBroadcastErrors, ThrowOnError, 'data'>;
|
|
762
|
+
/**
|
|
763
|
+
* Cancel a scheduled broadcast
|
|
764
|
+
*
|
|
765
|
+
* Cancels a `scheduled` broadcast before it starts; nothing is sent. Once it is `queued` or sending, or already canceled, it answers `409 conflict`. Send no body.
|
|
766
|
+
*
|
|
767
|
+
* Scope: `broadcasts:write`.
|
|
768
|
+
*/
|
|
769
|
+
cancelBroadcast<ThrowOnError extends boolean = true>(options: Options<CancelBroadcastData, ThrowOnError>): RequestResult<CancelBroadcastResponses, CancelBroadcastErrors, ThrowOnError, 'data'>;
|
|
770
|
+
/**
|
|
771
|
+
* List broadcast recipients
|
|
772
|
+
*
|
|
773
|
+
* Each number of the broadcast and where its message stands, in number order. Statuses change as WhatsApp reports them.
|
|
774
|
+
*
|
|
775
|
+
* Scope: `broadcasts:read`.
|
|
776
|
+
*/
|
|
777
|
+
listBroadcastRecipients<ThrowOnError extends boolean = true>(options: Options<ListBroadcastRecipientsData, ThrowOnError>): RequestResult<ListBroadcastRecipientsResponses, ListBroadcastRecipientsErrors, ThrowOnError, 'data'>;
|
|
682
778
|
}
|
|
683
779
|
export {};
|
|
@@ -380,21 +380,6 @@ class RickyApi extends HeyApiClient {
|
|
|
380
380
|
}
|
|
381
381
|
});
|
|
382
382
|
}
|
|
383
|
-
/**
|
|
384
|
-
* List templates
|
|
385
|
-
*
|
|
386
|
-
* WhatsApp templates of every connected business account, read live from Meta.
|
|
387
|
-
*
|
|
388
|
-
* Scope: `templates:read`.
|
|
389
|
-
*/
|
|
390
|
-
listTemplates(options) {
|
|
391
|
-
return (options?.client ?? this.client).get({
|
|
392
|
-
responseStyle: 'data',
|
|
393
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
394
|
-
url: '/templates',
|
|
395
|
-
...options
|
|
396
|
-
});
|
|
397
|
-
}
|
|
398
383
|
/**
|
|
399
384
|
* List webhooks
|
|
400
385
|
*
|
|
@@ -1356,5 +1341,216 @@ class RickyApi extends HeyApiClient {
|
|
|
1356
1341
|
}
|
|
1357
1342
|
});
|
|
1358
1343
|
}
|
|
1344
|
+
/**
|
|
1345
|
+
* List templates
|
|
1346
|
+
*
|
|
1347
|
+
* WhatsApp templates of every connected business account, read live from Meta.
|
|
1348
|
+
*
|
|
1349
|
+
* Scope: `templates:read`.
|
|
1350
|
+
*/
|
|
1351
|
+
listTemplates(options) {
|
|
1352
|
+
return (options?.client ?? this.client).get({
|
|
1353
|
+
responseStyle: 'data',
|
|
1354
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1355
|
+
url: '/templates',
|
|
1356
|
+
...options
|
|
1357
|
+
});
|
|
1358
|
+
}
|
|
1359
|
+
/**
|
|
1360
|
+
* Create a template
|
|
1361
|
+
*
|
|
1362
|
+
* Submits a template to Meta for review from the business account of `channel_id`. It answers the template as Meta has it, usually `PENDING`; follow it with `GET /templates/{template_id}`. A draft that breaks a rule answers `400` with the first problem; Meta refusing it answers `422 rule_violation` with its reason.
|
|
1363
|
+
*
|
|
1364
|
+
* Scope: `templates:write`.
|
|
1365
|
+
*/
|
|
1366
|
+
createTemplate(options) {
|
|
1367
|
+
return (options.client ?? this.client).post({
|
|
1368
|
+
responseStyle: 'data',
|
|
1369
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1370
|
+
url: '/templates',
|
|
1371
|
+
...options,
|
|
1372
|
+
headers: {
|
|
1373
|
+
'Content-Type': 'application/json',
|
|
1374
|
+
...options.headers
|
|
1375
|
+
}
|
|
1376
|
+
});
|
|
1377
|
+
}
|
|
1378
|
+
/**
|
|
1379
|
+
* Delete a template
|
|
1380
|
+
*
|
|
1381
|
+
* Deletes the template at Meta. Meta deletes it in every language that shares its name, and the name cannot be used again for 30 days.
|
|
1382
|
+
*
|
|
1383
|
+
* Scope: `templates:write`.
|
|
1384
|
+
*/
|
|
1385
|
+
deleteTemplate(options) {
|
|
1386
|
+
return (options.client ?? this.client).delete({
|
|
1387
|
+
responseStyle: 'data',
|
|
1388
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1389
|
+
url: '/templates/{template_id}',
|
|
1390
|
+
...options
|
|
1391
|
+
});
|
|
1392
|
+
}
|
|
1393
|
+
/**
|
|
1394
|
+
* Get a template
|
|
1395
|
+
*
|
|
1396
|
+
* One template, read live from Meta, with its review `status`: `PENDING` while Meta reviews it, then `APPROVED`, `REJECTED` or `PAUSED`. Read it again to follow Meta's review.
|
|
1397
|
+
*
|
|
1398
|
+
* Scope: `templates:read`.
|
|
1399
|
+
*/
|
|
1400
|
+
getTemplate(options) {
|
|
1401
|
+
return (options.client ?? this.client).get({
|
|
1402
|
+
responseStyle: 'data',
|
|
1403
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1404
|
+
url: '/templates/{template_id}',
|
|
1405
|
+
...options
|
|
1406
|
+
});
|
|
1407
|
+
}
|
|
1408
|
+
/**
|
|
1409
|
+
* Edit a template
|
|
1410
|
+
*
|
|
1411
|
+
* Changes the category or content of a template and sends it to Meta for review again. Meta allows it only for `APPROVED`, `REJECTED` and `PAUSED` templates, and limits how often an approved one can change; otherwise it answers `422 rule_violation`. Templates with a media header, or with buttons and components Ricky’s editor does not build, cannot be edited here.
|
|
1412
|
+
*
|
|
1413
|
+
* Scope: `templates:write`.
|
|
1414
|
+
*/
|
|
1415
|
+
updateTemplate(options) {
|
|
1416
|
+
return (options.client ?? this.client).patch({
|
|
1417
|
+
responseStyle: 'data',
|
|
1418
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1419
|
+
url: '/templates/{template_id}',
|
|
1420
|
+
...options,
|
|
1421
|
+
headers: {
|
|
1422
|
+
'Content-Type': 'application/json',
|
|
1423
|
+
...options.headers
|
|
1424
|
+
}
|
|
1425
|
+
});
|
|
1426
|
+
}
|
|
1427
|
+
/**
|
|
1428
|
+
* Validate a template draft
|
|
1429
|
+
*
|
|
1430
|
+
* Checks a draft with the rules of Ricky’s template editor and answers every problem found, without submitting anything to Meta. A body that is not a draft answers `400`; a draft that breaks a rule answers `200` with `valid: false`. Meta can still reject a valid draft in its review.
|
|
1431
|
+
*
|
|
1432
|
+
* Scope: `templates:read`.
|
|
1433
|
+
*/
|
|
1434
|
+
validateTemplate(options) {
|
|
1435
|
+
return (options.client ?? this.client).post({
|
|
1436
|
+
responseStyle: 'data',
|
|
1437
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1438
|
+
url: '/templates/validate',
|
|
1439
|
+
...options,
|
|
1440
|
+
headers: {
|
|
1441
|
+
'Content-Type': 'application/json',
|
|
1442
|
+
...options.headers
|
|
1443
|
+
}
|
|
1444
|
+
});
|
|
1445
|
+
}
|
|
1446
|
+
/**
|
|
1447
|
+
* List WhatsApp numbers
|
|
1448
|
+
*
|
|
1449
|
+
* Every WhatsApp number of the organization, also disconnected ones, with its status, quality rating and messaging limit as Ricky last read them from Meta.
|
|
1450
|
+
*
|
|
1451
|
+
* Scope: `conversations:read`.
|
|
1452
|
+
*/
|
|
1453
|
+
listWhatsAppNumbers(options) {
|
|
1454
|
+
return (options?.client ?? this.client).get({
|
|
1455
|
+
responseStyle: 'data',
|
|
1456
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1457
|
+
url: '/whatsapp-numbers',
|
|
1458
|
+
...options
|
|
1459
|
+
});
|
|
1460
|
+
}
|
|
1461
|
+
/**
|
|
1462
|
+
* Get a WhatsApp number
|
|
1463
|
+
*
|
|
1464
|
+
* One WhatsApp number by its channel ID.
|
|
1465
|
+
*
|
|
1466
|
+
* Scope: `conversations:read`.
|
|
1467
|
+
*/
|
|
1468
|
+
getWhatsAppNumber(options) {
|
|
1469
|
+
return (options.client ?? this.client).get({
|
|
1470
|
+
responseStyle: 'data',
|
|
1471
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1472
|
+
url: '/whatsapp-numbers/{channel_id}',
|
|
1473
|
+
...options
|
|
1474
|
+
});
|
|
1475
|
+
}
|
|
1476
|
+
/**
|
|
1477
|
+
* List broadcasts
|
|
1478
|
+
*
|
|
1479
|
+
* Newest first, with how many recipients are in each delivery status.
|
|
1480
|
+
*
|
|
1481
|
+
* Scope: `broadcasts:read`.
|
|
1482
|
+
*/
|
|
1483
|
+
listBroadcasts(options) {
|
|
1484
|
+
return (options?.client ?? this.client).get({
|
|
1485
|
+
responseStyle: 'data',
|
|
1486
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1487
|
+
url: '/broadcasts',
|
|
1488
|
+
...options
|
|
1489
|
+
});
|
|
1490
|
+
}
|
|
1491
|
+
/**
|
|
1492
|
+
* Create a broadcast
|
|
1493
|
+
*
|
|
1494
|
+
* Sends an approved WhatsApp template to an audience, now or at `scheduled_at`. Ricky fixes the recipient list now and sends through each number’s conversation, as a template sent from the inbox; variables the template maps to contact fields in Ricky are filled per contact. Answers `201` with the broadcast `queued` or `scheduled`; follow it with `GET /broadcasts/{broadcast_id}`. An audience without any WhatsApp number answers `422 rule_violation`.
|
|
1495
|
+
*
|
|
1496
|
+
* Scope: `broadcasts:write`.
|
|
1497
|
+
*/
|
|
1498
|
+
createBroadcast(options) {
|
|
1499
|
+
return (options.client ?? this.client).post({
|
|
1500
|
+
responseStyle: 'data',
|
|
1501
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1502
|
+
url: '/broadcasts',
|
|
1503
|
+
...options,
|
|
1504
|
+
headers: {
|
|
1505
|
+
'Content-Type': 'application/json',
|
|
1506
|
+
...options.headers
|
|
1507
|
+
}
|
|
1508
|
+
});
|
|
1509
|
+
}
|
|
1510
|
+
/**
|
|
1511
|
+
* Get a broadcast
|
|
1512
|
+
*
|
|
1513
|
+
* One broadcast with how many recipients are in each delivery status.
|
|
1514
|
+
*
|
|
1515
|
+
* Scope: `broadcasts:read`.
|
|
1516
|
+
*/
|
|
1517
|
+
getBroadcast(options) {
|
|
1518
|
+
return (options.client ?? this.client).get({
|
|
1519
|
+
responseStyle: 'data',
|
|
1520
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1521
|
+
url: '/broadcasts/{broadcast_id}',
|
|
1522
|
+
...options
|
|
1523
|
+
});
|
|
1524
|
+
}
|
|
1525
|
+
/**
|
|
1526
|
+
* Cancel a scheduled broadcast
|
|
1527
|
+
*
|
|
1528
|
+
* Cancels a `scheduled` broadcast before it starts; nothing is sent. Once it is `queued` or sending, or already canceled, it answers `409 conflict`. Send no body.
|
|
1529
|
+
*
|
|
1530
|
+
* Scope: `broadcasts:write`.
|
|
1531
|
+
*/
|
|
1532
|
+
cancelBroadcast(options) {
|
|
1533
|
+
return (options.client ?? this.client).post({
|
|
1534
|
+
responseStyle: 'data',
|
|
1535
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1536
|
+
url: '/broadcasts/{broadcast_id}/cancel',
|
|
1537
|
+
...options
|
|
1538
|
+
});
|
|
1539
|
+
}
|
|
1540
|
+
/**
|
|
1541
|
+
* List broadcast recipients
|
|
1542
|
+
*
|
|
1543
|
+
* Each number of the broadcast and where its message stands, in number order. Statuses change as WhatsApp reports them.
|
|
1544
|
+
*
|
|
1545
|
+
* Scope: `broadcasts:read`.
|
|
1546
|
+
*/
|
|
1547
|
+
listBroadcastRecipients(options) {
|
|
1548
|
+
return (options.client ?? this.client).get({
|
|
1549
|
+
responseStyle: 'data',
|
|
1550
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1551
|
+
url: '/broadcasts/{broadcast_id}/recipients',
|
|
1552
|
+
...options
|
|
1553
|
+
});
|
|
1554
|
+
}
|
|
1359
1555
|
}
|
|
1360
1556
|
exports.RickyApi = RickyApi;
|