getricky 0.1.11 → 0.1.13
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 +9 -0
- package/dist/cjs/generated/index.d.ts +1 -1
- package/dist/cjs/generated/sdk.gen.d.ts +92 -4
- package/dist/cjs/generated/sdk.gen.js +200 -3
- package/dist/cjs/generated/types.gen.d.ts +1145 -14
- package/dist/esm/generated/idempotency.gen.js +9 -0
- package/dist/esm/generated/index.d.ts +1 -1
- package/dist/esm/generated/sdk.gen.d.ts +92 -4
- package/dist/esm/generated/sdk.gen.js +200 -3
- package/dist/esm/generated/types.gen.d.ts +1145 -14
- package/package.json +1 -1
|
@@ -17,6 +17,8 @@ export const idempotentOperations = new Set([
|
|
|
17
17
|
'PATCH /quick-replies/{quick_reply_id}',
|
|
18
18
|
'PATCH /tags/{tag_id}',
|
|
19
19
|
'PATCH /templates/{template_id}',
|
|
20
|
+
'PATCH /whatsapp-numbers/{channel_id}',
|
|
21
|
+
'PATCH /whatsapp-numbers/{channel_id}/business-profile',
|
|
20
22
|
'PATCH /workflows/{workflow_id}',
|
|
21
23
|
'POST /agents',
|
|
22
24
|
'POST /broadcasts',
|
|
@@ -39,6 +41,13 @@ export const idempotentOperations = new Set([
|
|
|
39
41
|
'POST /quick-replies',
|
|
40
42
|
'POST /tags',
|
|
41
43
|
'POST /templates',
|
|
44
|
+
'POST /templates/media',
|
|
45
|
+
'POST /templates/media/complete',
|
|
46
|
+
'POST /whatsapp-numbers/{channel_id}/display-name',
|
|
47
|
+
'POST /whatsapp-numbers/{channel_id}/profile-photo',
|
|
48
|
+
'POST /whatsapp-numbers/{channel_id}/profile-photo/complete',
|
|
49
|
+
'POST /whatsapp-numbers/{channel_id}/refresh',
|
|
42
50
|
'POST /workflows',
|
|
43
51
|
'POST /workflows/{workflow_id}/header-media',
|
|
52
|
+
'PUT /templates/{template_id}/field-mappings',
|
|
44
53
|
]);
|
|
@@ -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, AssignConversations, AssignConversationsData, AssignConversationsError, AssignConversationsErrors, AssignConversationsResponse, AssignConversationsResponses, Broadcast, BroadcastAudiencePreview, 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, ConversationAssignmentResult, ConversationHandoff, 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, FetchMessageMediaData, FetchMessageMediaError, FetchMessageMediaErrors, FetchMessageMediaResponse, FetchMessageMediaResponses, 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, GetWorkflowReminderHistoryData, GetWorkflowReminderHistoryError, GetWorkflowReminderHistoryErrors, GetWorkflowReminderHistoryResponse, GetWorkflowReminderHistoryResponses, 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, MarkConversationUnreadData, MarkConversationUnreadError, MarkConversationUnreadErrors, MarkConversationUnreadResponse, MarkConversationUnreadResponses, MediaMessage, Member, Message, MessageSearchResult, MessagesReport, PauseWorkflowData, PauseWorkflowError, PauseWorkflowErrors, PauseWorkflowResponse, PauseWorkflowResponses, PreviewBroadcastAudience, PreviewBroadcastAudienceData, PreviewBroadcastAudienceError, PreviewBroadcastAudienceErrors, PreviewBroadcastAudienceResponse, PreviewBroadcastAudienceResponses, PreviewWorkflowRemindersData, PreviewWorkflowRemindersError, PreviewWorkflowRemindersErrors, PreviewWorkflowRemindersResponse, PreviewWorkflowRemindersResponses, QuickReply, ReminderHistory, ReminderPreview, ReopenConversationData, ReopenConversationError, ReopenConversationErrors, ReopenConversationResponse, ReopenConversationResponses, ReportPeriod, ResolutionsReport, ResolveConversationHandoffData, ResolveConversationHandoffError, ResolveConversationHandoffErrors, ResolveConversationHandoffResponse, ResolveConversationHandoffResponses, ResolveHandoff, 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, UploadWorkflowHeaderMedia, UploadWorkflowHeaderMediaData, UploadWorkflowHeaderMediaError, UploadWorkflowHeaderMediaErrors, UploadWorkflowHeaderMediaResponse, UploadWorkflowHeaderMediaResponses, ValidateTemplate, ValidateTemplateData, ValidateTemplateError, ValidateTemplateErrors, ValidateTemplateResponse, ValidateTemplateResponses, Webhook, WebhookBroadcastCompletedWebhookPayload, WebhookBroadcastCompletedWebhookRequest, WebhookBroadcastFailedWebhookPayload, WebhookBroadcastFailedWebhookRequest, WebhookContactCreatedWebhookPayload, WebhookContactCreatedWebhookRequest, WebhookContactTagsChangedWebhookPayload, WebhookContactTagsChangedWebhookRequest, WebhookContactUpdatedWebhookPayload, WebhookContactUpdatedWebhookRequest, WebhookConversationAgentChangedWebhookPayload, WebhookConversationAgentChangedWebhookRequest, WebhookConversationAssignmentChangedWebhookPayload, WebhookConversationAssignmentChangedWebhookRequest, WebhookConversationClosedWebhookPayload, WebhookConversationClosedWebhookRequest, WebhookConversationHandoffRequestedWebhookPayload, WebhookConversationHandoffRequestedWebhookRequest, WebhookConversationHandoffResolvedWebhookPayload, WebhookConversationHandoffResolvedWebhookRequest, WebhookConversationOpenedWebhookPayload, WebhookConversationOpenedWebhookRequest, WebhookDelivery, WebhookEvent, WebhookKnowledgeFileReadyWebhookPayload, WebhookKnowledgeFileReadyWebhookRequest, WebhookMessageDeliveredWebhookPayload, WebhookMessageDeliveredWebhookRequest, WebhookMessageFailedWebhookPayload, WebhookMessageFailedWebhookRequest, WebhookMessageReadWebhookPayload, WebhookMessageReadWebhookRequest, WebhookMessageReceivedWebhookPayload, WebhookMessageReceivedWebhookRequest, WebhookMessageSentWebhookPayload, WebhookMessageSentWebhookRequest, Webhooks, WebhookTemplateStatusChangedWebhookPayload, WebhookTemplateStatusChangedWebhookRequest, WebhookTestResult, WebhookWebhookTestWebhookPayload, WebhookWebhookTestWebhookRequest, WebhookWorkflowExecutionFailedWebhookPayload, WebhookWorkflowExecutionFailedWebhookRequest, WhatsAppNumber, Workflow, WorkflowExecution } from './types.gen.js';
|
|
2
|
+
export type { ActivateWorkflowData, ActivateWorkflowError, ActivateWorkflowErrors, ActivateWorkflowResponse, ActivateWorkflowResponses, AddContactNote, AddContactNoteData, AddContactNoteError, AddContactNoteErrors, AddContactNoteResponse, AddContactNoteResponses, AdsReport, Agent, AgentOptions, AppointmentState, ArchiveAgentData, ArchiveAgentError, ArchiveAgentErrors, ArchiveAgentResponse, ArchiveAgentResponses, AssignConversation, AssignConversationAgent, AssignConversationAgentData, AssignConversationAgentError, AssignConversationAgentErrors, AssignConversationAgentResponse, AssignConversationAgentResponses, AssignConversationData, AssignConversationError, AssignConversationErrors, AssignConversationResponse, AssignConversationResponses, AssignConversations, AssignConversationsData, AssignConversationsError, AssignConversationsErrors, AssignConversationsResponse, AssignConversationsResponses, Broadcast, BroadcastAudiencePreview, 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, CompleteProfilePhotoUpload, CompleteProfilePhotoUploadData, CompleteProfilePhotoUploadError, CompleteProfilePhotoUploadErrors, CompleteProfilePhotoUploadResponse, CompleteProfilePhotoUploadResponses, CompleteTemplateMediaUpload, CompleteTemplateMediaUploadData, CompleteTemplateMediaUploadError, CompleteTemplateMediaUploadErrors, CompleteTemplateMediaUploadResponse, CompleteTemplateMediaUploadResponses, Contact, ContactField, ContactIdentity, ContactTagChange, Conversation, ConversationAssignmentResult, ConversationHandoff, 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, CreateProfilePhotoUpload, CreateProfilePhotoUploadData, CreateProfilePhotoUploadError, CreateProfilePhotoUploadErrors, CreateProfilePhotoUploadResponse, CreateProfilePhotoUploadResponses, CreateQuickReply, CreateQuickReplyData, CreateQuickReplyError, CreateQuickReplyErrors, CreateQuickReplyResponse, CreateQuickReplyResponses, CreateTag, CreateTagData, CreateTagError, CreateTagErrors, CreateTagResponse, CreateTagResponses, CreateTemplate, CreateTemplateData, CreateTemplateError, CreateTemplateErrors, CreateTemplateMediaUpload, CreateTemplateMediaUploadData, CreateTemplateMediaUploadError, CreateTemplateMediaUploadErrors, CreateTemplateMediaUploadResponse, CreateTemplateMediaUploadResponses, 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, DisplayNameRequest, Error, FetchMessageMediaData, FetchMessageMediaError, FetchMessageMediaErrors, FetchMessageMediaResponse, FetchMessageMediaResponses, 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, GetTemplateFieldMappingsData, GetTemplateFieldMappingsError, GetTemplateFieldMappingsErrors, GetTemplateFieldMappingsResponse, GetTemplateFieldMappingsResponses, GetTemplateResponse, GetTemplateResponses, GetWhatsAppNumberData, GetWhatsAppNumberError, GetWhatsAppNumberErrors, GetWhatsAppNumberResponse, GetWhatsAppNumberResponses, GetWorkflowData, GetWorkflowError, GetWorkflowErrors, GetWorkflowReminderHistoryData, GetWorkflowReminderHistoryError, GetWorkflowReminderHistoryErrors, GetWorkflowReminderHistoryResponse, GetWorkflowReminderHistoryResponses, 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, ListWorkflowReminderStatesData, ListWorkflowReminderStatesError, ListWorkflowReminderStatesErrors, ListWorkflowReminderStatesResponse, ListWorkflowReminderStatesResponses, ListWorkflowsData, ListWorkflowsError, ListWorkflowsErrors, ListWorkflowsResponse, ListWorkflowsResponses, MarkConversationReadData, MarkConversationReadError, MarkConversationReadErrors, MarkConversationReadResponse, MarkConversationReadResponses, MarkConversationUnreadData, MarkConversationUnreadError, MarkConversationUnreadErrors, MarkConversationUnreadResponse, MarkConversationUnreadResponses, MediaMessage, MediaUpload, Member, Message, MessageSearchResult, MessagesReport, PauseWorkflowData, PauseWorkflowError, PauseWorkflowErrors, PauseWorkflowResponse, PauseWorkflowResponses, PreviewBroadcastAudience, PreviewBroadcastAudienceData, PreviewBroadcastAudienceError, PreviewBroadcastAudienceErrors, PreviewBroadcastAudienceResponse, PreviewBroadcastAudienceResponses, PreviewWorkflowRemindersData, PreviewWorkflowRemindersError, PreviewWorkflowRemindersErrors, PreviewWorkflowRemindersResponse, PreviewWorkflowRemindersResponses, QuickReply, RefreshWhatsAppNumberData, RefreshWhatsAppNumberError, RefreshWhatsAppNumberErrors, RefreshWhatsAppNumberResponse, RefreshWhatsAppNumberResponses, ReminderHistory, ReminderPreview, ReopenConversationData, ReopenConversationError, ReopenConversationErrors, ReopenConversationResponse, ReopenConversationResponses, ReplaceTemplateFieldMappings, ReplaceTemplateFieldMappingsData, ReplaceTemplateFieldMappingsError, ReplaceTemplateFieldMappingsErrors, ReplaceTemplateFieldMappingsResponse, ReplaceTemplateFieldMappingsResponses, ReportPeriod, RequestDisplayName, RequestWhatsAppDisplayNameData, RequestWhatsAppDisplayNameError, RequestWhatsAppDisplayNameErrors, RequestWhatsAppDisplayNameResponse, RequestWhatsAppDisplayNameResponses, ResolutionsReport, ResolveConversationHandoffData, ResolveConversationHandoffError, ResolveConversationHandoffErrors, ResolveConversationHandoffResponse, ResolveConversationHandoffResponses, ResolveHandoff, 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, TemplateFieldMappings, TemplateMedia, 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, UpdateWhatsAppBusinessProfile, UpdateWhatsAppBusinessProfileData, UpdateWhatsAppBusinessProfileError, UpdateWhatsAppBusinessProfileErrors, UpdateWhatsAppBusinessProfileResponse, UpdateWhatsAppBusinessProfileResponses, UpdateWhatsAppNumber, UpdateWhatsAppNumberData, UpdateWhatsAppNumberError, UpdateWhatsAppNumberErrors, UpdateWhatsAppNumberResponse, UpdateWhatsAppNumberResponses, UpdateWorkflow, UpdateWorkflowData, UpdateWorkflowError, UpdateWorkflowErrors, UpdateWorkflowResponse, UpdateWorkflowResponses, UploadWorkflowHeaderMedia, UploadWorkflowHeaderMediaData, UploadWorkflowHeaderMediaError, UploadWorkflowHeaderMediaErrors, UploadWorkflowHeaderMediaResponse, UploadWorkflowHeaderMediaResponses, ValidateTemplate, ValidateTemplateData, ValidateTemplateError, ValidateTemplateErrors, ValidateTemplateResponse, ValidateTemplateResponses, Webhook, WebhookBroadcastCompletedWebhookPayload, WebhookBroadcastCompletedWebhookRequest, WebhookBroadcastFailedWebhookPayload, WebhookBroadcastFailedWebhookRequest, WebhookContactCreatedWebhookPayload, WebhookContactCreatedWebhookRequest, WebhookContactTagsChangedWebhookPayload, WebhookContactTagsChangedWebhookRequest, WebhookContactUpdatedWebhookPayload, WebhookContactUpdatedWebhookRequest, WebhookConversationAgentChangedWebhookPayload, WebhookConversationAgentChangedWebhookRequest, WebhookConversationAssignmentChangedWebhookPayload, WebhookConversationAssignmentChangedWebhookRequest, WebhookConversationClosedWebhookPayload, WebhookConversationClosedWebhookRequest, WebhookConversationHandoffRequestedWebhookPayload, WebhookConversationHandoffRequestedWebhookRequest, WebhookConversationHandoffResolvedWebhookPayload, WebhookConversationHandoffResolvedWebhookRequest, WebhookConversationOpenedWebhookPayload, WebhookConversationOpenedWebhookRequest, WebhookDelivery, WebhookEvent, WebhookKnowledgeFileReadyWebhookPayload, WebhookKnowledgeFileReadyWebhookRequest, WebhookMessageDeliveredWebhookPayload, WebhookMessageDeliveredWebhookRequest, WebhookMessageFailedWebhookPayload, WebhookMessageFailedWebhookRequest, WebhookMessageReadWebhookPayload, WebhookMessageReadWebhookRequest, WebhookMessageReceivedWebhookPayload, WebhookMessageReceivedWebhookRequest, WebhookMessageSentWebhookPayload, WebhookMessageSentWebhookRequest, Webhooks, WebhookTemplateStatusChangedWebhookPayload, WebhookTemplateStatusChangedWebhookRequest, WebhookTestResult, WebhookWebhookTestWebhookPayload, WebhookWebhookTestWebhookRequest, WebhookWorkflowExecutionFailedWebhookPayload, WebhookWorkflowExecutionFailedWebhookRequest, 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, AssignConversationsData, AssignConversationsErrors, AssignConversationsResponses, 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, FetchMessageMediaData, FetchMessageMediaErrors, FetchMessageMediaResponses, 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, GetWorkflowReminderHistoryData, GetWorkflowReminderHistoryErrors, GetWorkflowReminderHistoryResponses, 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, MarkConversationUnreadData, MarkConversationUnreadErrors, MarkConversationUnreadResponses, PauseWorkflowData, PauseWorkflowErrors, PauseWorkflowResponses, PreviewBroadcastAudienceData, PreviewBroadcastAudienceErrors, PreviewBroadcastAudienceResponses, PreviewWorkflowRemindersData, PreviewWorkflowRemindersErrors, PreviewWorkflowRemindersResponses, ReopenConversationData, ReopenConversationErrors, ReopenConversationResponses, ResolveConversationHandoffData, ResolveConversationHandoffErrors, ResolveConversationHandoffResponses, 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, UploadWorkflowHeaderMediaData, UploadWorkflowHeaderMediaErrors, UploadWorkflowHeaderMediaResponses, ValidateTemplateData, ValidateTemplateErrors, ValidateTemplateResponses } from './types.gen.js';
|
|
2
|
+
import type { ActivateWorkflowData, ActivateWorkflowErrors, ActivateWorkflowResponses, AddContactNoteData, AddContactNoteErrors, AddContactNoteResponses, ArchiveAgentData, ArchiveAgentErrors, ArchiveAgentResponses, AssignConversationAgentData, AssignConversationAgentErrors, AssignConversationAgentResponses, AssignConversationData, AssignConversationErrors, AssignConversationResponses, AssignConversationsData, AssignConversationsErrors, AssignConversationsResponses, CancelBroadcastData, CancelBroadcastErrors, CancelBroadcastResponses, ChangeContactsTagsData, ChangeContactsTagsErrors, ChangeContactsTagsResponses, ChangeConversationTagsData, ChangeConversationTagsErrors, ChangeConversationTagsResponses, CloseConversationData, CloseConversationErrors, CloseConversationResponses, CompleteKnowledgeFileData, CompleteKnowledgeFileErrors, CompleteKnowledgeFileResponses, CompleteProfilePhotoUploadData, CompleteProfilePhotoUploadErrors, CompleteProfilePhotoUploadResponses, CompleteTemplateMediaUploadData, CompleteTemplateMediaUploadErrors, CompleteTemplateMediaUploadResponses, CreateAgentData, CreateAgentErrors, CreateAgentResponses, CreateBroadcastData, CreateBroadcastErrors, CreateBroadcastResponses, CreateContactData, CreateContactErrors, CreateContactFieldData, CreateContactFieldErrors, CreateContactFieldResponses, CreateContactResponses, CreateKnowledgeContactData, CreateKnowledgeContactErrors, CreateKnowledgeContactResponses, CreateKnowledgeFileData, CreateKnowledgeFileErrors, CreateKnowledgeFileResponses, CreateKnowledgeLocationData, CreateKnowledgeLocationErrors, CreateKnowledgeLocationResponses, CreateProfilePhotoUploadData, CreateProfilePhotoUploadErrors, CreateProfilePhotoUploadResponses, CreateQuickReplyData, CreateQuickReplyErrors, CreateQuickReplyResponses, CreateTagData, CreateTagErrors, CreateTagResponses, CreateTemplateData, CreateTemplateErrors, CreateTemplateMediaUploadData, CreateTemplateMediaUploadErrors, CreateTemplateMediaUploadResponses, 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, FetchMessageMediaData, FetchMessageMediaErrors, FetchMessageMediaResponses, 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, GetTemplateFieldMappingsData, GetTemplateFieldMappingsErrors, GetTemplateFieldMappingsResponses, GetTemplateResponses, GetWhatsAppNumberData, GetWhatsAppNumberErrors, GetWhatsAppNumberResponses, GetWorkflowData, GetWorkflowErrors, GetWorkflowReminderHistoryData, GetWorkflowReminderHistoryErrors, GetWorkflowReminderHistoryResponses, 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, ListWorkflowReminderStatesData, ListWorkflowReminderStatesErrors, ListWorkflowReminderStatesResponses, ListWorkflowsData, ListWorkflowsErrors, ListWorkflowsResponses, MarkConversationReadData, MarkConversationReadErrors, MarkConversationReadResponses, MarkConversationUnreadData, MarkConversationUnreadErrors, MarkConversationUnreadResponses, PauseWorkflowData, PauseWorkflowErrors, PauseWorkflowResponses, PreviewBroadcastAudienceData, PreviewBroadcastAudienceErrors, PreviewBroadcastAudienceResponses, PreviewWorkflowRemindersData, PreviewWorkflowRemindersErrors, PreviewWorkflowRemindersResponses, RefreshWhatsAppNumberData, RefreshWhatsAppNumberErrors, RefreshWhatsAppNumberResponses, ReopenConversationData, ReopenConversationErrors, ReopenConversationResponses, ReplaceTemplateFieldMappingsData, ReplaceTemplateFieldMappingsErrors, ReplaceTemplateFieldMappingsResponses, RequestWhatsAppDisplayNameData, RequestWhatsAppDisplayNameErrors, RequestWhatsAppDisplayNameResponses, ResolveConversationHandoffData, ResolveConversationHandoffErrors, ResolveConversationHandoffResponses, 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, UpdateWhatsAppBusinessProfileData, UpdateWhatsAppBusinessProfileErrors, UpdateWhatsAppBusinessProfileResponses, UpdateWhatsAppNumberData, UpdateWhatsAppNumberErrors, UpdateWhatsAppNumberResponses, UpdateWorkflowData, UpdateWorkflowErrors, UpdateWorkflowResponses, UploadWorkflowHeaderMediaData, UploadWorkflowHeaderMediaErrors, UploadWorkflowHeaderMediaResponses, 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
|
|
@@ -343,6 +343,14 @@ export declare class RickyApi extends HeyApiClient {
|
|
|
343
343
|
* Scope: `workflows:read`.
|
|
344
344
|
*/
|
|
345
345
|
getWorkflowReminderHistory<ThrowOnError extends boolean = true>(options: Options<GetWorkflowReminderHistoryData, ThrowOnError>): RequestResult<GetWorkflowReminderHistoryResponses, GetWorkflowReminderHistoryErrors, ThrowOnError, 'data'>;
|
|
346
|
+
/**
|
|
347
|
+
* List the Odoo appointment states
|
|
348
|
+
*
|
|
349
|
+
* Reads from Odoo, live, every appointment state its installation has: the values an appointment-reminder workflow’s `source.appointment_states` and the preview’s `appointment_states` take. Only for workflows with `source.kind` `odoo_appointments`, in an organization with Odoo connected.
|
|
350
|
+
*
|
|
351
|
+
* Scope: `workflows:read`.
|
|
352
|
+
*/
|
|
353
|
+
listWorkflowReminderStates<ThrowOnError extends boolean = true>(options: Options<ListWorkflowReminderStatesData, ThrowOnError>): RequestResult<ListWorkflowReminderStatesResponses, ListWorkflowReminderStatesErrors, ThrowOnError, 'data'>;
|
|
346
354
|
/**
|
|
347
355
|
* Get the live dashboard
|
|
348
356
|
*
|
|
@@ -632,9 +640,9 @@ export declare class RickyApi extends HeyApiClient {
|
|
|
632
640
|
*/
|
|
633
641
|
searchConversations<ThrowOnError extends boolean = true>(options: Options<SearchConversationsData, ThrowOnError>): RequestResult<SearchConversationsResponses, SearchConversationsErrors, ThrowOnError, 'data'>;
|
|
634
642
|
/**
|
|
635
|
-
* Change a conversation's
|
|
643
|
+
* Change the tags of a conversation's contact
|
|
636
644
|
*
|
|
637
|
-
* Tags belong to the conversation's contact: this adds and removes tags on
|
|
645
|
+
* Tags belong to the conversation's contact, not to the conversation: this adds and removes tags on that contact, so every conversation of the contact shows them, and answers the contact. The change is a `contact.tags_changed` webhook event; there is no conversation tag event.
|
|
638
646
|
*
|
|
639
647
|
* Scope: `contacts:write`.
|
|
640
648
|
*/
|
|
@@ -738,7 +746,7 @@ export declare class RickyApi extends HeyApiClient {
|
|
|
738
746
|
/**
|
|
739
747
|
* Edit a template
|
|
740
748
|
*
|
|
741
|
-
* 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`.
|
|
749
|
+
* 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`. An edit that keeps an image, video or document header sends `header` again with a new `handle`. Templates with buttons or components Ricky’s editor does not build cannot be edited here.
|
|
742
750
|
*
|
|
743
751
|
* Scope: `templates:write`.
|
|
744
752
|
*/
|
|
@@ -767,6 +775,86 @@ export declare class RickyApi extends HeyApiClient {
|
|
|
767
775
|
* Scope: `conversations:read`.
|
|
768
776
|
*/
|
|
769
777
|
getWhatsAppNumber<ThrowOnError extends boolean = true>(options: Options<GetWhatsAppNumberData, ThrowOnError>): RequestResult<GetWhatsAppNumberResponses, GetWhatsAppNumberErrors, ThrowOnError, 'data'>;
|
|
778
|
+
/**
|
|
779
|
+
* Update a WhatsApp number
|
|
780
|
+
*
|
|
781
|
+
* Turns calls to the number on or off at Meta. Ricky reads the number back from Meta and answers it as Meta confirms it.
|
|
782
|
+
*
|
|
783
|
+
* Scope: `conversations:write`.
|
|
784
|
+
*/
|
|
785
|
+
updateWhatsAppNumber<ThrowOnError extends boolean = true>(options: Options<UpdateWhatsAppNumberData, ThrowOnError>): RequestResult<UpdateWhatsAppNumberResponses, UpdateWhatsAppNumberErrors, ThrowOnError, 'data'>;
|
|
786
|
+
/**
|
|
787
|
+
* Upload a header sample
|
|
788
|
+
*
|
|
789
|
+
* An image, video or document header needs a sample file Meta reviews. Uploading it takes three steps: this call answers an `upload_url`; `PUT` the bytes there; then `POST /templates/media/complete` answers the `handle` for `header.handle`.
|
|
790
|
+
*
|
|
791
|
+
* Scope: `templates:write`.
|
|
792
|
+
*/
|
|
793
|
+
createTemplateMediaUpload<ThrowOnError extends boolean = true>(options: Options<CreateTemplateMediaUploadData, ThrowOnError>): RequestResult<CreateTemplateMediaUploadResponses, CreateTemplateMediaUploadErrors, ThrowOnError, 'data'>;
|
|
794
|
+
/**
|
|
795
|
+
* Complete a header sample
|
|
796
|
+
*
|
|
797
|
+
* Checks the uploaded bytes against the type and size limits, sends them to Meta and answers Meta’s `handle`. Ricky deletes its copy either way, so a failed upload starts again with `POST /templates/media`.
|
|
798
|
+
*
|
|
799
|
+
* Scope: `templates:write`.
|
|
800
|
+
*/
|
|
801
|
+
completeTemplateMediaUpload<ThrowOnError extends boolean = true>(options: Options<CompleteTemplateMediaUploadData, ThrowOnError>): RequestResult<CompleteTemplateMediaUploadResponses, CompleteTemplateMediaUploadErrors, ThrowOnError, 'data'>;
|
|
802
|
+
/**
|
|
803
|
+
* Get the field mappings of a template
|
|
804
|
+
*
|
|
805
|
+
* The template’s variables, read live from Meta, and the contact field that fills each one when Ricky sends the template to a contact, as in broadcasts.
|
|
806
|
+
*
|
|
807
|
+
* Scope: `templates:read`.
|
|
808
|
+
*/
|
|
809
|
+
getTemplateFieldMappings<ThrowOnError extends boolean = true>(options: Options<GetTemplateFieldMappingsData, ThrowOnError>): RequestResult<GetTemplateFieldMappingsResponses, GetTemplateFieldMappingsErrors, ThrowOnError, 'data'>;
|
|
810
|
+
/**
|
|
811
|
+
* Set the field mappings of a template
|
|
812
|
+
*
|
|
813
|
+
* Replaces every mapping of the template. Each one names a variable of `variables` and a contact field; a custom field must be the organization’s.
|
|
814
|
+
*
|
|
815
|
+
* Scope: `templates:write`.
|
|
816
|
+
*/
|
|
817
|
+
replaceTemplateFieldMappings<ThrowOnError extends boolean = true>(options: Options<ReplaceTemplateFieldMappingsData, ThrowOnError>): RequestResult<ReplaceTemplateFieldMappingsResponses, ReplaceTemplateFieldMappingsErrors, ThrowOnError, 'data'>;
|
|
818
|
+
/**
|
|
819
|
+
* Edit a business profile
|
|
820
|
+
*
|
|
821
|
+
* Changes the business profile customers see on the number at Meta, then answers the number with the profile Meta reads back.
|
|
822
|
+
*
|
|
823
|
+
* Scope: `conversations:write`.
|
|
824
|
+
*/
|
|
825
|
+
updateWhatsAppBusinessProfile<ThrowOnError extends boolean = true>(options: Options<UpdateWhatsAppBusinessProfileData, ThrowOnError>): RequestResult<UpdateWhatsAppBusinessProfileResponses, UpdateWhatsAppBusinessProfileErrors, ThrowOnError, 'data'>;
|
|
826
|
+
/**
|
|
827
|
+
* Upload a profile photo
|
|
828
|
+
*
|
|
829
|
+
* Begins a new profile photo in three steps: this call answers an `upload_url`; `PUT` the bytes there; then call `POST /whatsapp-numbers/{channel_id}/profile-photo/complete`.
|
|
830
|
+
*
|
|
831
|
+
* Scope: `conversations:write`.
|
|
832
|
+
*/
|
|
833
|
+
createProfilePhotoUpload<ThrowOnError extends boolean = true>(options: Options<CreateProfilePhotoUploadData, ThrowOnError>): RequestResult<CreateProfilePhotoUploadResponses, CreateProfilePhotoUploadErrors, ThrowOnError, 'data'>;
|
|
834
|
+
/**
|
|
835
|
+
* Complete a profile photo
|
|
836
|
+
*
|
|
837
|
+
* Checks the uploaded photo, sets it on the number at Meta and answers the number. Ricky deletes its copy either way.
|
|
838
|
+
*
|
|
839
|
+
* Scope: `conversations:write`.
|
|
840
|
+
*/
|
|
841
|
+
completeProfilePhotoUpload<ThrowOnError extends boolean = true>(options: Options<CompleteProfilePhotoUploadData, ThrowOnError>): RequestResult<CompleteProfilePhotoUploadResponses, CompleteProfilePhotoUploadErrors, ThrowOnError, 'data'>;
|
|
842
|
+
/**
|
|
843
|
+
* Request a display name change
|
|
844
|
+
*
|
|
845
|
+
* Asks Meta to review a new display name for the number. The name changes only if Meta approves it; then `verified_name` and `name_status` change.
|
|
846
|
+
*
|
|
847
|
+
* Scope: `conversations:write`.
|
|
848
|
+
*/
|
|
849
|
+
requestWhatsAppDisplayName<ThrowOnError extends boolean = true>(options: Options<RequestWhatsAppDisplayNameData, ThrowOnError>): RequestResult<RequestWhatsAppDisplayNameResponses, RequestWhatsAppDisplayNameErrors, ThrowOnError, 'data'>;
|
|
850
|
+
/**
|
|
851
|
+
* Refresh a WhatsApp number
|
|
852
|
+
*
|
|
853
|
+
* Reads the number’s status, quality, limit, display name and business profile from Meta now, stores them and answers the number.
|
|
854
|
+
*
|
|
855
|
+
* Scope: `conversations:write`.
|
|
856
|
+
*/
|
|
857
|
+
refreshWhatsAppNumber<ThrowOnError extends boolean = true>(options: Options<RefreshWhatsAppNumberData, ThrowOnError>): RequestResult<RefreshWhatsAppNumberResponses, RefreshWhatsAppNumberErrors, ThrowOnError, 'data'>;
|
|
770
858
|
/**
|
|
771
859
|
* List broadcasts
|
|
772
860
|
*
|
|
@@ -667,6 +667,21 @@ export class RickyApi extends HeyApiClient {
|
|
|
667
667
|
...options
|
|
668
668
|
});
|
|
669
669
|
}
|
|
670
|
+
/**
|
|
671
|
+
* List the Odoo appointment states
|
|
672
|
+
*
|
|
673
|
+
* Reads from Odoo, live, every appointment state its installation has: the values an appointment-reminder workflow’s `source.appointment_states` and the preview’s `appointment_states` take. Only for workflows with `source.kind` `odoo_appointments`, in an organization with Odoo connected.
|
|
674
|
+
*
|
|
675
|
+
* Scope: `workflows:read`.
|
|
676
|
+
*/
|
|
677
|
+
listWorkflowReminderStates(options) {
|
|
678
|
+
return (options.client ?? this.client).get({
|
|
679
|
+
responseStyle: 'data',
|
|
680
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
681
|
+
url: '/workflows/{workflow_id}/reminders/state-options',
|
|
682
|
+
...options
|
|
683
|
+
});
|
|
684
|
+
}
|
|
670
685
|
/**
|
|
671
686
|
* Get the live dashboard
|
|
672
687
|
*
|
|
@@ -1256,9 +1271,9 @@ export class RickyApi extends HeyApiClient {
|
|
|
1256
1271
|
});
|
|
1257
1272
|
}
|
|
1258
1273
|
/**
|
|
1259
|
-
* Change a conversation's
|
|
1274
|
+
* Change the tags of a conversation's contact
|
|
1260
1275
|
*
|
|
1261
|
-
* Tags belong to the conversation's contact: this adds and removes tags on
|
|
1276
|
+
* Tags belong to the conversation's contact, not to the conversation: this adds and removes tags on that contact, so every conversation of the contact shows them, and answers the contact. The change is a `contact.tags_changed` webhook event; there is no conversation tag event.
|
|
1262
1277
|
*
|
|
1263
1278
|
* Scope: `contacts:write`.
|
|
1264
1279
|
*/
|
|
@@ -1469,7 +1484,7 @@ export class RickyApi extends HeyApiClient {
|
|
|
1469
1484
|
/**
|
|
1470
1485
|
* Edit a template
|
|
1471
1486
|
*
|
|
1472
|
-
* 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`.
|
|
1487
|
+
* 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`. An edit that keeps an image, video or document header sends `header` again with a new `handle`. Templates with buttons or components Ricky’s editor does not build cannot be edited here.
|
|
1473
1488
|
*
|
|
1474
1489
|
* Scope: `templates:write`.
|
|
1475
1490
|
*/
|
|
@@ -1534,6 +1549,188 @@ export class RickyApi extends HeyApiClient {
|
|
|
1534
1549
|
...options
|
|
1535
1550
|
});
|
|
1536
1551
|
}
|
|
1552
|
+
/**
|
|
1553
|
+
* Update a WhatsApp number
|
|
1554
|
+
*
|
|
1555
|
+
* Turns calls to the number on or off at Meta. Ricky reads the number back from Meta and answers it as Meta confirms it.
|
|
1556
|
+
*
|
|
1557
|
+
* Scope: `conversations:write`.
|
|
1558
|
+
*/
|
|
1559
|
+
updateWhatsAppNumber(options) {
|
|
1560
|
+
return (options.client ?? this.client).patch({
|
|
1561
|
+
responseStyle: 'data',
|
|
1562
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1563
|
+
url: '/whatsapp-numbers/{channel_id}',
|
|
1564
|
+
...options,
|
|
1565
|
+
headers: {
|
|
1566
|
+
'Content-Type': 'application/json',
|
|
1567
|
+
...options.headers
|
|
1568
|
+
}
|
|
1569
|
+
});
|
|
1570
|
+
}
|
|
1571
|
+
/**
|
|
1572
|
+
* Upload a header sample
|
|
1573
|
+
*
|
|
1574
|
+
* An image, video or document header needs a sample file Meta reviews. Uploading it takes three steps: this call answers an `upload_url`; `PUT` the bytes there; then `POST /templates/media/complete` answers the `handle` for `header.handle`.
|
|
1575
|
+
*
|
|
1576
|
+
* Scope: `templates:write`.
|
|
1577
|
+
*/
|
|
1578
|
+
createTemplateMediaUpload(options) {
|
|
1579
|
+
return (options.client ?? this.client).post({
|
|
1580
|
+
responseStyle: 'data',
|
|
1581
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1582
|
+
url: '/templates/media',
|
|
1583
|
+
...options,
|
|
1584
|
+
headers: {
|
|
1585
|
+
'Content-Type': 'application/json',
|
|
1586
|
+
...options.headers
|
|
1587
|
+
}
|
|
1588
|
+
});
|
|
1589
|
+
}
|
|
1590
|
+
/**
|
|
1591
|
+
* Complete a header sample
|
|
1592
|
+
*
|
|
1593
|
+
* Checks the uploaded bytes against the type and size limits, sends them to Meta and answers Meta’s `handle`. Ricky deletes its copy either way, so a failed upload starts again with `POST /templates/media`.
|
|
1594
|
+
*
|
|
1595
|
+
* Scope: `templates:write`.
|
|
1596
|
+
*/
|
|
1597
|
+
completeTemplateMediaUpload(options) {
|
|
1598
|
+
return (options.client ?? this.client).post({
|
|
1599
|
+
responseStyle: 'data',
|
|
1600
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1601
|
+
url: '/templates/media/complete',
|
|
1602
|
+
...options,
|
|
1603
|
+
headers: {
|
|
1604
|
+
'Content-Type': 'application/json',
|
|
1605
|
+
...options.headers
|
|
1606
|
+
}
|
|
1607
|
+
});
|
|
1608
|
+
}
|
|
1609
|
+
/**
|
|
1610
|
+
* Get the field mappings of a template
|
|
1611
|
+
*
|
|
1612
|
+
* The template’s variables, read live from Meta, and the contact field that fills each one when Ricky sends the template to a contact, as in broadcasts.
|
|
1613
|
+
*
|
|
1614
|
+
* Scope: `templates:read`.
|
|
1615
|
+
*/
|
|
1616
|
+
getTemplateFieldMappings(options) {
|
|
1617
|
+
return (options.client ?? this.client).get({
|
|
1618
|
+
responseStyle: 'data',
|
|
1619
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1620
|
+
url: '/templates/{template_id}/field-mappings',
|
|
1621
|
+
...options
|
|
1622
|
+
});
|
|
1623
|
+
}
|
|
1624
|
+
/**
|
|
1625
|
+
* Set the field mappings of a template
|
|
1626
|
+
*
|
|
1627
|
+
* Replaces every mapping of the template. Each one names a variable of `variables` and a contact field; a custom field must be the organization’s.
|
|
1628
|
+
*
|
|
1629
|
+
* Scope: `templates:write`.
|
|
1630
|
+
*/
|
|
1631
|
+
replaceTemplateFieldMappings(options) {
|
|
1632
|
+
return (options.client ?? this.client).put({
|
|
1633
|
+
responseStyle: 'data',
|
|
1634
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1635
|
+
url: '/templates/{template_id}/field-mappings',
|
|
1636
|
+
...options,
|
|
1637
|
+
headers: {
|
|
1638
|
+
'Content-Type': 'application/json',
|
|
1639
|
+
...options.headers
|
|
1640
|
+
}
|
|
1641
|
+
});
|
|
1642
|
+
}
|
|
1643
|
+
/**
|
|
1644
|
+
* Edit a business profile
|
|
1645
|
+
*
|
|
1646
|
+
* Changes the business profile customers see on the number at Meta, then answers the number with the profile Meta reads back.
|
|
1647
|
+
*
|
|
1648
|
+
* Scope: `conversations:write`.
|
|
1649
|
+
*/
|
|
1650
|
+
updateWhatsAppBusinessProfile(options) {
|
|
1651
|
+
return (options.client ?? this.client).patch({
|
|
1652
|
+
responseStyle: 'data',
|
|
1653
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1654
|
+
url: '/whatsapp-numbers/{channel_id}/business-profile',
|
|
1655
|
+
...options,
|
|
1656
|
+
headers: {
|
|
1657
|
+
'Content-Type': 'application/json',
|
|
1658
|
+
...options.headers
|
|
1659
|
+
}
|
|
1660
|
+
});
|
|
1661
|
+
}
|
|
1662
|
+
/**
|
|
1663
|
+
* Upload a profile photo
|
|
1664
|
+
*
|
|
1665
|
+
* Begins a new profile photo in three steps: this call answers an `upload_url`; `PUT` the bytes there; then call `POST /whatsapp-numbers/{channel_id}/profile-photo/complete`.
|
|
1666
|
+
*
|
|
1667
|
+
* Scope: `conversations:write`.
|
|
1668
|
+
*/
|
|
1669
|
+
createProfilePhotoUpload(options) {
|
|
1670
|
+
return (options.client ?? this.client).post({
|
|
1671
|
+
responseStyle: 'data',
|
|
1672
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1673
|
+
url: '/whatsapp-numbers/{channel_id}/profile-photo',
|
|
1674
|
+
...options,
|
|
1675
|
+
headers: {
|
|
1676
|
+
'Content-Type': 'application/json',
|
|
1677
|
+
...options.headers
|
|
1678
|
+
}
|
|
1679
|
+
});
|
|
1680
|
+
}
|
|
1681
|
+
/**
|
|
1682
|
+
* Complete a profile photo
|
|
1683
|
+
*
|
|
1684
|
+
* Checks the uploaded photo, sets it on the number at Meta and answers the number. Ricky deletes its copy either way.
|
|
1685
|
+
*
|
|
1686
|
+
* Scope: `conversations:write`.
|
|
1687
|
+
*/
|
|
1688
|
+
completeProfilePhotoUpload(options) {
|
|
1689
|
+
return (options.client ?? this.client).post({
|
|
1690
|
+
responseStyle: 'data',
|
|
1691
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1692
|
+
url: '/whatsapp-numbers/{channel_id}/profile-photo/complete',
|
|
1693
|
+
...options,
|
|
1694
|
+
headers: {
|
|
1695
|
+
'Content-Type': 'application/json',
|
|
1696
|
+
...options.headers
|
|
1697
|
+
}
|
|
1698
|
+
});
|
|
1699
|
+
}
|
|
1700
|
+
/**
|
|
1701
|
+
* Request a display name change
|
|
1702
|
+
*
|
|
1703
|
+
* Asks Meta to review a new display name for the number. The name changes only if Meta approves it; then `verified_name` and `name_status` change.
|
|
1704
|
+
*
|
|
1705
|
+
* Scope: `conversations:write`.
|
|
1706
|
+
*/
|
|
1707
|
+
requestWhatsAppDisplayName(options) {
|
|
1708
|
+
return (options.client ?? this.client).post({
|
|
1709
|
+
responseStyle: 'data',
|
|
1710
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1711
|
+
url: '/whatsapp-numbers/{channel_id}/display-name',
|
|
1712
|
+
...options,
|
|
1713
|
+
headers: {
|
|
1714
|
+
'Content-Type': 'application/json',
|
|
1715
|
+
...options.headers
|
|
1716
|
+
}
|
|
1717
|
+
});
|
|
1718
|
+
}
|
|
1719
|
+
/**
|
|
1720
|
+
* Refresh a WhatsApp number
|
|
1721
|
+
*
|
|
1722
|
+
* Reads the number’s status, quality, limit, display name and business profile from Meta now, stores them and answers the number.
|
|
1723
|
+
*
|
|
1724
|
+
* Scope: `conversations:write`.
|
|
1725
|
+
*/
|
|
1726
|
+
refreshWhatsAppNumber(options) {
|
|
1727
|
+
return (options.client ?? this.client).post({
|
|
1728
|
+
responseStyle: 'data',
|
|
1729
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1730
|
+
url: '/whatsapp-numbers/{channel_id}/refresh',
|
|
1731
|
+
...options
|
|
1732
|
+
});
|
|
1733
|
+
}
|
|
1537
1734
|
/**
|
|
1538
1735
|
* List broadcasts
|
|
1539
1736
|
*
|