getricky 0.1.9 → 0.1.10

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.
@@ -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, WebhookContactCreatedWebhookPayload, WebhookContactCreatedWebhookRequest, WebhookContactUpdatedWebhookPayload, WebhookContactUpdatedWebhookRequest, WebhookConversationAssignmentChangedWebhookPayload, WebhookConversationAssignmentChangedWebhookRequest, WebhookConversationClosedWebhookPayload, WebhookConversationClosedWebhookRequest, WebhookConversationOpenedWebhookPayload, WebhookConversationOpenedWebhookRequest, WebhookDelivery, WebhookEvent, WebhookMessageDeliveredWebhookPayload, WebhookMessageDeliveredWebhookRequest, WebhookMessageFailedWebhookPayload, WebhookMessageFailedWebhookRequest, WebhookMessageReadWebhookPayload, WebhookMessageReadWebhookRequest, WebhookMessageReceivedWebhookPayload, WebhookMessageReceivedWebhookRequest, WebhookMessageSentWebhookPayload, WebhookMessageSentWebhookRequest, Webhooks, WebhookTestResult, WebhookWebhookTestWebhookPayload, WebhookWebhookTestWebhookRequest, WhatsAppNumber, Workflow, WorkflowExecution } from './types.gen.js';
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';
@@ -1,7 +1,7 @@
1
1
  export type ClientOptions = {
2
2
  baseUrl: 'https://getricky.ai/api/v1' | (string & {});
3
3
  };
4
- export type Webhooks = WebhookMessageReceivedWebhookRequest | WebhookMessageSentWebhookRequest | WebhookMessageDeliveredWebhookRequest | WebhookMessageReadWebhookRequest | WebhookMessageFailedWebhookRequest | WebhookConversationOpenedWebhookRequest | WebhookConversationClosedWebhookRequest | WebhookConversationAssignmentChangedWebhookRequest | WebhookContactCreatedWebhookRequest | WebhookContactUpdatedWebhookRequest | WebhookWebhookTestWebhookRequest;
4
+ export type Webhooks = WebhookMessageReceivedWebhookRequest | WebhookMessageSentWebhookRequest | WebhookMessageDeliveredWebhookRequest | WebhookMessageReadWebhookRequest | WebhookMessageFailedWebhookRequest | WebhookConversationOpenedWebhookRequest | WebhookConversationClosedWebhookRequest | WebhookConversationAssignmentChangedWebhookRequest | WebhookConversationAgentChangedWebhookRequest | WebhookConversationHandoffRequestedWebhookRequest | WebhookConversationHandoffResolvedWebhookRequest | WebhookContactCreatedWebhookRequest | WebhookContactUpdatedWebhookRequest | WebhookContactTagsChangedWebhookRequest | WebhookBroadcastCompletedWebhookRequest | WebhookBroadcastFailedWebhookRequest | WebhookTemplateStatusChangedWebhookRequest | WebhookWorkflowExecutionFailedWebhookRequest | WebhookKnowledgeFileReadyWebhookRequest | WebhookWebhookTestWebhookRequest;
5
5
  /**
6
6
  * Every non-2xx response.
7
7
  */
@@ -734,6 +734,203 @@ export type BroadcastRecipient = {
734
734
  */
735
735
  status_updated_at: string | null;
736
736
  };
737
+ /**
738
+ * A branch or place the agents can send as a WhatsApp location.
739
+ */
740
+ export type KnowledgeLocation = {
741
+ /**
742
+ * Location ID.
743
+ */
744
+ id: string;
745
+ /**
746
+ * Name customers know it by.
747
+ */
748
+ name: string;
749
+ /**
750
+ * Full address as customers read it.
751
+ */
752
+ address: string;
753
+ /**
754
+ * Latitude of the map pin.
755
+ */
756
+ latitude: number;
757
+ /**
758
+ * Longitude of the map pin.
759
+ */
760
+ longitude: number;
761
+ /**
762
+ * Street.
763
+ */
764
+ street: string | null;
765
+ /**
766
+ * City.
767
+ */
768
+ city: string | null;
769
+ /**
770
+ * State, province or region.
771
+ */
772
+ state: string | null;
773
+ /**
774
+ * Postal code.
775
+ */
776
+ postal_code: string | null;
777
+ /**
778
+ * Country.
779
+ */
780
+ country: string | null;
781
+ /**
782
+ * Country code, ISO 3166-1 alpha-2.
783
+ */
784
+ country_code: string | null;
785
+ /**
786
+ * Phone in E.164.
787
+ */
788
+ phone: string | null;
789
+ /**
790
+ * Email.
791
+ */
792
+ email: string | null;
793
+ /**
794
+ * Opening hours, as free text.
795
+ */
796
+ hours: string | null;
797
+ };
798
+ /**
799
+ * A contact card in the knowledge directory, which agents can send to customers.
800
+ */
801
+ export type KnowledgeContact = {
802
+ /**
803
+ * Knowledge contact ID.
804
+ */
805
+ id: string;
806
+ /**
807
+ * Name shown on the contact card.
808
+ */
809
+ display_name: string;
810
+ /**
811
+ * First name.
812
+ */
813
+ first_name: string | null;
814
+ /**
815
+ * Last name.
816
+ */
817
+ last_name: string | null;
818
+ /**
819
+ * Name prefix, such as `Dr.`.
820
+ */
821
+ prefix: string | null;
822
+ /**
823
+ * Name suffix.
824
+ */
825
+ suffix: string | null;
826
+ /**
827
+ * Company.
828
+ */
829
+ company: string | null;
830
+ /**
831
+ * Department.
832
+ */
833
+ department: string | null;
834
+ /**
835
+ * Job title.
836
+ */
837
+ job_title: string | null;
838
+ /**
839
+ * When the agents should share it.
840
+ */
841
+ description: string | null;
842
+ /**
843
+ * Phone in E.164.
844
+ */
845
+ phone: string | null;
846
+ /**
847
+ * `CELL`, `WORK` or `HOME`.
848
+ */
849
+ phone_type: string | null;
850
+ /**
851
+ * Email.
852
+ */
853
+ email: string | null;
854
+ /**
855
+ * `WORK` or `PERSONAL`.
856
+ */
857
+ email_type: string | null;
858
+ };
859
+ /**
860
+ * A document or image the agents can consult or send.
861
+ */
862
+ export type KnowledgeFile = {
863
+ /**
864
+ * File ID.
865
+ */
866
+ id: string;
867
+ /**
868
+ * Title the agents see.
869
+ */
870
+ title: string;
871
+ /**
872
+ * When the agents should use it; may be empty.
873
+ */
874
+ description: string;
875
+ /**
876
+ * Original file name.
877
+ */
878
+ filename: string;
879
+ /**
880
+ * File type.
881
+ */
882
+ mime_type: 'application/pdf' | 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' | 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' | 'image/jpeg' | 'image/png';
883
+ /**
884
+ * Size in bytes.
885
+ */
886
+ size_bytes: number;
887
+ /**
888
+ * `uploading` until `POST /knowledge/files/{file_id}/complete` reads it; then `ready`.
889
+ */
890
+ status: 'uploading' | 'ready' | 'failed';
891
+ /**
892
+ * Agents may read it to answer.
893
+ */
894
+ consult_enabled: boolean;
895
+ /**
896
+ * Agents may send the file itself to customers.
897
+ */
898
+ send_enabled: boolean;
899
+ /**
900
+ * Pages of a PDF; null otherwise.
901
+ */
902
+ page_count: number | null;
903
+ /**
904
+ * Start of the text Ricky read from it.
905
+ */
906
+ preview: string | null;
907
+ /**
908
+ * Why Ricky could not read useful content; null when it could.
909
+ */
910
+ extraction_error: string | null;
911
+ /**
912
+ * Signed download URL, valid for five minutes. Only `GET /knowledge/files/{file_id}` of a `ready` file carries it; null elsewhere.
913
+ */
914
+ download_url: string | null;
915
+ /**
916
+ * When the upload began.
917
+ */
918
+ created_at: string;
919
+ /**
920
+ * Last change.
921
+ */
922
+ updated_at: string;
923
+ };
924
+ /**
925
+ * A file waiting for its bytes, and where to put them.
926
+ */
927
+ export type KnowledgeFileUpload = {
928
+ file: KnowledgeFile;
929
+ /**
930
+ * Signed URL valid for two hours. `PUT` the file bytes to it with `Content-Type` set to `mime_type`, then call `POST /knowledge/files/{file_id}/complete`.
931
+ */
932
+ upload_url: string;
933
+ };
737
934
  /**
738
935
  * A webhook subscription.
739
936
  */
@@ -746,7 +943,7 @@ export type Webhook = {
746
943
  * HTTPS endpoint Ricky posts to.
747
944
  */
748
945
  url: string;
749
- event_types: Array<'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'contact.created' | 'contact.updated'>;
946
+ event_types: Array<'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'conversation.agent_changed' | 'conversation.handoff_requested' | 'conversation.handoff_resolved' | 'contact.created' | 'contact.updated' | 'contact.tags_changed' | 'broadcast.completed' | 'broadcast.failed' | 'template.status_changed' | 'workflow.execution_failed' | 'knowledge_file.ready'>;
750
947
  status: 'active' | 'disabled';
751
948
  /**
752
949
  * When it was created.
@@ -769,7 +966,7 @@ export type CreatedWebhook = {
769
966
  * HTTPS endpoint Ricky posts to.
770
967
  */
771
968
  url: string;
772
- event_types: Array<'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'contact.created' | 'contact.updated'>;
969
+ event_types: Array<'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'conversation.agent_changed' | 'conversation.handoff_requested' | 'conversation.handoff_resolved' | 'contact.created' | 'contact.updated' | 'contact.tags_changed' | 'broadcast.completed' | 'broadcast.failed' | 'template.status_changed' | 'workflow.execution_failed' | 'knowledge_file.ready'>;
773
970
  status: 'active' | 'disabled';
774
971
  /**
775
972
  * When it was created.
@@ -792,7 +989,7 @@ export type WebhookDelivery = {
792
989
  * Delivery ID; equals the event `id` and `X-Ricky-Delivery-Id`.
793
990
  */
794
991
  id: string;
795
- event_type: 'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'contact.created' | 'contact.updated';
992
+ event_type: 'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'conversation.agent_changed' | 'conversation.handoff_requested' | 'conversation.handoff_resolved' | 'contact.created' | 'contact.updated' | 'contact.tags_changed' | 'broadcast.completed' | 'broadcast.failed' | 'template.status_changed' | 'workflow.execution_failed' | 'knowledge_file.ready';
796
993
  status: 'pending' | 'processing' | 'delivered' | 'failed';
797
994
  /**
798
995
  * Delivery attempts so far; Ricky makes at most ten.
@@ -827,7 +1024,7 @@ export type WebhookEvent = {
827
1024
  * Delivery ID. Deduplicate by it.
828
1025
  */
829
1026
  id: string;
830
- type: 'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'contact.created' | 'contact.updated' | 'webhook.test';
1027
+ type: 'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'conversation.agent_changed' | 'conversation.handoff_requested' | 'conversation.handoff_resolved' | 'contact.created' | 'contact.updated' | 'contact.tags_changed' | 'broadcast.completed' | 'broadcast.failed' | 'template.status_changed' | 'workflow.execution_failed' | 'knowledge_file.ready' | 'webhook.test';
831
1028
  /**
832
1029
  * When it happened.
833
1030
  */
@@ -849,6 +1046,26 @@ export type WebhookEvent = {
849
1046
  * Contact, for `contact.*` events.
850
1047
  */
851
1048
  contact_id?: string;
1049
+ /**
1050
+ * Broadcast, for `broadcast.*` events.
1051
+ */
1052
+ broadcast_id?: string;
1053
+ /**
1054
+ * Template ID at Meta, for `template.status_changed`.
1055
+ */
1056
+ template_id?: string;
1057
+ /**
1058
+ * Workflow, for `workflow.execution_failed`.
1059
+ */
1060
+ workflow_id?: string;
1061
+ /**
1062
+ * Execution, for `workflow.execution_failed`.
1063
+ */
1064
+ workflow_execution_id?: string;
1065
+ /**
1066
+ * Knowledge file, for `knowledge_file.ready`.
1067
+ */
1068
+ knowledge_file_id?: string;
852
1069
  /**
853
1070
  * Webhook, for `webhook.test`.
854
1071
  */
@@ -967,203 +1184,6 @@ export type ConversationAssignmentResult = {
967
1184
  */
968
1185
  status: 'assigned' | 'not_found' | 'failed';
969
1186
  };
970
- /**
971
- * A branch or place the agents can send as a WhatsApp location.
972
- */
973
- export type KnowledgeLocation = {
974
- /**
975
- * Location ID.
976
- */
977
- id: string;
978
- /**
979
- * Name customers know it by.
980
- */
981
- name: string;
982
- /**
983
- * Full address as customers read it.
984
- */
985
- address: string;
986
- /**
987
- * Latitude of the map pin.
988
- */
989
- latitude: number;
990
- /**
991
- * Longitude of the map pin.
992
- */
993
- longitude: number;
994
- /**
995
- * Street.
996
- */
997
- street: string | null;
998
- /**
999
- * City.
1000
- */
1001
- city: string | null;
1002
- /**
1003
- * State, province or region.
1004
- */
1005
- state: string | null;
1006
- /**
1007
- * Postal code.
1008
- */
1009
- postal_code: string | null;
1010
- /**
1011
- * Country.
1012
- */
1013
- country: string | null;
1014
- /**
1015
- * Country code, ISO 3166-1 alpha-2.
1016
- */
1017
- country_code: string | null;
1018
- /**
1019
- * Phone in E.164.
1020
- */
1021
- phone: string | null;
1022
- /**
1023
- * Email.
1024
- */
1025
- email: string | null;
1026
- /**
1027
- * Opening hours, as free text.
1028
- */
1029
- hours: string | null;
1030
- };
1031
- /**
1032
- * A contact card in the knowledge directory, which agents can send to customers.
1033
- */
1034
- export type KnowledgeContact = {
1035
- /**
1036
- * Knowledge contact ID.
1037
- */
1038
- id: string;
1039
- /**
1040
- * Name shown on the contact card.
1041
- */
1042
- display_name: string;
1043
- /**
1044
- * First name.
1045
- */
1046
- first_name: string | null;
1047
- /**
1048
- * Last name.
1049
- */
1050
- last_name: string | null;
1051
- /**
1052
- * Name prefix, such as `Dr.`.
1053
- */
1054
- prefix: string | null;
1055
- /**
1056
- * Name suffix.
1057
- */
1058
- suffix: string | null;
1059
- /**
1060
- * Company.
1061
- */
1062
- company: string | null;
1063
- /**
1064
- * Department.
1065
- */
1066
- department: string | null;
1067
- /**
1068
- * Job title.
1069
- */
1070
- job_title: string | null;
1071
- /**
1072
- * When the agents should share it.
1073
- */
1074
- description: string | null;
1075
- /**
1076
- * Phone in E.164.
1077
- */
1078
- phone: string | null;
1079
- /**
1080
- * `CELL`, `WORK` or `HOME`.
1081
- */
1082
- phone_type: string | null;
1083
- /**
1084
- * Email.
1085
- */
1086
- email: string | null;
1087
- /**
1088
- * `WORK` or `PERSONAL`.
1089
- */
1090
- email_type: string | null;
1091
- };
1092
- /**
1093
- * A document or image the agents can consult or send.
1094
- */
1095
- export type KnowledgeFile = {
1096
- /**
1097
- * File ID.
1098
- */
1099
- id: string;
1100
- /**
1101
- * Title the agents see.
1102
- */
1103
- title: string;
1104
- /**
1105
- * When the agents should use it; may be empty.
1106
- */
1107
- description: string;
1108
- /**
1109
- * Original file name.
1110
- */
1111
- filename: string;
1112
- /**
1113
- * File type.
1114
- */
1115
- mime_type: 'application/pdf' | 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' | 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' | 'image/jpeg' | 'image/png';
1116
- /**
1117
- * Size in bytes.
1118
- */
1119
- size_bytes: number;
1120
- /**
1121
- * `uploading` until `POST /knowledge/files/{file_id}/complete` reads it; then `ready`.
1122
- */
1123
- status: 'uploading' | 'ready' | 'failed';
1124
- /**
1125
- * Agents may read it to answer.
1126
- */
1127
- consult_enabled: boolean;
1128
- /**
1129
- * Agents may send the file itself to customers.
1130
- */
1131
- send_enabled: boolean;
1132
- /**
1133
- * Pages of a PDF; null otherwise.
1134
- */
1135
- page_count: number | null;
1136
- /**
1137
- * Start of the text Ricky read from it.
1138
- */
1139
- preview: string | null;
1140
- /**
1141
- * Why Ricky could not read useful content; null when it could.
1142
- */
1143
- extraction_error: string | null;
1144
- /**
1145
- * Signed download URL, valid for five minutes. Only `GET /knowledge/files/{file_id}` of a `ready` file carries it; null elsewhere.
1146
- */
1147
- download_url: string | null;
1148
- /**
1149
- * When the upload began.
1150
- */
1151
- created_at: string;
1152
- /**
1153
- * Last change.
1154
- */
1155
- updated_at: string;
1156
- };
1157
- /**
1158
- * A file waiting for its bytes, and where to put them.
1159
- */
1160
- export type KnowledgeFileUpload = {
1161
- file: KnowledgeFile;
1162
- /**
1163
- * Signed URL valid for two hours. `PUT` the file bytes to it with `Content-Type` set to `mime_type`, then call `POST /knowledge/files/{file_id}/complete`.
1164
- */
1165
- upload_url: string;
1166
- };
1167
1187
  /**
1168
1188
  * The days a report covers, in America/Panama time, and the period it is compared with.
1169
1189
  */
@@ -3112,7 +3132,7 @@ export type CreateWebhook = {
3112
3132
  * Public HTTPS endpoint.
3113
3133
  */
3114
3134
  url: string;
3115
- event_types: Array<'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'contact.created' | 'contact.updated'>;
3135
+ event_types: Array<'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'conversation.agent_changed' | 'conversation.handoff_requested' | 'conversation.handoff_resolved' | 'contact.created' | 'contact.updated' | 'contact.tags_changed' | 'broadcast.completed' | 'broadcast.failed' | 'template.status_changed' | 'workflow.execution_failed' | 'knowledge_file.ready'>;
3116
3136
  };
3117
3137
  export type RotateWebhookSecret = {
3118
3138
  /**
@@ -9659,6 +9679,27 @@ export type WebhookConversationAssignmentChangedWebhookRequest = {
9659
9679
  path?: never;
9660
9680
  query?: never;
9661
9681
  };
9682
+ export type WebhookConversationAgentChangedWebhookPayload = WebhookEvent;
9683
+ export type WebhookConversationAgentChangedWebhookRequest = {
9684
+ body: WebhookConversationAgentChangedWebhookPayload;
9685
+ key: 'conversation.agent_changed';
9686
+ path?: never;
9687
+ query?: never;
9688
+ };
9689
+ export type WebhookConversationHandoffRequestedWebhookPayload = WebhookEvent;
9690
+ export type WebhookConversationHandoffRequestedWebhookRequest = {
9691
+ body: WebhookConversationHandoffRequestedWebhookPayload;
9692
+ key: 'conversation.handoff_requested';
9693
+ path?: never;
9694
+ query?: never;
9695
+ };
9696
+ export type WebhookConversationHandoffResolvedWebhookPayload = WebhookEvent;
9697
+ export type WebhookConversationHandoffResolvedWebhookRequest = {
9698
+ body: WebhookConversationHandoffResolvedWebhookPayload;
9699
+ key: 'conversation.handoff_resolved';
9700
+ path?: never;
9701
+ query?: never;
9702
+ };
9662
9703
  export type WebhookContactCreatedWebhookPayload = WebhookEvent;
9663
9704
  export type WebhookContactCreatedWebhookRequest = {
9664
9705
  body: WebhookContactCreatedWebhookPayload;
@@ -9673,6 +9714,48 @@ export type WebhookContactUpdatedWebhookRequest = {
9673
9714
  path?: never;
9674
9715
  query?: never;
9675
9716
  };
9717
+ export type WebhookContactTagsChangedWebhookPayload = WebhookEvent;
9718
+ export type WebhookContactTagsChangedWebhookRequest = {
9719
+ body: WebhookContactTagsChangedWebhookPayload;
9720
+ key: 'contact.tags_changed';
9721
+ path?: never;
9722
+ query?: never;
9723
+ };
9724
+ export type WebhookBroadcastCompletedWebhookPayload = WebhookEvent;
9725
+ export type WebhookBroadcastCompletedWebhookRequest = {
9726
+ body: WebhookBroadcastCompletedWebhookPayload;
9727
+ key: 'broadcast.completed';
9728
+ path?: never;
9729
+ query?: never;
9730
+ };
9731
+ export type WebhookBroadcastFailedWebhookPayload = WebhookEvent;
9732
+ export type WebhookBroadcastFailedWebhookRequest = {
9733
+ body: WebhookBroadcastFailedWebhookPayload;
9734
+ key: 'broadcast.failed';
9735
+ path?: never;
9736
+ query?: never;
9737
+ };
9738
+ export type WebhookTemplateStatusChangedWebhookPayload = WebhookEvent;
9739
+ export type WebhookTemplateStatusChangedWebhookRequest = {
9740
+ body: WebhookTemplateStatusChangedWebhookPayload;
9741
+ key: 'template.status_changed';
9742
+ path?: never;
9743
+ query?: never;
9744
+ };
9745
+ export type WebhookWorkflowExecutionFailedWebhookPayload = WebhookEvent;
9746
+ export type WebhookWorkflowExecutionFailedWebhookRequest = {
9747
+ body: WebhookWorkflowExecutionFailedWebhookPayload;
9748
+ key: 'workflow.execution_failed';
9749
+ path?: never;
9750
+ query?: never;
9751
+ };
9752
+ export type WebhookKnowledgeFileReadyWebhookPayload = WebhookEvent;
9753
+ export type WebhookKnowledgeFileReadyWebhookRequest = {
9754
+ body: WebhookKnowledgeFileReadyWebhookPayload;
9755
+ key: 'knowledge_file.ready';
9756
+ path?: never;
9757
+ query?: never;
9758
+ };
9676
9759
  export type WebhookWebhookTestWebhookPayload = WebhookEvent;
9677
9760
  export type WebhookWebhookTestWebhookRequest = {
9678
9761
  body: WebhookWebhookTestWebhookPayload;
@@ -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, WebhookContactCreatedWebhookPayload, WebhookContactCreatedWebhookRequest, WebhookContactUpdatedWebhookPayload, WebhookContactUpdatedWebhookRequest, WebhookConversationAssignmentChangedWebhookPayload, WebhookConversationAssignmentChangedWebhookRequest, WebhookConversationClosedWebhookPayload, WebhookConversationClosedWebhookRequest, WebhookConversationOpenedWebhookPayload, WebhookConversationOpenedWebhookRequest, WebhookDelivery, WebhookEvent, WebhookMessageDeliveredWebhookPayload, WebhookMessageDeliveredWebhookRequest, WebhookMessageFailedWebhookPayload, WebhookMessageFailedWebhookRequest, WebhookMessageReadWebhookPayload, WebhookMessageReadWebhookRequest, WebhookMessageReceivedWebhookPayload, WebhookMessageReceivedWebhookRequest, WebhookMessageSentWebhookPayload, WebhookMessageSentWebhookRequest, Webhooks, WebhookTestResult, WebhookWebhookTestWebhookPayload, WebhookWebhookTestWebhookRequest, WhatsAppNumber, Workflow, WorkflowExecution } from './types.gen.js';
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';
@@ -1,7 +1,7 @@
1
1
  export type ClientOptions = {
2
2
  baseUrl: 'https://getricky.ai/api/v1' | (string & {});
3
3
  };
4
- export type Webhooks = WebhookMessageReceivedWebhookRequest | WebhookMessageSentWebhookRequest | WebhookMessageDeliveredWebhookRequest | WebhookMessageReadWebhookRequest | WebhookMessageFailedWebhookRequest | WebhookConversationOpenedWebhookRequest | WebhookConversationClosedWebhookRequest | WebhookConversationAssignmentChangedWebhookRequest | WebhookContactCreatedWebhookRequest | WebhookContactUpdatedWebhookRequest | WebhookWebhookTestWebhookRequest;
4
+ export type Webhooks = WebhookMessageReceivedWebhookRequest | WebhookMessageSentWebhookRequest | WebhookMessageDeliveredWebhookRequest | WebhookMessageReadWebhookRequest | WebhookMessageFailedWebhookRequest | WebhookConversationOpenedWebhookRequest | WebhookConversationClosedWebhookRequest | WebhookConversationAssignmentChangedWebhookRequest | WebhookConversationAgentChangedWebhookRequest | WebhookConversationHandoffRequestedWebhookRequest | WebhookConversationHandoffResolvedWebhookRequest | WebhookContactCreatedWebhookRequest | WebhookContactUpdatedWebhookRequest | WebhookContactTagsChangedWebhookRequest | WebhookBroadcastCompletedWebhookRequest | WebhookBroadcastFailedWebhookRequest | WebhookTemplateStatusChangedWebhookRequest | WebhookWorkflowExecutionFailedWebhookRequest | WebhookKnowledgeFileReadyWebhookRequest | WebhookWebhookTestWebhookRequest;
5
5
  /**
6
6
  * Every non-2xx response.
7
7
  */
@@ -734,6 +734,203 @@ export type BroadcastRecipient = {
734
734
  */
735
735
  status_updated_at: string | null;
736
736
  };
737
+ /**
738
+ * A branch or place the agents can send as a WhatsApp location.
739
+ */
740
+ export type KnowledgeLocation = {
741
+ /**
742
+ * Location ID.
743
+ */
744
+ id: string;
745
+ /**
746
+ * Name customers know it by.
747
+ */
748
+ name: string;
749
+ /**
750
+ * Full address as customers read it.
751
+ */
752
+ address: string;
753
+ /**
754
+ * Latitude of the map pin.
755
+ */
756
+ latitude: number;
757
+ /**
758
+ * Longitude of the map pin.
759
+ */
760
+ longitude: number;
761
+ /**
762
+ * Street.
763
+ */
764
+ street: string | null;
765
+ /**
766
+ * City.
767
+ */
768
+ city: string | null;
769
+ /**
770
+ * State, province or region.
771
+ */
772
+ state: string | null;
773
+ /**
774
+ * Postal code.
775
+ */
776
+ postal_code: string | null;
777
+ /**
778
+ * Country.
779
+ */
780
+ country: string | null;
781
+ /**
782
+ * Country code, ISO 3166-1 alpha-2.
783
+ */
784
+ country_code: string | null;
785
+ /**
786
+ * Phone in E.164.
787
+ */
788
+ phone: string | null;
789
+ /**
790
+ * Email.
791
+ */
792
+ email: string | null;
793
+ /**
794
+ * Opening hours, as free text.
795
+ */
796
+ hours: string | null;
797
+ };
798
+ /**
799
+ * A contact card in the knowledge directory, which agents can send to customers.
800
+ */
801
+ export type KnowledgeContact = {
802
+ /**
803
+ * Knowledge contact ID.
804
+ */
805
+ id: string;
806
+ /**
807
+ * Name shown on the contact card.
808
+ */
809
+ display_name: string;
810
+ /**
811
+ * First name.
812
+ */
813
+ first_name: string | null;
814
+ /**
815
+ * Last name.
816
+ */
817
+ last_name: string | null;
818
+ /**
819
+ * Name prefix, such as `Dr.`.
820
+ */
821
+ prefix: string | null;
822
+ /**
823
+ * Name suffix.
824
+ */
825
+ suffix: string | null;
826
+ /**
827
+ * Company.
828
+ */
829
+ company: string | null;
830
+ /**
831
+ * Department.
832
+ */
833
+ department: string | null;
834
+ /**
835
+ * Job title.
836
+ */
837
+ job_title: string | null;
838
+ /**
839
+ * When the agents should share it.
840
+ */
841
+ description: string | null;
842
+ /**
843
+ * Phone in E.164.
844
+ */
845
+ phone: string | null;
846
+ /**
847
+ * `CELL`, `WORK` or `HOME`.
848
+ */
849
+ phone_type: string | null;
850
+ /**
851
+ * Email.
852
+ */
853
+ email: string | null;
854
+ /**
855
+ * `WORK` or `PERSONAL`.
856
+ */
857
+ email_type: string | null;
858
+ };
859
+ /**
860
+ * A document or image the agents can consult or send.
861
+ */
862
+ export type KnowledgeFile = {
863
+ /**
864
+ * File ID.
865
+ */
866
+ id: string;
867
+ /**
868
+ * Title the agents see.
869
+ */
870
+ title: string;
871
+ /**
872
+ * When the agents should use it; may be empty.
873
+ */
874
+ description: string;
875
+ /**
876
+ * Original file name.
877
+ */
878
+ filename: string;
879
+ /**
880
+ * File type.
881
+ */
882
+ mime_type: 'application/pdf' | 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' | 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' | 'image/jpeg' | 'image/png';
883
+ /**
884
+ * Size in bytes.
885
+ */
886
+ size_bytes: number;
887
+ /**
888
+ * `uploading` until `POST /knowledge/files/{file_id}/complete` reads it; then `ready`.
889
+ */
890
+ status: 'uploading' | 'ready' | 'failed';
891
+ /**
892
+ * Agents may read it to answer.
893
+ */
894
+ consult_enabled: boolean;
895
+ /**
896
+ * Agents may send the file itself to customers.
897
+ */
898
+ send_enabled: boolean;
899
+ /**
900
+ * Pages of a PDF; null otherwise.
901
+ */
902
+ page_count: number | null;
903
+ /**
904
+ * Start of the text Ricky read from it.
905
+ */
906
+ preview: string | null;
907
+ /**
908
+ * Why Ricky could not read useful content; null when it could.
909
+ */
910
+ extraction_error: string | null;
911
+ /**
912
+ * Signed download URL, valid for five minutes. Only `GET /knowledge/files/{file_id}` of a `ready` file carries it; null elsewhere.
913
+ */
914
+ download_url: string | null;
915
+ /**
916
+ * When the upload began.
917
+ */
918
+ created_at: string;
919
+ /**
920
+ * Last change.
921
+ */
922
+ updated_at: string;
923
+ };
924
+ /**
925
+ * A file waiting for its bytes, and where to put them.
926
+ */
927
+ export type KnowledgeFileUpload = {
928
+ file: KnowledgeFile;
929
+ /**
930
+ * Signed URL valid for two hours. `PUT` the file bytes to it with `Content-Type` set to `mime_type`, then call `POST /knowledge/files/{file_id}/complete`.
931
+ */
932
+ upload_url: string;
933
+ };
737
934
  /**
738
935
  * A webhook subscription.
739
936
  */
@@ -746,7 +943,7 @@ export type Webhook = {
746
943
  * HTTPS endpoint Ricky posts to.
747
944
  */
748
945
  url: string;
749
- event_types: Array<'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'contact.created' | 'contact.updated'>;
946
+ event_types: Array<'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'conversation.agent_changed' | 'conversation.handoff_requested' | 'conversation.handoff_resolved' | 'contact.created' | 'contact.updated' | 'contact.tags_changed' | 'broadcast.completed' | 'broadcast.failed' | 'template.status_changed' | 'workflow.execution_failed' | 'knowledge_file.ready'>;
750
947
  status: 'active' | 'disabled';
751
948
  /**
752
949
  * When it was created.
@@ -769,7 +966,7 @@ export type CreatedWebhook = {
769
966
  * HTTPS endpoint Ricky posts to.
770
967
  */
771
968
  url: string;
772
- event_types: Array<'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'contact.created' | 'contact.updated'>;
969
+ event_types: Array<'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'conversation.agent_changed' | 'conversation.handoff_requested' | 'conversation.handoff_resolved' | 'contact.created' | 'contact.updated' | 'contact.tags_changed' | 'broadcast.completed' | 'broadcast.failed' | 'template.status_changed' | 'workflow.execution_failed' | 'knowledge_file.ready'>;
773
970
  status: 'active' | 'disabled';
774
971
  /**
775
972
  * When it was created.
@@ -792,7 +989,7 @@ export type WebhookDelivery = {
792
989
  * Delivery ID; equals the event `id` and `X-Ricky-Delivery-Id`.
793
990
  */
794
991
  id: string;
795
- event_type: 'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'contact.created' | 'contact.updated';
992
+ event_type: 'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'conversation.agent_changed' | 'conversation.handoff_requested' | 'conversation.handoff_resolved' | 'contact.created' | 'contact.updated' | 'contact.tags_changed' | 'broadcast.completed' | 'broadcast.failed' | 'template.status_changed' | 'workflow.execution_failed' | 'knowledge_file.ready';
796
993
  status: 'pending' | 'processing' | 'delivered' | 'failed';
797
994
  /**
798
995
  * Delivery attempts so far; Ricky makes at most ten.
@@ -827,7 +1024,7 @@ export type WebhookEvent = {
827
1024
  * Delivery ID. Deduplicate by it.
828
1025
  */
829
1026
  id: string;
830
- type: 'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'contact.created' | 'contact.updated' | 'webhook.test';
1027
+ type: 'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'conversation.agent_changed' | 'conversation.handoff_requested' | 'conversation.handoff_resolved' | 'contact.created' | 'contact.updated' | 'contact.tags_changed' | 'broadcast.completed' | 'broadcast.failed' | 'template.status_changed' | 'workflow.execution_failed' | 'knowledge_file.ready' | 'webhook.test';
831
1028
  /**
832
1029
  * When it happened.
833
1030
  */
@@ -849,6 +1046,26 @@ export type WebhookEvent = {
849
1046
  * Contact, for `contact.*` events.
850
1047
  */
851
1048
  contact_id?: string;
1049
+ /**
1050
+ * Broadcast, for `broadcast.*` events.
1051
+ */
1052
+ broadcast_id?: string;
1053
+ /**
1054
+ * Template ID at Meta, for `template.status_changed`.
1055
+ */
1056
+ template_id?: string;
1057
+ /**
1058
+ * Workflow, for `workflow.execution_failed`.
1059
+ */
1060
+ workflow_id?: string;
1061
+ /**
1062
+ * Execution, for `workflow.execution_failed`.
1063
+ */
1064
+ workflow_execution_id?: string;
1065
+ /**
1066
+ * Knowledge file, for `knowledge_file.ready`.
1067
+ */
1068
+ knowledge_file_id?: string;
852
1069
  /**
853
1070
  * Webhook, for `webhook.test`.
854
1071
  */
@@ -967,203 +1184,6 @@ export type ConversationAssignmentResult = {
967
1184
  */
968
1185
  status: 'assigned' | 'not_found' | 'failed';
969
1186
  };
970
- /**
971
- * A branch or place the agents can send as a WhatsApp location.
972
- */
973
- export type KnowledgeLocation = {
974
- /**
975
- * Location ID.
976
- */
977
- id: string;
978
- /**
979
- * Name customers know it by.
980
- */
981
- name: string;
982
- /**
983
- * Full address as customers read it.
984
- */
985
- address: string;
986
- /**
987
- * Latitude of the map pin.
988
- */
989
- latitude: number;
990
- /**
991
- * Longitude of the map pin.
992
- */
993
- longitude: number;
994
- /**
995
- * Street.
996
- */
997
- street: string | null;
998
- /**
999
- * City.
1000
- */
1001
- city: string | null;
1002
- /**
1003
- * State, province or region.
1004
- */
1005
- state: string | null;
1006
- /**
1007
- * Postal code.
1008
- */
1009
- postal_code: string | null;
1010
- /**
1011
- * Country.
1012
- */
1013
- country: string | null;
1014
- /**
1015
- * Country code, ISO 3166-1 alpha-2.
1016
- */
1017
- country_code: string | null;
1018
- /**
1019
- * Phone in E.164.
1020
- */
1021
- phone: string | null;
1022
- /**
1023
- * Email.
1024
- */
1025
- email: string | null;
1026
- /**
1027
- * Opening hours, as free text.
1028
- */
1029
- hours: string | null;
1030
- };
1031
- /**
1032
- * A contact card in the knowledge directory, which agents can send to customers.
1033
- */
1034
- export type KnowledgeContact = {
1035
- /**
1036
- * Knowledge contact ID.
1037
- */
1038
- id: string;
1039
- /**
1040
- * Name shown on the contact card.
1041
- */
1042
- display_name: string;
1043
- /**
1044
- * First name.
1045
- */
1046
- first_name: string | null;
1047
- /**
1048
- * Last name.
1049
- */
1050
- last_name: string | null;
1051
- /**
1052
- * Name prefix, such as `Dr.`.
1053
- */
1054
- prefix: string | null;
1055
- /**
1056
- * Name suffix.
1057
- */
1058
- suffix: string | null;
1059
- /**
1060
- * Company.
1061
- */
1062
- company: string | null;
1063
- /**
1064
- * Department.
1065
- */
1066
- department: string | null;
1067
- /**
1068
- * Job title.
1069
- */
1070
- job_title: string | null;
1071
- /**
1072
- * When the agents should share it.
1073
- */
1074
- description: string | null;
1075
- /**
1076
- * Phone in E.164.
1077
- */
1078
- phone: string | null;
1079
- /**
1080
- * `CELL`, `WORK` or `HOME`.
1081
- */
1082
- phone_type: string | null;
1083
- /**
1084
- * Email.
1085
- */
1086
- email: string | null;
1087
- /**
1088
- * `WORK` or `PERSONAL`.
1089
- */
1090
- email_type: string | null;
1091
- };
1092
- /**
1093
- * A document or image the agents can consult or send.
1094
- */
1095
- export type KnowledgeFile = {
1096
- /**
1097
- * File ID.
1098
- */
1099
- id: string;
1100
- /**
1101
- * Title the agents see.
1102
- */
1103
- title: string;
1104
- /**
1105
- * When the agents should use it; may be empty.
1106
- */
1107
- description: string;
1108
- /**
1109
- * Original file name.
1110
- */
1111
- filename: string;
1112
- /**
1113
- * File type.
1114
- */
1115
- mime_type: 'application/pdf' | 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' | 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' | 'image/jpeg' | 'image/png';
1116
- /**
1117
- * Size in bytes.
1118
- */
1119
- size_bytes: number;
1120
- /**
1121
- * `uploading` until `POST /knowledge/files/{file_id}/complete` reads it; then `ready`.
1122
- */
1123
- status: 'uploading' | 'ready' | 'failed';
1124
- /**
1125
- * Agents may read it to answer.
1126
- */
1127
- consult_enabled: boolean;
1128
- /**
1129
- * Agents may send the file itself to customers.
1130
- */
1131
- send_enabled: boolean;
1132
- /**
1133
- * Pages of a PDF; null otherwise.
1134
- */
1135
- page_count: number | null;
1136
- /**
1137
- * Start of the text Ricky read from it.
1138
- */
1139
- preview: string | null;
1140
- /**
1141
- * Why Ricky could not read useful content; null when it could.
1142
- */
1143
- extraction_error: string | null;
1144
- /**
1145
- * Signed download URL, valid for five minutes. Only `GET /knowledge/files/{file_id}` of a `ready` file carries it; null elsewhere.
1146
- */
1147
- download_url: string | null;
1148
- /**
1149
- * When the upload began.
1150
- */
1151
- created_at: string;
1152
- /**
1153
- * Last change.
1154
- */
1155
- updated_at: string;
1156
- };
1157
- /**
1158
- * A file waiting for its bytes, and where to put them.
1159
- */
1160
- export type KnowledgeFileUpload = {
1161
- file: KnowledgeFile;
1162
- /**
1163
- * Signed URL valid for two hours. `PUT` the file bytes to it with `Content-Type` set to `mime_type`, then call `POST /knowledge/files/{file_id}/complete`.
1164
- */
1165
- upload_url: string;
1166
- };
1167
1187
  /**
1168
1188
  * The days a report covers, in America/Panama time, and the period it is compared with.
1169
1189
  */
@@ -3112,7 +3132,7 @@ export type CreateWebhook = {
3112
3132
  * Public HTTPS endpoint.
3113
3133
  */
3114
3134
  url: string;
3115
- event_types: Array<'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'contact.created' | 'contact.updated'>;
3135
+ event_types: Array<'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'conversation.agent_changed' | 'conversation.handoff_requested' | 'conversation.handoff_resolved' | 'contact.created' | 'contact.updated' | 'contact.tags_changed' | 'broadcast.completed' | 'broadcast.failed' | 'template.status_changed' | 'workflow.execution_failed' | 'knowledge_file.ready'>;
3116
3136
  };
3117
3137
  export type RotateWebhookSecret = {
3118
3138
  /**
@@ -9659,6 +9679,27 @@ export type WebhookConversationAssignmentChangedWebhookRequest = {
9659
9679
  path?: never;
9660
9680
  query?: never;
9661
9681
  };
9682
+ export type WebhookConversationAgentChangedWebhookPayload = WebhookEvent;
9683
+ export type WebhookConversationAgentChangedWebhookRequest = {
9684
+ body: WebhookConversationAgentChangedWebhookPayload;
9685
+ key: 'conversation.agent_changed';
9686
+ path?: never;
9687
+ query?: never;
9688
+ };
9689
+ export type WebhookConversationHandoffRequestedWebhookPayload = WebhookEvent;
9690
+ export type WebhookConversationHandoffRequestedWebhookRequest = {
9691
+ body: WebhookConversationHandoffRequestedWebhookPayload;
9692
+ key: 'conversation.handoff_requested';
9693
+ path?: never;
9694
+ query?: never;
9695
+ };
9696
+ export type WebhookConversationHandoffResolvedWebhookPayload = WebhookEvent;
9697
+ export type WebhookConversationHandoffResolvedWebhookRequest = {
9698
+ body: WebhookConversationHandoffResolvedWebhookPayload;
9699
+ key: 'conversation.handoff_resolved';
9700
+ path?: never;
9701
+ query?: never;
9702
+ };
9662
9703
  export type WebhookContactCreatedWebhookPayload = WebhookEvent;
9663
9704
  export type WebhookContactCreatedWebhookRequest = {
9664
9705
  body: WebhookContactCreatedWebhookPayload;
@@ -9673,6 +9714,48 @@ export type WebhookContactUpdatedWebhookRequest = {
9673
9714
  path?: never;
9674
9715
  query?: never;
9675
9716
  };
9717
+ export type WebhookContactTagsChangedWebhookPayload = WebhookEvent;
9718
+ export type WebhookContactTagsChangedWebhookRequest = {
9719
+ body: WebhookContactTagsChangedWebhookPayload;
9720
+ key: 'contact.tags_changed';
9721
+ path?: never;
9722
+ query?: never;
9723
+ };
9724
+ export type WebhookBroadcastCompletedWebhookPayload = WebhookEvent;
9725
+ export type WebhookBroadcastCompletedWebhookRequest = {
9726
+ body: WebhookBroadcastCompletedWebhookPayload;
9727
+ key: 'broadcast.completed';
9728
+ path?: never;
9729
+ query?: never;
9730
+ };
9731
+ export type WebhookBroadcastFailedWebhookPayload = WebhookEvent;
9732
+ export type WebhookBroadcastFailedWebhookRequest = {
9733
+ body: WebhookBroadcastFailedWebhookPayload;
9734
+ key: 'broadcast.failed';
9735
+ path?: never;
9736
+ query?: never;
9737
+ };
9738
+ export type WebhookTemplateStatusChangedWebhookPayload = WebhookEvent;
9739
+ export type WebhookTemplateStatusChangedWebhookRequest = {
9740
+ body: WebhookTemplateStatusChangedWebhookPayload;
9741
+ key: 'template.status_changed';
9742
+ path?: never;
9743
+ query?: never;
9744
+ };
9745
+ export type WebhookWorkflowExecutionFailedWebhookPayload = WebhookEvent;
9746
+ export type WebhookWorkflowExecutionFailedWebhookRequest = {
9747
+ body: WebhookWorkflowExecutionFailedWebhookPayload;
9748
+ key: 'workflow.execution_failed';
9749
+ path?: never;
9750
+ query?: never;
9751
+ };
9752
+ export type WebhookKnowledgeFileReadyWebhookPayload = WebhookEvent;
9753
+ export type WebhookKnowledgeFileReadyWebhookRequest = {
9754
+ body: WebhookKnowledgeFileReadyWebhookPayload;
9755
+ key: 'knowledge_file.ready';
9756
+ path?: never;
9757
+ query?: never;
9758
+ };
9676
9759
  export type WebhookWebhookTestWebhookPayload = WebhookEvent;
9677
9760
  export type WebhookWebhookTestWebhookRequest = {
9678
9761
  body: WebhookWebhookTestWebhookPayload;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "getricky",
3
- "version": "0.1.9",
3
+ "version": "0.1.10",
4
4
  "description": "Official TypeScript SDK for the Ricky REST API",
5
5
  "keywords": [
6
6
  "api",