getricky 0.1.8 → 0.1.10

package/dist/cjs/generated/types.gen.d.ts

@@ -1,7 +1,7 @@
 export type ClientOptions = {
     baseUrl: 'https://getricky.ai/api/v1' | (string & {});
 };
-export type Webhooks = WebhookMessageReceivedWebhookRequest | WebhookMessageSentWebhookRequest | WebhookMessageDeliveredWebhookRequest | WebhookMessageReadWebhookRequest | WebhookMessageFailedWebhookRequest | WebhookConversationOpenedWebhookRequest | WebhookConversationClosedWebhookRequest | WebhookConversationAssignmentChangedWebhookRequest | WebhookContactCreatedWebhookRequest | WebhookContactUpdatedWebhookRequest | WebhookWebhookTestWebhookRequest;
+export type Webhooks = WebhookMessageReceivedWebhookRequest | WebhookMessageSentWebhookRequest | WebhookMessageDeliveredWebhookRequest | WebhookMessageReadWebhookRequest | WebhookMessageFailedWebhookRequest | WebhookConversationOpenedWebhookRequest | WebhookConversationClosedWebhookRequest | WebhookConversationAssignmentChangedWebhookRequest | WebhookConversationAgentChangedWebhookRequest | WebhookConversationHandoffRequestedWebhookRequest | WebhookConversationHandoffResolvedWebhookRequest | WebhookContactCreatedWebhookRequest | WebhookContactUpdatedWebhookRequest | WebhookContactTagsChangedWebhookRequest | WebhookBroadcastCompletedWebhookRequest | WebhookBroadcastFailedWebhookRequest | WebhookTemplateStatusChangedWebhookRequest | WebhookWorkflowExecutionFailedWebhookRequest | WebhookKnowledgeFileReadyWebhookRequest | WebhookWebhookTestWebhookRequest;
 /**
  * Every non-2xx response.
  */
@@ -330,6 +330,36 @@ export type Channel = {
      */
     connected_at: string | null;
 };
+/**
+ * A request for a person to take over from the AI agent, not resolved yet.
+ */
+export type ConversationHandoff = {
+    /**
+     * Handoff ID.
+     */
+    id: string;
+    /**
+     * `requested` until a member takes it; `assigned` once someone is responsible.
+     */
+    status: 'requested' | 'assigned';
+    /**
+     * Whether the AI agent or a member asked for it.
+     */
+    requested_by: 'agent' | 'operator';
+    /**
+     * Why the conversation needs a person.
+     */
+    reason: 'customer_requested' | 'low_confidence' | 'manual_takeover' | 'out_of_scope' | 'sensitive' | 'other';
+    /**
+     * What the person taking over needs to know.
+     */
+    summary: string;
+    assigned_user_id: string | null;
+    /**
+     * When it was requested.
+     */
+    requested_at: string;
+};
 /**
  * One contact talking to the organization on one channel.
  */
@@ -387,6 +417,14 @@ export type Conversation = {
      * Text of the latest message.
      */
     last_activity_preview: string | null;
+    /**
+     * Whether it has messages the team has not read.
+     */
+    unread: boolean;
+    /**
+     * The handoff to a person waiting to be resolved; null when there is none.
+     */
+    active_handoff: ConversationHandoff | null;
 };
 /**
  * One message in a conversation.
@@ -696,6 +734,203 @@ export type BroadcastRecipient = {
      */
     status_updated_at: string | null;
 };
+/**
+ * A branch or place the agents can send as a WhatsApp location.
+ */
+export type KnowledgeLocation = {
+    /**
+     * Location ID.
+     */
+    id: string;
+    /**
+     * Name customers know it by.
+     */
+    name: string;
+    /**
+     * Full address as customers read it.
+     */
+    address: string;
+    /**
+     * Latitude of the map pin.
+     */
+    latitude: number;
+    /**
+     * Longitude of the map pin.
+     */
+    longitude: number;
+    /**
+     * Street.
+     */
+    street: string | null;
+    /**
+     * City.
+     */
+    city: string | null;
+    /**
+     * State, province or region.
+     */
+    state: string | null;
+    /**
+     * Postal code.
+     */
+    postal_code: string | null;
+    /**
+     * Country.
+     */
+    country: string | null;
+    /**
+     * Country code, ISO 3166-1 alpha-2.
+     */
+    country_code: string | null;
+    /**
+     * Phone in E.164.
+     */
+    phone: string | null;
+    /**
+     * Email.
+     */
+    email: string | null;
+    /**
+     * Opening hours, as free text.
+     */
+    hours: string | null;
+};
+/**
+ * A contact card in the knowledge directory, which agents can send to customers.
+ */
+export type KnowledgeContact = {
+    /**
+     * Knowledge contact ID.
+     */
+    id: string;
+    /**
+     * Name shown on the contact card.
+     */
+    display_name: string;
+    /**
+     * First name.
+     */
+    first_name: string | null;
+    /**
+     * Last name.
+     */
+    last_name: string | null;
+    /**
+     * Name prefix, such as `Dr.`.
+     */
+    prefix: string | null;
+    /**
+     * Name suffix.
+     */
+    suffix: string | null;
+    /**
+     * Company.
+     */
+    company: string | null;
+    /**
+     * Department.
+     */
+    department: string | null;
+    /**
+     * Job title.
+     */
+    job_title: string | null;
+    /**
+     * When the agents should share it.
+     */
+    description: string | null;
+    /**
+     * Phone in E.164.
+     */
+    phone: string | null;
+    /**
+     * `CELL`, `WORK` or `HOME`.
+     */
+    phone_type: string | null;
+    /**
+     * Email.
+     */
+    email: string | null;
+    /**
+     * `WORK` or `PERSONAL`.
+     */
+    email_type: string | null;
+};
+/**
+ * A document or image the agents can consult or send.
+ */
+export type KnowledgeFile = {
+    /**
+     * File ID.
+     */
+    id: string;
+    /**
+     * Title the agents see.
+     */
+    title: string;
+    /**
+     * When the agents should use it; may be empty.
+     */
+    description: string;
+    /**
+     * Original file name.
+     */
+    filename: string;
+    /**
+     * File type.
+     */
+    mime_type: 'application/pdf' | 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' | 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' | 'image/jpeg' | 'image/png';
+    /**
+     * Size in bytes.
+     */
+    size_bytes: number;
+    /**
+     * `uploading` until `POST /knowledge/files/{file_id}/complete` reads it; then `ready`.
+     */
+    status: 'uploading' | 'ready' | 'failed';
+    /**
+     * Agents may read it to answer.
+     */
+    consult_enabled: boolean;
+    /**
+     * Agents may send the file itself to customers.
+     */
+    send_enabled: boolean;
+    /**
+     * Pages of a PDF; null otherwise.
+     */
+    page_count: number | null;
+    /**
+     * Start of the text Ricky read from it.
+     */
+    preview: string | null;
+    /**
+     * Why Ricky could not read useful content; null when it could.
+     */
+    extraction_error: string | null;
+    /**
+     * Signed download URL, valid for five minutes. Only `GET /knowledge/files/{file_id}` of a `ready` file carries it; null elsewhere.
+     */
+    download_url: string | null;
+    /**
+     * When the upload began.
+     */
+    created_at: string;
+    /**
+     * Last change.
+     */
+    updated_at: string;
+};
+/**
+ * A file waiting for its bytes, and where to put them.
+ */
+export type KnowledgeFileUpload = {
+    file: KnowledgeFile;
+    /**
+     * 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`.
+     */
+    upload_url: string;
+};
 /**
  * A webhook subscription.
  */
@@ -708,7 +943,7 @@ export type Webhook = {
      * HTTPS endpoint Ricky posts to.
      */
     url: string;
-    event_types: Array<'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'contact.created' | 'contact.updated'>;
+    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'>;
     status: 'active' | 'disabled';
     /**
      * When it was created.
@@ -731,7 +966,7 @@ export type CreatedWebhook = {
      * HTTPS endpoint Ricky posts to.
      */
     url: string;
-    event_types: Array<'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'contact.created' | 'contact.updated'>;
+    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'>;
     status: 'active' | 'disabled';
     /**
      * When it was created.
@@ -754,7 +989,7 @@ export type WebhookDelivery = {
      * Delivery ID; equals the event `id` and `X-Ricky-Delivery-Id`.
      */
     id: string;
-    event_type: 'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'contact.created' | 'contact.updated';
+    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';
     status: 'pending' | 'processing' | 'delivered' | 'failed';
     /**
      * Delivery attempts so far; Ricky makes at most ten.
@@ -789,7 +1024,7 @@ export type WebhookEvent = {
      * Delivery ID. Deduplicate by it.
      */
     id: string;
-    type: 'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'contact.created' | 'contact.updated' | 'webhook.test';
+    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';
     /**
      * When it happened.
      */
@@ -811,6 +1046,26 @@ export type WebhookEvent = {
          * Contact, for `contact.*` events.
          */
         contact_id?: string;
+        /**
+         * Broadcast, for `broadcast.*` events.
+         */
+        broadcast_id?: string;
+        /**
+         * Template ID at Meta, for `template.status_changed`.
+         */
+        template_id?: string;
+        /**
+         * Workflow, for `workflow.execution_failed`.
+         */
+        workflow_id?: string;
+        /**
+         * Execution, for `workflow.execution_failed`.
+         */
+        workflow_execution_id?: string;
+        /**
+         * Knowledge file, for `knowledge_file.ready`.
+         */
+        knowledge_file_id?: string;
         /**
          * Webhook, for `webhook.test`.
          */
@@ -913,201 +1168,21 @@ export type QuickReply = {
     body: string;
 };
 /**
- * A branch or place the agents can send as a WhatsApp location.
- */
-export type KnowledgeLocation = {
-    /**
-     * Location ID.
-     */
-    id: string;
-    /**
-     * Name customers know it by.
-     */
-    name: string;
-    /**
-     * Full address as customers read it.
-     */
-    address: string;
-    /**
-     * Latitude of the map pin.
-     */
-    latitude: number;
-    /**
-     * Longitude of the map pin.
-     */
-    longitude: number;
-    /**
-     * Street.
-     */
-    street: string | null;
-    /**
-     * City.
-     */
-    city: string | null;
-    /**
-     * State, province or region.
-     */
-    state: string | null;
-    /**
-     * Postal code.
-     */
-    postal_code: string | null;
-    /**
-     * Country.
-     */
-    country: string | null;
-    /**
-     * Country code, ISO 3166-1 alpha-2.
-     */
-    country_code: string | null;
-    /**
-     * Phone in E.164.
-     */
-    phone: string | null;
-    /**
-     * Email.
-     */
-    email: string | null;
-    /**
-     * Opening hours, as free text.
-     */
-    hours: string | null;
-};
-/**
- * A contact card in the knowledge directory, which agents can send to customers.
- */
-export type KnowledgeContact = {
-    /**
-     * Knowledge contact ID.
-     */
-    id: string;
-    /**
-     * Name shown on the contact card.
-     */
-    display_name: string;
-    /**
-     * First name.
-     */
-    first_name: string | null;
-    /**
-     * Last name.
-     */
-    last_name: string | null;
-    /**
-     * Name prefix, such as `Dr.`.
-     */
-    prefix: string | null;
-    /**
-     * Name suffix.
-     */
-    suffix: string | null;
-    /**
-     * Company.
-     */
-    company: string | null;
-    /**
-     * Department.
-     */
-    department: string | null;
-    /**
-     * Job title.
-     */
-    job_title: string | null;
-    /**
-     * When the agents should share it.
-     */
-    description: string | null;
-    /**
-     * Phone in E.164.
-     */
-    phone: string | null;
-    /**
-     * `CELL`, `WORK` or `HOME`.
-     */
-    phone_type: string | null;
-    /**
-     * Email.
-     */
-    email: string | null;
-    /**
-     * `WORK` or `PERSONAL`.
-     */
-    email_type: string | null;
-};
-/**
- * A document or image the agents can consult or send.
+ * What a bulk assignment did to one conversation.
  */
-export type KnowledgeFile = {
+export type ConversationAssignmentResult = {
     /**
-     * File ID.
-     */
-    id: string;
-    /**
-     * Title the agents see.
-     */
-    title: string;
-    /**
-     * When the agents should use it; may be empty.
-     */
-    description: string;
-    /**
-     * Original file name.
-     */
-    filename: string;
-    /**
-     * File type.
-     */
-    mime_type: 'application/pdf' | 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' | 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' | 'image/jpeg' | 'image/png';
-    /**
-     * Size in bytes.
-     */
-    size_bytes: number;
-    /**
-     * `uploading` until `POST /knowledge/files/{file_id}/complete` reads it; then `ready`.
-     */
-    status: 'uploading' | 'ready' | 'failed';
-    /**
-     * Agents may read it to answer.
-     */
-    consult_enabled: boolean;
-    /**
-     * Agents may send the file itself to customers.
-     */
-    send_enabled: boolean;
-    /**
-     * Pages of a PDF; null otherwise.
-     */
-    page_count: number | null;
-    /**
-     * Start of the text Ricky read from it.
-     */
-    preview: string | null;
-    /**
-     * Why Ricky could not read useful content; null when it could.
-     */
-    extraction_error: string | null;
-    /**
-     * Signed download URL, valid for five minutes. Only `GET /knowledge/files/{file_id}` of a `ready` file carries it; null elsewhere.
-     */
-    download_url: string | null;
-    /**
-     * When the upload began.
+     * Conversation ID.
      */
-    created_at: string;
+    conversation_id: string;
     /**
-     * Last change.
+     * Member it was to be assigned to.
      */
-    updated_at: string;
-};
-/**
- * A file waiting for its bytes, and where to put them.
- */
-export type KnowledgeFileUpload = {
-    file: KnowledgeFile;
+    assigned_user_id: string;
     /**
-     * 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`.
+     * `assigned`; `not_found` when the organization has no such conversation; `failed` when Ricky could not save it, so retry that conversation.
      */
-    upload_url: string;
+    status: 'assigned' | 'not_found' | 'failed';
 };
 /**
  * The days a report covers, in America/Panama time, and the period it is compared with.
@@ -2690,6 +2765,33 @@ export type AssignConversationAgent = {
      */
     agent_id: string | null;
 };
+/**
+ * How the handoff ends.
+ */
+export type ResolveHandoff = {
+    /**
+     * `returned_to_ai` gives the conversation back to the AI agent that asked for the handoff and unassigns the member; `stayed_with_human` leaves it with the member.
+     */
+    resolution: 'returned_to_ai' | 'stayed_with_human';
+};
+/**
+ * Makes members responsible for many conversations at once. Each member also becomes the contact's owner.
+ */
+export type AssignConversations = {
+    /**
+     * Up to 100 conversations, each once, with the member for each.
+     */
+    assignments: Array<{
+        /**
+         * Conversation to assign.
+         */
+        conversation_id: string;
+        /**
+         * Member who becomes responsible for it.
+         */
+        assigned_user_id: string;
+    }>;
+};
 /**
  * A contact needs at least a name, a phone or an email.
  */
@@ -2964,12 +3066,20 @@ export type SendMessage = {
      * Message text.
      */
     text: string;
+    /**
+     * Message of this conversation to quote, from `GET /conversations/{conversation_id}/messages`. WhatsApp only.
+     */
+    reply_to_message_id?: string;
 } | {
     type: 'template';
     template: TemplateMessage;
 } | {
     type: 'media';
     media: MediaMessage;
+    /**
+     * Message of this conversation to quote, from `GET /conversations/{conversation_id}/messages`. WhatsApp only.
+     */
+    reply_to_message_id?: string;
 };
 /**
  * Sends a template to a phone number.
@@ -3022,7 +3132,7 @@ export type CreateWebhook = {
      * Public HTTPS endpoint.
      */
     url: string;
-    event_types: Array<'message.received' | 'message.sent' | 'message.delivered' | 'message.read' | 'message.failed' | 'conversation.opened' | 'conversation.closed' | 'conversation.assignment_changed' | 'contact.created' | 'contact.updated'>;
+    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'>;
 };
 export type RotateWebhookSecret = {
     /**
@@ -4562,6 +4672,34 @@ export type ListConversationsData = {
          * Only conversations assigned to this member.
          */
         assigned_user_id?: string;
+        /**
+         * Only conversations this AI agent answers and no member is assigned to.
+         */
+        agent_id?: string;
+        /**
+         * `true`: only conversations with no member and no AI agent assigned.
+         */
+        unassigned?: 'true' | 'false';
+        /**
+         * Only conversations on this channel, including earlier connections of the same number or account. See `GET /channels`.
+         */
+        channel_id?: string;
+        /**
+         * Only conversations whose contact has this tag.
+         */
+        tag_id?: string;
+        /**
+         * `true`: only conversations with messages the team has not read.
+         */
+        unread?: 'true' | 'false';
+        /**
+         * `true`: only conversations with a handoff to a person not resolved yet.
+         */
+        pending_handoff?: 'true' | 'false';
+        /**
+         * `customer`: only conversations whose latest message came from the contact.
+         */
+        last_message_from?: 'customer';
     };
     url: '/conversations';
 };
@@ -8098,6 +8236,65 @@ export type ChangeConversationTagsResponses = {
     };
 };
 export type ChangeConversationTagsResponse = ChangeConversationTagsResponses[keyof ChangeConversationTagsResponses];
+export type MarkConversationUnreadData = {
+    body?: never;
+    headers?: {
+        /**
+         * Optional. A value you choose, unique per logical write, 8–200 characters: a UUID or an ID from your system such as `order-10482-ready`. Retrying with the same key and body replays the first response instead of repeating the write.
+         */
+        'Idempotency-Key'?: string;
+    };
+    path: {
+        /**
+         * Conversation ID.
+         */
+        conversation_id: string;
+    };
+    query?: never;
+    url: '/conversations/{conversation_id}/read';
+};
+export type MarkConversationUnreadErrors = {
+    /**
+     * `invalid_input`: A parameter or body field is invalid; `param` names it when known.
+     */
+    400: Error;
+    /**
+     * `unauthorized`: The `Authorization` header is missing, malformed, expired or revoked.
+     */
+    401: Error;
+    /**
+     * `insufficient_scope`: The key lacks the scope this operation requires.
+     */
+    403: Error;
+    /**
+     * `not_found`: The resource does not exist in this organization.
+     */
+    404: Error;
+    /**
+     * `idempotency_conflict`: The `Idempotency-Key` was used for a different request.
+     *
+     * `request_processing`: A request with this `Idempotency-Key` is still processing or ended in an unknown state.
+     */
+    409: Error;
+    /**
+     * `rate_limited`: More than 120 requests this minute with this key; see `Retry-After`.
+     */
+    429: Error;
+    /**
+     * `internal_error`: Ricky failed. Retry a read. Before retrying a write, read the resource: the same `Idempotency-Key` answers `request_processing`.
+     */
+    500: Error;
+};
+export type MarkConversationUnreadError = MarkConversationUnreadErrors[keyof MarkConversationUnreadErrors];
+export type MarkConversationUnreadResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Conversation;
+    };
+};
+export type MarkConversationUnreadResponse = MarkConversationUnreadResponses[keyof MarkConversationUnreadResponses];
 export type MarkConversationReadData = {
     body?: never;
     headers?: {
@@ -9230,6 +9427,202 @@ export type ListBroadcastRecipientsResponses = {
     };
 };
 export type ListBroadcastRecipientsResponse = ListBroadcastRecipientsResponses[keyof ListBroadcastRecipientsResponses];
+export type AssignConversationsData = {
+    body: AssignConversations;
+    headers?: {
+        /**
+         * Optional. A value you choose, unique per logical write, 8–200 characters: a UUID or an ID from your system such as `order-10482-ready`. Retrying with the same key and body replays the first response instead of repeating the write.
+         */
+        'Idempotency-Key'?: string;
+    };
+    path?: never;
+    query?: never;
+    url: '/conversations/assignments';
+};
+export type AssignConversationsErrors = {
+    /**
+     * `invalid_json`: The body is not valid JSON.
+     *
+     * `invalid_input`: A parameter or body field is invalid; `param` names it when known.
+     */
+    400: Error;
+    /**
+     * `unauthorized`: The `Authorization` header is missing, malformed, expired or revoked.
+     */
+    401: Error;
+    /**
+     * `insufficient_scope`: The key lacks the scope this operation requires.
+     */
+    403: Error;
+    /**
+     * `idempotency_conflict`: The `Idempotency-Key` was used for a different request.
+     *
+     * `request_processing`: A request with this `Idempotency-Key` is still processing or ended in an unknown state.
+     */
+    409: Error;
+    /**
+     * `body_too_large`: The JSON body exceeds 64 KiB.
+     */
+    413: Error;
+    /**
+     * `unsupported_media_type`: The body must be `application/json`.
+     */
+    415: Error;
+    /**
+     * `rate_limited`: More than 120 requests this minute with this key; see `Retry-After`.
+     */
+    429: Error;
+    /**
+     * `internal_error`: Ricky failed. Retry a read. Before retrying a write, read the resource: the same `Idempotency-Key` answers `request_processing`.
+     */
+    500: Error;
+};
+export type AssignConversationsError = AssignConversationsErrors[keyof AssignConversationsErrors];
+export type AssignConversationsResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Array<ConversationAssignmentResult>;
+        /**
+         * Pass as `cursor` for the next page; null on the last page.
+         */
+        next_cursor: string | null;
+    };
+};
+export type AssignConversationsResponse = AssignConversationsResponses[keyof AssignConversationsResponses];
+export type ResolveConversationHandoffData = {
+    body: ResolveHandoff;
+    headers?: {
+        /**
+         * Optional. A value you choose, unique per logical write, 8–200 characters: a UUID or an ID from your system such as `order-10482-ready`. Retrying with the same key and body replays the first response instead of repeating the write.
+         */
+        'Idempotency-Key'?: string;
+    };
+    path: {
+        /**
+         * Conversation ID.
+         */
+        conversation_id: string;
+    };
+    query?: never;
+    url: '/conversations/{conversation_id}/handoff/resolve';
+};
+export type ResolveConversationHandoffErrors = {
+    /**
+     * `invalid_json`: The body is not valid JSON.
+     *
+     * `invalid_input`: A parameter or body field is invalid; `param` names it when known.
+     */
+    400: Error;
+    /**
+     * `unauthorized`: The `Authorization` header is missing, malformed, expired or revoked.
+     */
+    401: Error;
+    /**
+     * `insufficient_scope`: The key lacks the scope this operation requires.
+     */
+    403: Error;
+    /**
+     * `not_found`: The resource does not exist in this organization.
+     */
+    404: Error;
+    /**
+     * `idempotency_conflict`: The `Idempotency-Key` was used for a different request.
+     *
+     * `request_processing`: A request with this `Idempotency-Key` is still processing or ended in an unknown state.
+     */
+    409: Error;
+    /**
+     * `body_too_large`: The JSON body exceeds 64 KiB.
+     */
+    413: Error;
+    /**
+     * `unsupported_media_type`: The body must be `application/json`.
+     */
+    415: Error;
+    /**
+     * `rule_violation`: The request breaks a business rule; `message` says which.
+     */
+    422: Error;
+    /**
+     * `rate_limited`: More than 120 requests this minute with this key; see `Retry-After`.
+     */
+    429: Error;
+    /**
+     * `internal_error`: Ricky failed. Retry a read. Before retrying a write, read the resource: the same `Idempotency-Key` answers `request_processing`.
+     */
+    500: Error;
+};
+export type ResolveConversationHandoffError = ResolveConversationHandoffErrors[keyof ResolveConversationHandoffErrors];
+export type ResolveConversationHandoffResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Conversation;
+    };
+};
+export type ResolveConversationHandoffResponse = ResolveConversationHandoffResponses[keyof ResolveConversationHandoffResponses];
+export type FetchMessageMediaData = {
+    body?: never;
+    path: {
+        /**
+         * Conversation ID.
+         */
+        conversation_id: string;
+        /**
+         * Message ID.
+         */
+        message_id: string;
+    };
+    query?: never;
+    url: '/conversations/{conversation_id}/messages/{message_id}/media';
+};
+export type FetchMessageMediaErrors = {
+    /**
+     * `invalid_input`: A parameter or body field is invalid; `param` names it when known.
+     */
+    400: Error;
+    /**
+     * `unauthorized`: The `Authorization` header is missing, malformed, expired or revoked.
+     */
+    401: Error;
+    /**
+     * `insufficient_scope`: The key lacks the scope this operation requires.
+     */
+    403: Error;
+    /**
+     * `not_found`: The resource does not exist in this organization.
+     */
+    404: Error;
+    /**
+     * `rule_violation`: The request breaks a business rule; `message` says which.
+     */
+    422: Error;
+    /**
+     * `rate_limited`: More than 120 requests this minute with this key; see `Retry-After`.
+     */
+    429: Error;
+    /**
+     * `internal_error`: Ricky failed. Retry a read. Before retrying a write, read the resource: the same `Idempotency-Key` answers `request_processing`.
+     */
+    500: Error;
+    /**
+     * `upstream_error`: The messaging provider failed. Retry later.
+     */
+    502: Error;
+};
+export type FetchMessageMediaError = FetchMessageMediaErrors[keyof FetchMessageMediaErrors];
+export type FetchMessageMediaResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Message;
+    };
+};
+export type FetchMessageMediaResponse = FetchMessageMediaResponses[keyof FetchMessageMediaResponses];
 export type WebhookMessageReceivedWebhookPayload = WebhookEvent;
 export type WebhookMessageReceivedWebhookRequest = {
     body: WebhookMessageReceivedWebhookPayload;
@@ -9286,6 +9679,27 @@ export type WebhookConversationAssignmentChangedWebhookRequest = {
     path?: never;
     query?: never;
 };
+export type WebhookConversationAgentChangedWebhookPayload = WebhookEvent;
+export type WebhookConversationAgentChangedWebhookRequest = {
+    body: WebhookConversationAgentChangedWebhookPayload;
+    key: 'conversation.agent_changed';
+    path?: never;
+    query?: never;
+};
+export type WebhookConversationHandoffRequestedWebhookPayload = WebhookEvent;
+export type WebhookConversationHandoffRequestedWebhookRequest = {
+    body: WebhookConversationHandoffRequestedWebhookPayload;
+    key: 'conversation.handoff_requested';
+    path?: never;
+    query?: never;
+};
+export type WebhookConversationHandoffResolvedWebhookPayload = WebhookEvent;
+export type WebhookConversationHandoffResolvedWebhookRequest = {
+    body: WebhookConversationHandoffResolvedWebhookPayload;
+    key: 'conversation.handoff_resolved';
+    path?: never;
+    query?: never;
+};
 export type WebhookContactCreatedWebhookPayload = WebhookEvent;
 export type WebhookContactCreatedWebhookRequest = {
     body: WebhookContactCreatedWebhookPayload;
@@ -9300,6 +9714,48 @@ export type WebhookContactUpdatedWebhookRequest = {
     path?: never;
     query?: never;
 };
+export type WebhookContactTagsChangedWebhookPayload = WebhookEvent;
+export type WebhookContactTagsChangedWebhookRequest = {
+    body: WebhookContactTagsChangedWebhookPayload;
+    key: 'contact.tags_changed';
+    path?: never;
+    query?: never;
+};
+export type WebhookBroadcastCompletedWebhookPayload = WebhookEvent;
+export type WebhookBroadcastCompletedWebhookRequest = {
+    body: WebhookBroadcastCompletedWebhookPayload;
+    key: 'broadcast.completed';
+    path?: never;
+    query?: never;
+};
+export type WebhookBroadcastFailedWebhookPayload = WebhookEvent;
+export type WebhookBroadcastFailedWebhookRequest = {
+    body: WebhookBroadcastFailedWebhookPayload;
+    key: 'broadcast.failed';
+    path?: never;
+    query?: never;
+};
+export type WebhookTemplateStatusChangedWebhookPayload = WebhookEvent;
+export type WebhookTemplateStatusChangedWebhookRequest = {
+    body: WebhookTemplateStatusChangedWebhookPayload;
+    key: 'template.status_changed';
+    path?: never;
+    query?: never;
+};
+export type WebhookWorkflowExecutionFailedWebhookPayload = WebhookEvent;
+export type WebhookWorkflowExecutionFailedWebhookRequest = {
+    body: WebhookWorkflowExecutionFailedWebhookPayload;
+    key: 'workflow.execution_failed';
+    path?: never;
+    query?: never;
+};
+export type WebhookKnowledgeFileReadyWebhookPayload = WebhookEvent;
+export type WebhookKnowledgeFileReadyWebhookRequest = {
+    body: WebhookKnowledgeFileReadyWebhookPayload;
+    key: 'knowledge_file.ready';
+    path?: never;
+    query?: never;
+};
 export type WebhookWebhookTestWebhookPayload = WebhookEvent;
 export type WebhookWebhookTestWebhookRequest = {
     body: WebhookWebhookTestWebhookPayload;