getricky 0.1.10 → 0.1.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/generated/idempotency.gen.js +10 -0
- package/dist/cjs/generated/index.d.ts +1 -1
- package/dist/cjs/generated/sdk.gen.d.ts +114 -2
- package/dist/cjs/generated/sdk.gen.js +251 -1
- package/dist/cjs/generated/types.gen.d.ts +3548 -1995
- package/dist/esm/generated/idempotency.gen.js +10 -0
- package/dist/esm/generated/index.d.ts +1 -1
- package/dist/esm/generated/sdk.gen.d.ts +114 -2
- package/dist/esm/generated/sdk.gen.js +251 -1
- package/dist/esm/generated/types.gen.d.ts +3548 -1995
- package/package.json +1 -1
|
@@ -20,6 +20,8 @@ exports.idempotentOperations = new Set([
|
|
|
20
20
|
'PATCH /quick-replies/{quick_reply_id}',
|
|
21
21
|
'PATCH /tags/{tag_id}',
|
|
22
22
|
'PATCH /templates/{template_id}',
|
|
23
|
+
'PATCH /whatsapp-numbers/{channel_id}',
|
|
24
|
+
'PATCH /whatsapp-numbers/{channel_id}/business-profile',
|
|
23
25
|
'PATCH /workflows/{workflow_id}',
|
|
24
26
|
'POST /agents',
|
|
25
27
|
'POST /broadcasts',
|
|
@@ -42,5 +44,13 @@ exports.idempotentOperations = new Set([
|
|
|
42
44
|
'POST /quick-replies',
|
|
43
45
|
'POST /tags',
|
|
44
46
|
'POST /templates',
|
|
47
|
+
'POST /templates/media',
|
|
48
|
+
'POST /templates/media/complete',
|
|
49
|
+
'POST /whatsapp-numbers/{channel_id}/display-name',
|
|
50
|
+
'POST /whatsapp-numbers/{channel_id}/profile-photo',
|
|
51
|
+
'POST /whatsapp-numbers/{channel_id}/profile-photo/complete',
|
|
52
|
+
'POST /whatsapp-numbers/{channel_id}/refresh',
|
|
45
53
|
'POST /workflows',
|
|
54
|
+
'POST /workflows/{workflow_id}/header-media',
|
|
55
|
+
'PUT /templates/{template_id}/field-mappings',
|
|
46
56
|
]);
|
|
@@ -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, 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, 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, QuickReply, 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, 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, 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, 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, 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, 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, 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, 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
|
|
@@ -319,6 +319,30 @@ export declare class RickyApi extends HeyApiClient {
|
|
|
319
319
|
* Scope: `workflows:read`.
|
|
320
320
|
*/
|
|
321
321
|
listWorkflowExecutions<ThrowOnError extends boolean = true>(options: Options<ListWorkflowExecutionsData, ThrowOnError>): RequestResult<ListWorkflowExecutionsResponses, ListWorkflowExecutionsErrors, ThrowOnError, 'data'>;
|
|
322
|
+
/**
|
|
323
|
+
* Set the header file of a scheduled workflow
|
|
324
|
+
*
|
|
325
|
+
* Downloads the file at `url` and stores it as the header every send of a scheduled workflow carries, replacing the previous one. The workflow’s template must have an image, video or document header, and the file must be that kind. Answers the workflow, with `has_header_image` true.
|
|
326
|
+
*
|
|
327
|
+
* Scope: `workflows:write`.
|
|
328
|
+
*/
|
|
329
|
+
uploadWorkflowHeaderMedia<ThrowOnError extends boolean = true>(options: Options<UploadWorkflowHeaderMediaData, ThrowOnError>): RequestResult<UploadWorkflowHeaderMediaResponses, UploadWorkflowHeaderMediaErrors, ThrowOnError, 'data'>;
|
|
330
|
+
/**
|
|
331
|
+
* Preview appointment reminders
|
|
332
|
+
*
|
|
333
|
+
* Reads the Odoo appointments an appointment-reminder workflow would message on `date` and says, for each, whether it would be sent and with what text. Sends nothing. Only for workflows with `source.kind` `odoo_appointments`, in an organization with Odoo connected; past days are in the history.
|
|
334
|
+
*
|
|
335
|
+
* Scope: `workflows:read`.
|
|
336
|
+
*/
|
|
337
|
+
previewWorkflowReminders<ThrowOnError extends boolean = true>(options: Options<PreviewWorkflowRemindersData, ThrowOnError>): RequestResult<PreviewWorkflowRemindersResponses, PreviewWorkflowRemindersErrors, ThrowOnError, 'data'>;
|
|
338
|
+
/**
|
|
339
|
+
* Get appointment reminder history
|
|
340
|
+
*
|
|
341
|
+
* What an appointment-reminder workflow checked in Odoo and sent on `date`, from what Ricky recorded; it does not read Odoo.
|
|
342
|
+
*
|
|
343
|
+
* Scope: `workflows:read`.
|
|
344
|
+
*/
|
|
345
|
+
getWorkflowReminderHistory<ThrowOnError extends boolean = true>(options: Options<GetWorkflowReminderHistoryData, ThrowOnError>): RequestResult<GetWorkflowReminderHistoryResponses, GetWorkflowReminderHistoryErrors, ThrowOnError, 'data'>;
|
|
322
346
|
/**
|
|
323
347
|
* Get the live dashboard
|
|
324
348
|
*
|
|
@@ -714,7 +738,7 @@ export declare class RickyApi extends HeyApiClient {
|
|
|
714
738
|
/**
|
|
715
739
|
* Edit a template
|
|
716
740
|
*
|
|
717
|
-
* 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`.
|
|
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`. 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.
|
|
718
742
|
*
|
|
719
743
|
* Scope: `templates:write`.
|
|
720
744
|
*/
|
|
@@ -743,6 +767,86 @@ export declare class RickyApi extends HeyApiClient {
|
|
|
743
767
|
* Scope: `conversations:read`.
|
|
744
768
|
*/
|
|
745
769
|
getWhatsAppNumber<ThrowOnError extends boolean = true>(options: Options<GetWhatsAppNumberData, ThrowOnError>): RequestResult<GetWhatsAppNumberResponses, GetWhatsAppNumberErrors, ThrowOnError, 'data'>;
|
|
770
|
+
/**
|
|
771
|
+
* Update a WhatsApp number
|
|
772
|
+
*
|
|
773
|
+
* Turns calls to the number on or off at Meta. Ricky reads the number back from Meta and answers it as Meta confirms it.
|
|
774
|
+
*
|
|
775
|
+
* Scope: `conversations:write`.
|
|
776
|
+
*/
|
|
777
|
+
updateWhatsAppNumber<ThrowOnError extends boolean = true>(options: Options<UpdateWhatsAppNumberData, ThrowOnError>): RequestResult<UpdateWhatsAppNumberResponses, UpdateWhatsAppNumberErrors, ThrowOnError, 'data'>;
|
|
778
|
+
/**
|
|
779
|
+
* Upload a header sample
|
|
780
|
+
*
|
|
781
|
+
* 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`.
|
|
782
|
+
*
|
|
783
|
+
* Scope: `templates:write`.
|
|
784
|
+
*/
|
|
785
|
+
createTemplateMediaUpload<ThrowOnError extends boolean = true>(options: Options<CreateTemplateMediaUploadData, ThrowOnError>): RequestResult<CreateTemplateMediaUploadResponses, CreateTemplateMediaUploadErrors, ThrowOnError, 'data'>;
|
|
786
|
+
/**
|
|
787
|
+
* Complete a header sample
|
|
788
|
+
*
|
|
789
|
+
* 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`.
|
|
790
|
+
*
|
|
791
|
+
* Scope: `templates:write`.
|
|
792
|
+
*/
|
|
793
|
+
completeTemplateMediaUpload<ThrowOnError extends boolean = true>(options: Options<CompleteTemplateMediaUploadData, ThrowOnError>): RequestResult<CompleteTemplateMediaUploadResponses, CompleteTemplateMediaUploadErrors, ThrowOnError, 'data'>;
|
|
794
|
+
/**
|
|
795
|
+
* Get the field mappings of a template
|
|
796
|
+
*
|
|
797
|
+
* 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.
|
|
798
|
+
*
|
|
799
|
+
* Scope: `templates:read`.
|
|
800
|
+
*/
|
|
801
|
+
getTemplateFieldMappings<ThrowOnError extends boolean = true>(options: Options<GetTemplateFieldMappingsData, ThrowOnError>): RequestResult<GetTemplateFieldMappingsResponses, GetTemplateFieldMappingsErrors, ThrowOnError, 'data'>;
|
|
802
|
+
/**
|
|
803
|
+
* Set the field mappings of a template
|
|
804
|
+
*
|
|
805
|
+
* 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.
|
|
806
|
+
*
|
|
807
|
+
* Scope: `templates:write`.
|
|
808
|
+
*/
|
|
809
|
+
replaceTemplateFieldMappings<ThrowOnError extends boolean = true>(options: Options<ReplaceTemplateFieldMappingsData, ThrowOnError>): RequestResult<ReplaceTemplateFieldMappingsResponses, ReplaceTemplateFieldMappingsErrors, ThrowOnError, 'data'>;
|
|
810
|
+
/**
|
|
811
|
+
* Edit a business profile
|
|
812
|
+
*
|
|
813
|
+
* Changes the business profile customers see on the number at Meta, then answers the number with the profile Meta reads back.
|
|
814
|
+
*
|
|
815
|
+
* Scope: `conversations:write`.
|
|
816
|
+
*/
|
|
817
|
+
updateWhatsAppBusinessProfile<ThrowOnError extends boolean = true>(options: Options<UpdateWhatsAppBusinessProfileData, ThrowOnError>): RequestResult<UpdateWhatsAppBusinessProfileResponses, UpdateWhatsAppBusinessProfileErrors, ThrowOnError, 'data'>;
|
|
818
|
+
/**
|
|
819
|
+
* Upload a profile photo
|
|
820
|
+
*
|
|
821
|
+
* 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`.
|
|
822
|
+
*
|
|
823
|
+
* Scope: `conversations:write`.
|
|
824
|
+
*/
|
|
825
|
+
createProfilePhotoUpload<ThrowOnError extends boolean = true>(options: Options<CreateProfilePhotoUploadData, ThrowOnError>): RequestResult<CreateProfilePhotoUploadResponses, CreateProfilePhotoUploadErrors, ThrowOnError, 'data'>;
|
|
826
|
+
/**
|
|
827
|
+
* Complete a profile photo
|
|
828
|
+
*
|
|
829
|
+
* Checks the uploaded photo, sets it on the number at Meta and answers the number. Ricky deletes its copy either way.
|
|
830
|
+
*
|
|
831
|
+
* Scope: `conversations:write`.
|
|
832
|
+
*/
|
|
833
|
+
completeProfilePhotoUpload<ThrowOnError extends boolean = true>(options: Options<CompleteProfilePhotoUploadData, ThrowOnError>): RequestResult<CompleteProfilePhotoUploadResponses, CompleteProfilePhotoUploadErrors, ThrowOnError, 'data'>;
|
|
834
|
+
/**
|
|
835
|
+
* Request a display name change
|
|
836
|
+
*
|
|
837
|
+
* 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.
|
|
838
|
+
*
|
|
839
|
+
* Scope: `conversations:write`.
|
|
840
|
+
*/
|
|
841
|
+
requestWhatsAppDisplayName<ThrowOnError extends boolean = true>(options: Options<RequestWhatsAppDisplayNameData, ThrowOnError>): RequestResult<RequestWhatsAppDisplayNameResponses, RequestWhatsAppDisplayNameErrors, ThrowOnError, 'data'>;
|
|
842
|
+
/**
|
|
843
|
+
* Refresh a WhatsApp number
|
|
844
|
+
*
|
|
845
|
+
* Reads the number’s status, quality, limit, display name and business profile from Meta now, stores them and answers the number.
|
|
846
|
+
*
|
|
847
|
+
* Scope: `conversations:write`.
|
|
848
|
+
*/
|
|
849
|
+
refreshWhatsAppNumber<ThrowOnError extends boolean = true>(options: Options<RefreshWhatsAppNumberData, ThrowOnError>): RequestResult<RefreshWhatsAppNumberResponses, RefreshWhatsAppNumberErrors, ThrowOnError, 'data'>;
|
|
746
850
|
/**
|
|
747
851
|
* List broadcasts
|
|
748
852
|
*
|
|
@@ -807,5 +911,13 @@ export declare class RickyApi extends HeyApiClient {
|
|
|
807
911
|
* Scope: `conversations:read`.
|
|
808
912
|
*/
|
|
809
913
|
fetchMessageMedia<ThrowOnError extends boolean = true>(options: Options<FetchMessageMediaData, ThrowOnError>): RequestResult<FetchMessageMediaResponses, FetchMessageMediaErrors, ThrowOnError, 'data'>;
|
|
914
|
+
/**
|
|
915
|
+
* Preview a broadcast audience
|
|
916
|
+
*
|
|
917
|
+
* Counts the numbers an audience resolves to now, with the rules `POST /broadcasts` uses, without creating anything. The list can change before you create the broadcast.
|
|
918
|
+
*
|
|
919
|
+
* Scope: `broadcasts:read`.
|
|
920
|
+
*/
|
|
921
|
+
previewBroadcastAudience<ThrowOnError extends boolean = true>(options: Options<PreviewBroadcastAudienceData, ThrowOnError>): RequestResult<PreviewBroadcastAudienceResponses, PreviewBroadcastAudienceErrors, ThrowOnError, 'data'>;
|
|
810
922
|
}
|
|
811
923
|
export {};
|
|
@@ -621,6 +621,55 @@ class RickyApi extends HeyApiClient {
|
|
|
621
621
|
...options
|
|
622
622
|
});
|
|
623
623
|
}
|
|
624
|
+
/**
|
|
625
|
+
* Set the header file of a scheduled workflow
|
|
626
|
+
*
|
|
627
|
+
* Downloads the file at `url` and stores it as the header every send of a scheduled workflow carries, replacing the previous one. The workflow’s template must have an image, video or document header, and the file must be that kind. Answers the workflow, with `has_header_image` true.
|
|
628
|
+
*
|
|
629
|
+
* Scope: `workflows:write`.
|
|
630
|
+
*/
|
|
631
|
+
uploadWorkflowHeaderMedia(options) {
|
|
632
|
+
return (options.client ?? this.client).post({
|
|
633
|
+
responseStyle: 'data',
|
|
634
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
635
|
+
url: '/workflows/{workflow_id}/header-media',
|
|
636
|
+
...options,
|
|
637
|
+
headers: {
|
|
638
|
+
'Content-Type': 'application/json',
|
|
639
|
+
...options.headers
|
|
640
|
+
}
|
|
641
|
+
});
|
|
642
|
+
}
|
|
643
|
+
/**
|
|
644
|
+
* Preview appointment reminders
|
|
645
|
+
*
|
|
646
|
+
* Reads the Odoo appointments an appointment-reminder workflow would message on `date` and says, for each, whether it would be sent and with what text. Sends nothing. Only for workflows with `source.kind` `odoo_appointments`, in an organization with Odoo connected; past days are in the history.
|
|
647
|
+
*
|
|
648
|
+
* Scope: `workflows:read`.
|
|
649
|
+
*/
|
|
650
|
+
previewWorkflowReminders(options) {
|
|
651
|
+
return (options.client ?? this.client).get({
|
|
652
|
+
responseStyle: 'data',
|
|
653
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
654
|
+
url: '/workflows/{workflow_id}/reminders/preview',
|
|
655
|
+
...options
|
|
656
|
+
});
|
|
657
|
+
}
|
|
658
|
+
/**
|
|
659
|
+
* Get appointment reminder history
|
|
660
|
+
*
|
|
661
|
+
* What an appointment-reminder workflow checked in Odoo and sent on `date`, from what Ricky recorded; it does not read Odoo.
|
|
662
|
+
*
|
|
663
|
+
* Scope: `workflows:read`.
|
|
664
|
+
*/
|
|
665
|
+
getWorkflowReminderHistory(options) {
|
|
666
|
+
return (options.client ?? this.client).get({
|
|
667
|
+
responseStyle: 'data',
|
|
668
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
669
|
+
url: '/workflows/{workflow_id}/reminders/history',
|
|
670
|
+
...options
|
|
671
|
+
});
|
|
672
|
+
}
|
|
624
673
|
/**
|
|
625
674
|
* Get the live dashboard
|
|
626
675
|
*
|
|
@@ -1423,7 +1472,7 @@ class RickyApi extends HeyApiClient {
|
|
|
1423
1472
|
/**
|
|
1424
1473
|
* Edit a template
|
|
1425
1474
|
*
|
|
1426
|
-
* 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`.
|
|
1475
|
+
* 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.
|
|
1427
1476
|
*
|
|
1428
1477
|
* Scope: `templates:write`.
|
|
1429
1478
|
*/
|
|
@@ -1488,6 +1537,188 @@ class RickyApi extends HeyApiClient {
|
|
|
1488
1537
|
...options
|
|
1489
1538
|
});
|
|
1490
1539
|
}
|
|
1540
|
+
/**
|
|
1541
|
+
* Update a WhatsApp number
|
|
1542
|
+
*
|
|
1543
|
+
* Turns calls to the number on or off at Meta. Ricky reads the number back from Meta and answers it as Meta confirms it.
|
|
1544
|
+
*
|
|
1545
|
+
* Scope: `conversations:write`.
|
|
1546
|
+
*/
|
|
1547
|
+
updateWhatsAppNumber(options) {
|
|
1548
|
+
return (options.client ?? this.client).patch({
|
|
1549
|
+
responseStyle: 'data',
|
|
1550
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1551
|
+
url: '/whatsapp-numbers/{channel_id}',
|
|
1552
|
+
...options,
|
|
1553
|
+
headers: {
|
|
1554
|
+
'Content-Type': 'application/json',
|
|
1555
|
+
...options.headers
|
|
1556
|
+
}
|
|
1557
|
+
});
|
|
1558
|
+
}
|
|
1559
|
+
/**
|
|
1560
|
+
* Upload a header sample
|
|
1561
|
+
*
|
|
1562
|
+
* 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`.
|
|
1563
|
+
*
|
|
1564
|
+
* Scope: `templates:write`.
|
|
1565
|
+
*/
|
|
1566
|
+
createTemplateMediaUpload(options) {
|
|
1567
|
+
return (options.client ?? this.client).post({
|
|
1568
|
+
responseStyle: 'data',
|
|
1569
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1570
|
+
url: '/templates/media',
|
|
1571
|
+
...options,
|
|
1572
|
+
headers: {
|
|
1573
|
+
'Content-Type': 'application/json',
|
|
1574
|
+
...options.headers
|
|
1575
|
+
}
|
|
1576
|
+
});
|
|
1577
|
+
}
|
|
1578
|
+
/**
|
|
1579
|
+
* Complete a header sample
|
|
1580
|
+
*
|
|
1581
|
+
* 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`.
|
|
1582
|
+
*
|
|
1583
|
+
* Scope: `templates:write`.
|
|
1584
|
+
*/
|
|
1585
|
+
completeTemplateMediaUpload(options) {
|
|
1586
|
+
return (options.client ?? this.client).post({
|
|
1587
|
+
responseStyle: 'data',
|
|
1588
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1589
|
+
url: '/templates/media/complete',
|
|
1590
|
+
...options,
|
|
1591
|
+
headers: {
|
|
1592
|
+
'Content-Type': 'application/json',
|
|
1593
|
+
...options.headers
|
|
1594
|
+
}
|
|
1595
|
+
});
|
|
1596
|
+
}
|
|
1597
|
+
/**
|
|
1598
|
+
* Get the field mappings of a template
|
|
1599
|
+
*
|
|
1600
|
+
* 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.
|
|
1601
|
+
*
|
|
1602
|
+
* Scope: `templates:read`.
|
|
1603
|
+
*/
|
|
1604
|
+
getTemplateFieldMappings(options) {
|
|
1605
|
+
return (options.client ?? this.client).get({
|
|
1606
|
+
responseStyle: 'data',
|
|
1607
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1608
|
+
url: '/templates/{template_id}/field-mappings',
|
|
1609
|
+
...options
|
|
1610
|
+
});
|
|
1611
|
+
}
|
|
1612
|
+
/**
|
|
1613
|
+
* Set the field mappings of a template
|
|
1614
|
+
*
|
|
1615
|
+
* 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.
|
|
1616
|
+
*
|
|
1617
|
+
* Scope: `templates:write`.
|
|
1618
|
+
*/
|
|
1619
|
+
replaceTemplateFieldMappings(options) {
|
|
1620
|
+
return (options.client ?? this.client).put({
|
|
1621
|
+
responseStyle: 'data',
|
|
1622
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1623
|
+
url: '/templates/{template_id}/field-mappings',
|
|
1624
|
+
...options,
|
|
1625
|
+
headers: {
|
|
1626
|
+
'Content-Type': 'application/json',
|
|
1627
|
+
...options.headers
|
|
1628
|
+
}
|
|
1629
|
+
});
|
|
1630
|
+
}
|
|
1631
|
+
/**
|
|
1632
|
+
* Edit a business profile
|
|
1633
|
+
*
|
|
1634
|
+
* Changes the business profile customers see on the number at Meta, then answers the number with the profile Meta reads back.
|
|
1635
|
+
*
|
|
1636
|
+
* Scope: `conversations:write`.
|
|
1637
|
+
*/
|
|
1638
|
+
updateWhatsAppBusinessProfile(options) {
|
|
1639
|
+
return (options.client ?? this.client).patch({
|
|
1640
|
+
responseStyle: 'data',
|
|
1641
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1642
|
+
url: '/whatsapp-numbers/{channel_id}/business-profile',
|
|
1643
|
+
...options,
|
|
1644
|
+
headers: {
|
|
1645
|
+
'Content-Type': 'application/json',
|
|
1646
|
+
...options.headers
|
|
1647
|
+
}
|
|
1648
|
+
});
|
|
1649
|
+
}
|
|
1650
|
+
/**
|
|
1651
|
+
* Upload a profile photo
|
|
1652
|
+
*
|
|
1653
|
+
* 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`.
|
|
1654
|
+
*
|
|
1655
|
+
* Scope: `conversations:write`.
|
|
1656
|
+
*/
|
|
1657
|
+
createProfilePhotoUpload(options) {
|
|
1658
|
+
return (options.client ?? this.client).post({
|
|
1659
|
+
responseStyle: 'data',
|
|
1660
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1661
|
+
url: '/whatsapp-numbers/{channel_id}/profile-photo',
|
|
1662
|
+
...options,
|
|
1663
|
+
headers: {
|
|
1664
|
+
'Content-Type': 'application/json',
|
|
1665
|
+
...options.headers
|
|
1666
|
+
}
|
|
1667
|
+
});
|
|
1668
|
+
}
|
|
1669
|
+
/**
|
|
1670
|
+
* Complete a profile photo
|
|
1671
|
+
*
|
|
1672
|
+
* Checks the uploaded photo, sets it on the number at Meta and answers the number. Ricky deletes its copy either way.
|
|
1673
|
+
*
|
|
1674
|
+
* Scope: `conversations:write`.
|
|
1675
|
+
*/
|
|
1676
|
+
completeProfilePhotoUpload(options) {
|
|
1677
|
+
return (options.client ?? this.client).post({
|
|
1678
|
+
responseStyle: 'data',
|
|
1679
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1680
|
+
url: '/whatsapp-numbers/{channel_id}/profile-photo/complete',
|
|
1681
|
+
...options,
|
|
1682
|
+
headers: {
|
|
1683
|
+
'Content-Type': 'application/json',
|
|
1684
|
+
...options.headers
|
|
1685
|
+
}
|
|
1686
|
+
});
|
|
1687
|
+
}
|
|
1688
|
+
/**
|
|
1689
|
+
* Request a display name change
|
|
1690
|
+
*
|
|
1691
|
+
* 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.
|
|
1692
|
+
*
|
|
1693
|
+
* Scope: `conversations:write`.
|
|
1694
|
+
*/
|
|
1695
|
+
requestWhatsAppDisplayName(options) {
|
|
1696
|
+
return (options.client ?? this.client).post({
|
|
1697
|
+
responseStyle: 'data',
|
|
1698
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1699
|
+
url: '/whatsapp-numbers/{channel_id}/display-name',
|
|
1700
|
+
...options,
|
|
1701
|
+
headers: {
|
|
1702
|
+
'Content-Type': 'application/json',
|
|
1703
|
+
...options.headers
|
|
1704
|
+
}
|
|
1705
|
+
});
|
|
1706
|
+
}
|
|
1707
|
+
/**
|
|
1708
|
+
* Refresh a WhatsApp number
|
|
1709
|
+
*
|
|
1710
|
+
* Reads the number’s status, quality, limit, display name and business profile from Meta now, stores them and answers the number.
|
|
1711
|
+
*
|
|
1712
|
+
* Scope: `conversations:write`.
|
|
1713
|
+
*/
|
|
1714
|
+
refreshWhatsAppNumber(options) {
|
|
1715
|
+
return (options.client ?? this.client).post({
|
|
1716
|
+
responseStyle: 'data',
|
|
1717
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1718
|
+
url: '/whatsapp-numbers/{channel_id}/refresh',
|
|
1719
|
+
...options
|
|
1720
|
+
});
|
|
1721
|
+
}
|
|
1491
1722
|
/**
|
|
1492
1723
|
* List broadcasts
|
|
1493
1724
|
*
|
|
@@ -1620,5 +1851,24 @@ class RickyApi extends HeyApiClient {
|
|
|
1620
1851
|
...options
|
|
1621
1852
|
});
|
|
1622
1853
|
}
|
|
1854
|
+
/**
|
|
1855
|
+
* Preview a broadcast audience
|
|
1856
|
+
*
|
|
1857
|
+
* Counts the numbers an audience resolves to now, with the rules `POST /broadcasts` uses, without creating anything. The list can change before you create the broadcast.
|
|
1858
|
+
*
|
|
1859
|
+
* Scope: `broadcasts:read`.
|
|
1860
|
+
*/
|
|
1861
|
+
previewBroadcastAudience(options) {
|
|
1862
|
+
return (options.client ?? this.client).post({
|
|
1863
|
+
responseStyle: 'data',
|
|
1864
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1865
|
+
url: '/broadcasts/preview',
|
|
1866
|
+
...options,
|
|
1867
|
+
headers: {
|
|
1868
|
+
'Content-Type': 'application/json',
|
|
1869
|
+
...options.headers
|
|
1870
|
+
}
|
|
1871
|
+
});
|
|
1872
|
+
}
|
|
1623
1873
|
}
|
|
1624
1874
|
exports.RickyApi = RickyApi;
|