getricky 0.0.0-stage → 0.1.0

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

@@ -0,0 +1,2557 @@
+export type ClientOptions = {
+    baseUrl: 'https://getricky.ai/api/v1' | (string & {});
+};
+export type Webhooks = WebhookMessageReceivedWebhookRequest | WebhookMessageSentWebhookRequest | WebhookMessageDeliveredWebhookRequest | WebhookMessageReadWebhookRequest | WebhookMessageFailedWebhookRequest | WebhookConversationOpenedWebhookRequest | WebhookConversationClosedWebhookRequest | WebhookConversationAssignmentChangedWebhookRequest | WebhookContactCreatedWebhookRequest | WebhookContactUpdatedWebhookRequest | WebhookWebhookTestWebhookRequest;
+/**
+ * Every non-2xx response.
+ */
+export type Error = {
+    error: {
+        /**
+         * Stable, machine-readable error code.
+         */
+        code: 'invalid_input' | 'invalid_json' | 'unauthorized' | 'insufficient_scope' | 'forbidden' | 'not_found' | 'conflict' | 'idempotency_conflict' | 'request_processing' | 'body_too_large' | 'unsupported_media_type' | 'outside_messaging_window' | 'rule_violation' | 'rate_limited' | 'internal_error' | 'upstream_error' | 'unavailable';
+        /**
+         * Human-readable explanation. Do not parse it.
+         */
+        message: string;
+        /**
+         * The request field or parameter that caused it.
+         */
+        param?: string;
+        /**
+         * Quote it to support. Also in the `X-Request-Id` header.
+         */
+        request_id: string;
+    };
+};
+/**
+ * A label applied to contacts.
+ */
+export type Tag = {
+    /**
+     * Tag ID.
+     */
+    id: string;
+    /**
+     * Display name.
+     */
+    name: string;
+    /**
+     * Display color.
+     */
+    color: 'gray' | 'red' | 'orange' | 'amber' | 'green' | 'teal' | 'blue' | 'indigo' | 'purple' | 'pink';
+};
+/**
+ * How a contact is reached on one channel.
+ */
+export type ContactIdentity = {
+    /**
+     * Identity ID.
+     */
+    id: string;
+    /**
+     * Channel this identity belongs to.
+     */
+    channel_type: 'whatsapp' | 'instagram' | 'messenger';
+    /**
+     * Address on that channel: phone digits for WhatsApp, account ID otherwise.
+     */
+    external_id: string;
+    /**
+     * Name the channel reports.
+     */
+    display_name: string | null;
+    /**
+     * Handle on the channel, when it has one.
+     */
+    username: string | null;
+};
+/**
+ * A person in the CRM.
+ */
+export type Contact = {
+    /**
+     * Contact ID.
+     */
+    id: string;
+    /**
+     * First name.
+     */
+    first_name: string | null;
+    /**
+     * Last name.
+     */
+    last_name: string | null;
+    /**
+     * Email, lowercased.
+     */
+    primary_email: string | null;
+    /**
+     * Phone in E.164.
+     */
+    primary_phone: string | null;
+    /**
+     * Company.
+     */
+    company: string | null;
+    /**
+     * Job title.
+     */
+    job_title: string | null;
+    /**
+     * Birthday as `YYYY-MM-DD`.
+     */
+    birthday: string | null;
+    /**
+     * City.
+     */
+    city: string | null;
+    /**
+     * State, province or region.
+     */
+    region: string | null;
+    /**
+     * Country.
+     */
+    country: string | null;
+    /**
+     * Street address.
+     */
+    street_address: string | null;
+    /**
+     * Postal code.
+     */
+    postal_code: string | null;
+    /**
+     * Website URL.
+     */
+    website_url: string | null;
+    /**
+     * LinkedIn profile URL.
+     */
+    linkedin_url: string | null;
+    /**
+     * Where the contact came from.
+     */
+    source: string | null;
+    /**
+     * Free-form notes.
+     */
+    notes: string | null;
+    owner_user_id: string | null;
+    /**
+     * Sales lead status.
+     */
+    lead_status: 'new' | 'open' | 'in_progress' | 'attempted' | 'connected' | 'unqualified' | 'bad_timing' | null;
+    /**
+     * Lifecycle stage.
+     */
+    lifecycle_stage: 'subscriber' | 'lead' | 'marketing_qualified' | 'sales_qualified' | 'opportunity' | 'customer' | 'evangelist' | 'other' | null;
+    /**
+     * Custom field values keyed by contact field ID. See `GET /contact-fields`.
+     */
+    custom_values: {
+        [key: string]: string | number | boolean | Array<string> | null;
+    };
+    /**
+     * Channel identities.
+     */
+    identities: Array<ContactIdentity>;
+    /**
+     * Tags applied to the contact.
+     */
+    tags: Array<Tag>;
+    /**
+     * Latest message in any of its conversations.
+     */
+    last_activity_at: string | null;
+    /**
+     * Text of that latest message.
+     */
+    last_activity_preview: string | null;
+    last_conversation_id: string | null;
+    /**
+     * Last change to the contact.
+     */
+    updated_at: string;
+};
+/**
+ * A custom contact field defined by the organization.
+ */
+export type ContactField = {
+    /**
+     * Field ID; the key in `custom_values`.
+     */
+    id: string;
+    /**
+     * Display name.
+     */
+    name: string;
+    /**
+     * Value type: `number` takes a number, `boolean` a boolean, `date` `YYYY-MM-DD`, `select` one option, `multi_select` an array of options, the rest a string.
+     */
+    type: 'text' | 'long_text' | 'number' | 'boolean' | 'date' | 'select' | 'multi_select';
+    /**
+     * Allowed values for `select` and `multi_select`.
+     */
+    options: Array<string>;
+};
+/**
+ * A connected messaging channel.
+ */
+export type Channel = {
+    /**
+     * Channel ID.
+     */
+    id: string;
+    /**
+     * Messaging channel.
+     */
+    type: 'whatsapp' | 'instagram' | 'messenger';
+    /**
+     * Name shown in Ricky.
+     */
+    name: string;
+    /**
+     * Phone in E.164 for WhatsApp, account or page name otherwise.
+     */
+    address: string | null;
+    /**
+     * WhatsApp Business Account that owns the number; templates must belong to it.
+     */
+    whatsapp_business_account_id: string | null;
+    /**
+     * When it was connected.
+     */
+    connected_at: string | null;
+};
+/**
+ * One contact talking to the organization on one channel.
+ */
+export type Conversation = {
+    /**
+     * Conversation ID.
+     */
+    id: string;
+    channel: {
+        /**
+         * Channel ID.
+         */
+        id: string;
+        type: 'whatsapp' | 'instagram' | 'messenger';
+    };
+    contact: {
+        id: string | null;
+        /**
+         * Name on the channel.
+         */
+        display_name: string | null;
+        /**
+         * Address on the channel.
+         */
+        external_id: string;
+        /**
+         * Handle, when the channel has one.
+         */
+        username: string | null;
+    } | null;
+    status: 'open' | 'closed';
+    /**
+     * Why it was closed; null while open or when closed without one.
+     */
+    close_category: 'resolved' | 'sale' | 'no_response' | 'spam' | 'other' | null;
+    assigned_user_id: string | null;
+    agent_id: string | null;
+    /**
+     * When it was created.
+     */
+    created_at: string;
+    /**
+     * Start of the current open span.
+     */
+    opened_at: string;
+    /**
+     * When it was closed; null while open.
+     */
+    closed_at: string | null;
+    /**
+     * Latest message.
+     */
+    last_activity_at: string | null;
+    /**
+     * Text of the latest message.
+     */
+    last_activity_preview: string | null;
+};
+/**
+ * One message in a conversation.
+ */
+export type Message = {
+    /**
+     * Message ID.
+     */
+    id: string;
+    /**
+     * Conversation ID.
+     */
+    conversation_id: string;
+    direction: 'inbound' | 'outbound';
+    /**
+     * Message type: `text`, `image`, `audio`, `video`, `document`, `template`, …
+     */
+    type: string;
+    /**
+     * Text, caption or rendered template body.
+     */
+    text: string | null;
+    sender: {
+        /**
+         * `contact`; a `member` in Ricky; an AI `agent`; an `automation`; or `channel_app`, sent from the channel's own app outside Ricky.
+         */
+        type: 'contact' | 'member' | 'agent' | 'automation' | 'channel_app';
+        /**
+         * Member, agent or workflow name; null for the contact and `channel_app`.
+         */
+        name: string | null;
+    };
+    /**
+     * Provider delivery status: `sent`, `delivered`, `read`, `failed`, …
+     */
+    status: string;
+    media: {
+        /**
+         * `image`, `audio`, `video`, `document` or `sticker`.
+         */
+        kind: string;
+        /**
+         * MIME type.
+         */
+        mime_type: string | null;
+        /**
+         * File name, for documents.
+         */
+        filename: string | null;
+        byte_size: number | null;
+        /**
+         * Transcript of a voice note.
+         */
+        transcript: string | null;
+        /**
+         * Signed download URL, valid for one hour; null until downloaded.
+         */
+        url: string | null;
+    } | null;
+    /**
+     * Message ID at the provider.
+     */
+    provider_message_id: string | null;
+    /**
+     * When Ricky recorded it.
+     */
+    created_at: string;
+    /**
+     * When the provider accepted it.
+     */
+    sent_at: string | null;
+    /**
+     * When it reached the device.
+     */
+    delivered_at: string | null;
+    /**
+     * When the recipient read it.
+     */
+    read_at: string | null;
+    /**
+     * When delivery failed.
+     */
+    failed_at: string | null;
+    /**
+     * When the sender edited it.
+     */
+    edited_at: string | null;
+    /**
+     * When the sender deleted it.
+     */
+    deleted_at: string | null;
+};
+/**
+ * An outbound message Ricky accepted and is delivering.
+ */
+export type Send = {
+    /**
+     * Send ID. Poll `GET /sends/{send_id}` with it.
+     */
+    id: string;
+    /**
+     * Conversation the message goes to.
+     */
+    conversation_id: string;
+    /**
+     * `sent` once the provider accepted the message; `failed` for good, with the reason; `queued` otherwise, while Ricky retries.
+     */
+    status: 'queued' | 'sent' | 'failed';
+    message_id: string | null;
+    /**
+     * Why it failed; null unless `failed`.
+     */
+    failure_reason: string | null;
+    /**
+     * When Ricky accepted it.
+     */
+    created_at: string;
+};
+/**
+ * A person in the organization.
+ */
+export type Member = {
+    /**
+     * User ID.
+     */
+    id: string;
+    /**
+     * Full name.
+     */
+    name: string | null;
+    /**
+     * Email.
+     */
+    email: string;
+    role: 'owner' | 'admin' | 'member';
+};
+/**
+ * A WhatsApp message template.
+ */
+export type Template = {
+    /**
+     * Template ID at Meta.
+     */
+    id: string;
+    /**
+     * Template name.
+     */
+    name: string;
+    /**
+     * Language code, for example `es` or `en_US`.
+     */
+    language: string;
+    /**
+     * `MARKETING`, `UTILITY` or `AUTHENTICATION`.
+     */
+    category: string;
+    /**
+     * Meta review status. Only `APPROVED` templates can be sent.
+     */
+    status: string;
+    /**
+     * Account that owns it.
+     */
+    whatsapp_business_account_id: string;
+    /**
+     * How variables are named: `{{1}}` or `{{name}}`.
+     */
+    parameter_format: 'POSITIONAL' | 'NAMED' | null;
+    /**
+     * Header, body, footer and buttons, in the WhatsApp Cloud API format.
+     */
+    components: Array<{
+        [key: string]: unknown;
+    }>;
+};
+/**
+ * A webhook subscription.
+ */
+export type Webhook = {
+    /**
+     * Webhook ID.
+     */
+    id: string;
+    /**
+     * 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'>;
+    status: 'active' | 'disabled';
+    /**
+     * When it was created.
+     */
+    created_at: string;
+    /**
+     * When it was disabled.
+     */
+    disabled_at: string | null;
+};
+/**
+ * A new webhook subscription with its signing secret.
+ */
+export type CreatedWebhook = {
+    /**
+     * Webhook ID.
+     */
+    id: string;
+    /**
+     * 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'>;
+    status: 'active' | 'disabled';
+    /**
+     * When it was created.
+     */
+    created_at: string;
+    /**
+     * When it was disabled.
+     */
+    disabled_at: string | null;
+    /**
+     * HMAC key for `X-Ricky-Signature`. Returned only here, once.
+     */
+    signing_secret: string;
+};
+/**
+ * One webhook delivery.
+ */
+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';
+    status: 'pending' | 'processing' | 'delivered' | 'failed';
+    /**
+     * Delivery attempts so far; Ricky makes at most ten.
+     */
+    attempts: number;
+    /**
+     * HTTP status of the last attempt.
+     */
+    last_response_status: number | null;
+    /**
+     * Why the last attempt failed.
+     */
+    last_error: string | null;
+    /**
+     * When the event happened.
+     */
+    created_at: string;
+    /**
+     * When Ricky tries next, while pending.
+     */
+    next_attempt_at: string;
+    /**
+     * When the endpoint answered 2xx.
+     */
+    delivered_at: string | null;
+};
+/**
+ * The JSON body Ricky posts to a webhook endpoint.
+ */
+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';
+    /**
+     * When it happened.
+     */
+    occurred_at: string;
+    /**
+     * Organization.
+     */
+    organization_id: string;
+    data: {
+        /**
+         * Conversation, for `message.*` and `conversation.*` events.
+         */
+        conversation_id?: string;
+        /**
+         * Message, for `message.*` events.
+         */
+        message_id?: string;
+        /**
+         * Contact, for `contact.*` events.
+         */
+        contact_id?: string;
+        /**
+         * Webhook, for `webhook.test`.
+         */
+        webhook_id?: string;
+    };
+};
+/**
+ * What the endpoint answered to a `webhook.test` event.
+ */
+export type WebhookTestResult = {
+    /**
+     * True when the endpoint answered 2xx.
+     */
+    delivered: boolean;
+    /**
+     * HTTP status the endpoint answered; null if none.
+     */
+    response_status: number | null;
+    /**
+     * Why it failed: the HTTP status, a timeout or a refused destination.
+     */
+    error: string | null;
+    /**
+     * Time until the endpoint answered.
+     */
+    duration_ms: number;
+};
+/**
+ * A contact needs at least a name, a phone or an email.
+ */
+export type CreateContact = {
+    /**
+     * First name.
+     */
+    first_name?: string | null;
+    /**
+     * Last name.
+     */
+    last_name?: string | null;
+    /**
+     * Email.
+     */
+    primary_email?: string | null;
+    /**
+     * Phone with country code, for example `+507 6000-1234`.
+     */
+    primary_phone?: string | null;
+    /**
+     * Company.
+     */
+    company?: string | null;
+    /**
+     * Job title.
+     */
+    job_title?: string | null;
+    /**
+     * Birthday as `YYYY-MM-DD`.
+     */
+    birthday?: string | null;
+    /**
+     * City.
+     */
+    city?: string | null;
+    /**
+     * State, province or region.
+     */
+    region?: string | null;
+    /**
+     * Country.
+     */
+    country?: string | null;
+    /**
+     * Street address.
+     */
+    street_address?: string | null;
+    /**
+     * Postal code.
+     */
+    postal_code?: string | null;
+    /**
+     * Website URL.
+     */
+    website_url?: string | null;
+    /**
+     * LinkedIn profile URL.
+     */
+    linkedin_url?: string | null;
+    /**
+     * Where the contact came from.
+     */
+    source?: string | null;
+    /**
+     * Free-form notes.
+     */
+    notes?: string | null;
+    /**
+     * Member who owns the contact.
+     */
+    owner_user_id?: string | null;
+    lead_status?: 'new' | 'open' | 'in_progress' | 'attempted' | 'connected' | 'unqualified' | 'bad_timing' | null;
+    lifecycle_stage?: 'subscriber' | 'lead' | 'marketing_qualified' | 'sales_qualified' | 'opportunity' | 'customer' | 'evangelist' | 'other' | null;
+    /**
+     * Values keyed by contact field ID. Keys you omit keep their value.
+     */
+    custom_values?: {
+        [key: string]: string | number | boolean | Array<string> | null;
+    };
+    /**
+     * The complete set of tag IDs. Replaces the current tags.
+     */
+    tag_ids?: Array<string>;
+};
+/**
+ * Only the fields you send change. Send `null` to clear one.
+ */
+export type UpdateContact = {
+    /**
+     * First name.
+     */
+    first_name?: string | null;
+    /**
+     * Last name.
+     */
+    last_name?: string | null;
+    /**
+     * Email.
+     */
+    primary_email?: string | null;
+    /**
+     * Phone with country code, for example `+507 6000-1234`.
+     */
+    primary_phone?: string | null;
+    /**
+     * Company.
+     */
+    company?: string | null;
+    /**
+     * Job title.
+     */
+    job_title?: string | null;
+    /**
+     * Birthday as `YYYY-MM-DD`.
+     */
+    birthday?: string | null;
+    /**
+     * City.
+     */
+    city?: string | null;
+    /**
+     * State, province or region.
+     */
+    region?: string | null;
+    /**
+     * Country.
+     */
+    country?: string | null;
+    /**
+     * Street address.
+     */
+    street_address?: string | null;
+    /**
+     * Postal code.
+     */
+    postal_code?: string | null;
+    /**
+     * Website URL.
+     */
+    website_url?: string | null;
+    /**
+     * LinkedIn profile URL.
+     */
+    linkedin_url?: string | null;
+    /**
+     * Where the contact came from.
+     */
+    source?: string | null;
+    /**
+     * Free-form notes.
+     */
+    notes?: string | null;
+    /**
+     * Member who owns the contact.
+     */
+    owner_user_id?: string | null;
+    lead_status?: 'new' | 'open' | 'in_progress' | 'attempted' | 'connected' | 'unqualified' | 'bad_timing' | null;
+    lifecycle_stage?: 'subscriber' | 'lead' | 'marketing_qualified' | 'sales_qualified' | 'opportunity' | 'customer' | 'evangelist' | 'other' | null;
+    /**
+     * Values keyed by contact field ID. Keys you omit keep their value.
+     */
+    custom_values?: {
+        [key: string]: string | number | boolean | Array<string> | null;
+    };
+    /**
+     * The complete set of tag IDs. Replaces the current tags.
+     */
+    tag_ids?: Array<string>;
+};
+/**
+ * An approved WhatsApp template and the values of its variables.
+ */
+export type TemplateMessage = {
+    /**
+     * Approved template ID from `GET /templates`.
+     */
+    id: string;
+    /**
+     * Variable values, in the WhatsApp Cloud API format.
+     */
+    components?: Array<{
+        type: 'header' | 'body' | 'button';
+        sub_type?: 'url' | 'quick_reply';
+        /**
+         * Button position, from `"0"`.
+         */
+        index?: string;
+        parameters: Array<{
+            type: 'text';
+            text: string;
+            /**
+             * For `NAMED` templates.
+             */
+            parameter_name?: string;
+        } | {
+            type: 'payload';
+            payload: string;
+        } | {
+            type: 'image';
+            /**
+             * Media file.
+             */
+            image: {
+                /**
+                 * Public HTTPS URL of the file.
+                 */
+                link: string;
+            };
+        } | {
+            type: 'video';
+            /**
+             * Media file.
+             */
+            video: {
+                /**
+                 * Public HTTPS URL of the file.
+                 */
+                link: string;
+            };
+        } | {
+            type: 'document';
+            document: {
+                /**
+                 * Public HTTPS URL of the file.
+                 */
+                link: string;
+                filename?: string;
+            };
+        } | {
+            type: 'currency';
+            currency: {
+                amount_1000: number;
+                code: string;
+                fallback_value: string;
+            };
+        } | {
+            type: 'date_time';
+            date_time: {
+                fallback_value: string;
+            };
+        }>;
+    }>;
+};
+/**
+ * A file Ricky downloads and sends. WhatsApp and Instagram only.
+ */
+export type MediaMessage = {
+    /**
+     * Public HTTPS URL of the file. Ricky downloads it once, without following redirects.
+     */
+    url: string;
+    /**
+     * How the channel shows the file. The file type must match it.
+     */
+    kind: 'image' | 'video' | 'audio' | 'document';
+    /**
+     * Text under an image, video or document. WhatsApp only.
+     */
+    caption?: string;
+    /**
+     * Name the recipient sees for a document. Defaults to the last segment of `url`.
+     */
+    filename?: string;
+};
+/**
+ * Text and media work inside the channel reply window; a template (WhatsApp only) works any time.
+ */
+export type SendMessage = {
+    type: 'text';
+    /**
+     * Message text.
+     */
+    text: string;
+} | {
+    type: 'template';
+    template: TemplateMessage;
+} | {
+    type: 'media';
+    media: MediaMessage;
+};
+/**
+ * Sends a template to a phone number.
+ */
+export type StartConversation = {
+    /**
+     * WhatsApp channel to send from. See `GET /channels`.
+     */
+    channel_id: string;
+    /**
+     * Recipient phone with country code, for example `+50760001234`.
+     */
+    phone: string;
+    template: TemplateMessage;
+};
+export type AssignConversation = {
+    /**
+     * Member to assign; null unassigns.
+     */
+    assigned_user_id: string | null;
+    /**
+     * Also make that member the contact owner.
+     */
+    sync_contact_owner?: boolean;
+};
+export type CloseConversation = {
+    /**
+     * Why it is closed.
+     */
+    category?: 'resolved' | 'sale' | 'no_response' | 'spam' | 'other' | null;
+};
+export type CreateTag = {
+    /**
+     * Display name, unique in the organization regardless of case.
+     */
+    name: string;
+    /**
+     * Display color.
+     */
+    color: 'gray' | 'red' | 'orange' | 'amber' | 'green' | 'teal' | 'blue' | 'indigo' | 'purple' | 'pink';
+};
+export type AddContactNote = {
+    /**
+     * Note text. Ricky adds it after the current notes, separated by a blank line.
+     */
+    text: string;
+};
+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'>;
+};
+export type RotateWebhookSecret = {
+    /**
+     * How long deliveries keep the previous signature too, so you can deploy the new secret first. 0 ends the previous secret now.
+     */
+    expire_previous_after_hours?: number;
+};
+/**
+ * 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.
+ */
+export type IdempotencyKey = string;
+export type ListContactsData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Items per page.
+         */
+        page_size?: number;
+        /**
+         * `next_cursor` from the previous page. Use it unchanged.
+         */
+        cursor?: string;
+        /**
+         * Text contained in the name, phone, email or company.
+         */
+        query?: string;
+        /**
+         * Only contacts with this tag.
+         */
+        tag_id?: string;
+        /**
+         * Only contacts this member owns.
+         */
+        owner_user_id?: string;
+        /**
+         * Only contacts at this stage.
+         */
+        lifecycle_stage?: 'subscriber' | 'lead' | 'marketing_qualified' | 'sales_qualified' | 'opportunity' | 'customer' | 'evangelist' | 'other';
+        /**
+         * Only contacts reachable on this channel.
+         */
+        channel?: 'whatsapp' | 'instagram' | 'messenger';
+    };
+    url: '/contacts';
+};
+export type ListContactsErrors = {
+    /**
+     * `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;
+    /**
+     * `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 ListContactsError = ListContactsErrors[keyof ListContactsErrors];
+export type ListContactsResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Array<Contact>;
+        /**
+         * Pass as `cursor` for the next page; null on the last page.
+         */
+        next_cursor: string | null;
+    };
+};
+export type ListContactsResponse = ListContactsResponses[keyof ListContactsResponses];
+export type CreateContactData = {
+    body: CreateContact;
+    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: '/contacts';
+};
+export type CreateContactErrors = {
+    /**
+     * `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.
+     *
+     * `conflict`: The resource changed in a way that prevents the operation.
+     */
+    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 CreateContactError = CreateContactErrors[keyof CreateContactErrors];
+export type CreateContactResponses = {
+    /**
+     * Success.
+     */
+    201: {
+        data: Contact;
+    };
+};
+export type CreateContactResponse = CreateContactResponses[keyof CreateContactResponses];
+export type GetContactData = {
+    body?: never;
+    path: {
+        /**
+         * Contact ID.
+         */
+        contact_id: string;
+    };
+    query?: never;
+    url: '/contacts/{contact_id}';
+};
+export type GetContactErrors = {
+    /**
+     * `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;
+    /**
+     * `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 GetContactError = GetContactErrors[keyof GetContactErrors];
+export type GetContactResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Contact;
+    };
+};
+export type GetContactResponse = GetContactResponses[keyof GetContactResponses];
+export type UpdateContactData = {
+    body: UpdateContact;
+    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: {
+        /**
+         * Contact ID.
+         */
+        contact_id: string;
+    };
+    query?: never;
+    url: '/contacts/{contact_id}';
+};
+export type UpdateContactErrors = {
+    /**
+     * `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.
+     *
+     * `conflict`: The resource changed in a way that prevents the operation.
+     */
+    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 UpdateContactError = UpdateContactErrors[keyof UpdateContactErrors];
+export type UpdateContactResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Contact;
+    };
+};
+export type UpdateContactResponse = UpdateContactResponses[keyof UpdateContactResponses];
+export type AddContactNoteData = {
+    body: AddContactNote;
+    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: {
+        /**
+         * Contact ID.
+         */
+        contact_id: string;
+    };
+    query?: never;
+    url: '/contacts/{contact_id}/notes';
+};
+export type AddContactNoteErrors = {
+    /**
+     * `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;
+    /**
+     * `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 AddContactNoteError = AddContactNoteErrors[keyof AddContactNoteErrors];
+export type AddContactNoteResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Contact;
+    };
+};
+export type AddContactNoteResponse = AddContactNoteResponses[keyof AddContactNoteResponses];
+export type ListContactFieldsData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/contact-fields';
+};
+export type ListContactFieldsErrors = {
+    /**
+     * `unauthorized`: The `Authorization` header is missing, malformed, expired or revoked.
+     */
+    401: Error;
+    /**
+     * `insufficient_scope`: The key lacks the scope this operation requires.
+     */
+    403: 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 ListContactFieldsError = ListContactFieldsErrors[keyof ListContactFieldsErrors];
+export type ListContactFieldsResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Array<ContactField>;
+        /**
+         * Pass as `cursor` for the next page; null on the last page.
+         */
+        next_cursor: string | null;
+    };
+};
+export type ListContactFieldsResponse = ListContactFieldsResponses[keyof ListContactFieldsResponses];
+export type ListConversationsData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Items per page.
+         */
+        page_size?: number;
+        /**
+         * `next_cursor` from the previous page. Use it unchanged.
+         */
+        cursor?: string;
+        status?: 'all' | 'open' | 'closed';
+        /**
+         * Only conversations assigned to this member.
+         */
+        assigned_user_id?: string;
+    };
+    url: '/conversations';
+};
+export type ListConversationsErrors = {
+    /**
+     * `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;
+    /**
+     * `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 ListConversationsError = ListConversationsErrors[keyof ListConversationsErrors];
+export type ListConversationsResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Array<Conversation>;
+        /**
+         * Pass as `cursor` for the next page; null on the last page.
+         */
+        next_cursor: string | null;
+    };
+};
+export type ListConversationsResponse = ListConversationsResponses[keyof ListConversationsResponses];
+export type StartConversationData = {
+    body: StartConversation;
+    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';
+};
+export type StartConversationErrors = {
+    /**
+     * `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;
+    /**
+     * `outside_messaging_window`: The channel only allows free-form text inside its reply window; send a template.
+     *
+     * `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;
+    /**
+     * `unavailable`: A dependency is temporarily unavailable. Retry later.
+     */
+    503: Error;
+};
+export type StartConversationError = StartConversationErrors[keyof StartConversationErrors];
+export type StartConversationResponses = {
+    /**
+     * Accepted.
+     */
+    202: {
+        data: Send;
+    };
+};
+export type StartConversationResponse = StartConversationResponses[keyof StartConversationResponses];
+export type GetConversationData = {
+    body?: never;
+    path: {
+        /**
+         * Conversation ID.
+         */
+        conversation_id: string;
+    };
+    query?: never;
+    url: '/conversations/{conversation_id}';
+};
+export type GetConversationErrors = {
+    /**
+     * `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;
+    /**
+     * `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 GetConversationError = GetConversationErrors[keyof GetConversationErrors];
+export type GetConversationResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Conversation;
+    };
+};
+export type GetConversationResponse = GetConversationResponses[keyof GetConversationResponses];
+export type AssignConversationData = {
+    body: AssignConversation;
+    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}/assignment';
+};
+export type AssignConversationErrors = {
+    /**
+     * `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 AssignConversationError = AssignConversationErrors[keyof AssignConversationErrors];
+export type AssignConversationResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Conversation;
+    };
+};
+export type AssignConversationResponse = AssignConversationResponses[keyof AssignConversationResponses];
+export type CloseConversationData = {
+    body: CloseConversation;
+    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}/close';
+};
+export type CloseConversationErrors = {
+    /**
+     * `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;
+    /**
+     * `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 CloseConversationError = CloseConversationErrors[keyof CloseConversationErrors];
+export type CloseConversationResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Conversation;
+    };
+};
+export type CloseConversationResponse = CloseConversationResponses[keyof CloseConversationResponses];
+export type ReopenConversationData = {
+    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}/reopen';
+};
+export type ReopenConversationErrors = {
+    /**
+     * `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 ReopenConversationError = ReopenConversationErrors[keyof ReopenConversationErrors];
+export type ReopenConversationResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Conversation;
+    };
+};
+export type ReopenConversationResponse = ReopenConversationResponses[keyof ReopenConversationResponses];
+export type ListMessagesData = {
+    body?: never;
+    path: {
+        /**
+         * Conversation ID.
+         */
+        conversation_id: string;
+    };
+    query?: {
+        /**
+         * `next_cursor` from the previous page. Use it unchanged.
+         */
+        cursor?: string;
+    };
+    url: '/conversations/{conversation_id}/messages';
+};
+export type ListMessagesErrors = {
+    /**
+     * `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;
+    /**
+     * `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 ListMessagesError = ListMessagesErrors[keyof ListMessagesErrors];
+export type ListMessagesResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Array<Message>;
+        /**
+         * Pass as `cursor` for the next page; null on the last page.
+         */
+        next_cursor: string | null;
+    };
+};
+export type ListMessagesResponse = ListMessagesResponses[keyof ListMessagesResponses];
+export type SendMessageData = {
+    body: SendMessage;
+    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}/messages';
+};
+export type SendMessageErrors = {
+    /**
+     * `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;
+    /**
+     * `outside_messaging_window`: The channel only allows free-form text inside its reply window; send a template.
+     *
+     * `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;
+    /**
+     * `unavailable`: A dependency is temporarily unavailable. Retry later.
+     */
+    503: Error;
+};
+export type SendMessageError = SendMessageErrors[keyof SendMessageErrors];
+export type SendMessageResponses = {
+    /**
+     * Accepted.
+     */
+    202: {
+        data: Send;
+    };
+};
+export type SendMessageResponse = SendMessageResponses[keyof SendMessageResponses];
+export type GetMessageData = {
+    body?: never;
+    path: {
+        /**
+         * Conversation ID.
+         */
+        conversation_id: string;
+        /**
+         * Message ID.
+         */
+        message_id: string;
+    };
+    query?: never;
+    url: '/conversations/{conversation_id}/messages/{message_id}';
+};
+export type GetMessageErrors = {
+    /**
+     * `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;
+    /**
+     * `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 GetMessageError = GetMessageErrors[keyof GetMessageErrors];
+export type GetMessageResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Message;
+    };
+};
+export type GetMessageResponse = GetMessageResponses[keyof GetMessageResponses];
+export type GetSendData = {
+    body?: never;
+    path: {
+        /**
+         * Send ID.
+         */
+        send_id: string;
+    };
+    query?: never;
+    url: '/sends/{send_id}';
+};
+export type GetSendErrors = {
+    /**
+     * `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;
+    /**
+     * `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 GetSendError = GetSendErrors[keyof GetSendErrors];
+export type GetSendResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Send;
+    };
+};
+export type GetSendResponse = GetSendResponses[keyof GetSendResponses];
+export type ListChannelsData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/channels';
+};
+export type ListChannelsErrors = {
+    /**
+     * `unauthorized`: The `Authorization` header is missing, malformed, expired or revoked.
+     */
+    401: Error;
+    /**
+     * `insufficient_scope`: The key lacks the scope this operation requires.
+     */
+    403: 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 ListChannelsError = ListChannelsErrors[keyof ListChannelsErrors];
+export type ListChannelsResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Array<Channel>;
+        /**
+         * Pass as `cursor` for the next page; null on the last page.
+         */
+        next_cursor: string | null;
+    };
+};
+export type ListChannelsResponse = ListChannelsResponses[keyof ListChannelsResponses];
+export type ListMembersData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/members';
+};
+export type ListMembersErrors = {
+    /**
+     * `unauthorized`: The `Authorization` header is missing, malformed, expired or revoked.
+     */
+    401: Error;
+    /**
+     * `insufficient_scope`: The key lacks the scope this operation requires.
+     */
+    403: 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 ListMembersError = ListMembersErrors[keyof ListMembersErrors];
+export type ListMembersResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Array<Member>;
+        /**
+         * Pass as `cursor` for the next page; null on the last page.
+         */
+        next_cursor: string | null;
+    };
+};
+export type ListMembersResponse = ListMembersResponses[keyof ListMembersResponses];
+export type ListTagsData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/tags';
+};
+export type ListTagsErrors = {
+    /**
+     * `unauthorized`: The `Authorization` header is missing, malformed, expired or revoked.
+     */
+    401: Error;
+    /**
+     * `insufficient_scope`: The key lacks the scope this operation requires.
+     */
+    403: 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 ListTagsError = ListTagsErrors[keyof ListTagsErrors];
+export type ListTagsResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Array<Tag>;
+        /**
+         * Pass as `cursor` for the next page; null on the last page.
+         */
+        next_cursor: string | null;
+    };
+};
+export type ListTagsResponse = ListTagsResponses[keyof ListTagsResponses];
+export type CreateTagData = {
+    body: CreateTag;
+    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: '/tags';
+};
+export type CreateTagErrors = {
+    /**
+     * `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.
+     *
+     * `conflict`: The resource changed in a way that prevents the operation.
+     */
+    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 CreateTagError = CreateTagErrors[keyof CreateTagErrors];
+export type CreateTagResponses = {
+    /**
+     * Success.
+     */
+    201: {
+        data: Tag;
+    };
+};
+export type CreateTagResponse = CreateTagResponses[keyof CreateTagResponses];
+export type ListTemplatesData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/templates';
+};
+export type ListTemplatesErrors = {
+    /**
+     * `unauthorized`: The `Authorization` header is missing, malformed, expired or revoked.
+     */
+    401: Error;
+    /**
+     * `insufficient_scope`: The key lacks the scope this operation requires.
+     */
+    403: 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 ListTemplatesError = ListTemplatesErrors[keyof ListTemplatesErrors];
+export type ListTemplatesResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Array<Template>;
+        /**
+         * Pass as `cursor` for the next page; null on the last page.
+         */
+        next_cursor: string | null;
+    };
+};
+export type ListTemplatesResponse = ListTemplatesResponses[keyof ListTemplatesResponses];
+export type ListWebhooksData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/webhooks';
+};
+export type ListWebhooksErrors = {
+    /**
+     * `unauthorized`: The `Authorization` header is missing, malformed, expired or revoked.
+     */
+    401: Error;
+    /**
+     * `insufficient_scope`: The key lacks the scope this operation requires.
+     */
+    403: 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 ListWebhooksError = ListWebhooksErrors[keyof ListWebhooksErrors];
+export type ListWebhooksResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Array<Webhook>;
+        /**
+         * Pass as `cursor` for the next page; null on the last page.
+         */
+        next_cursor: string | null;
+    };
+};
+export type ListWebhooksResponse = ListWebhooksResponses[keyof ListWebhooksResponses];
+export type CreateWebhookData = {
+    body: CreateWebhook;
+    path?: never;
+    query?: never;
+    url: '/webhooks';
+};
+export type CreateWebhookErrors = {
+    /**
+     * `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;
+    /**
+     * `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 CreateWebhookError = CreateWebhookErrors[keyof CreateWebhookErrors];
+export type CreateWebhookResponses = {
+    /**
+     * Success.
+     */
+    201: {
+        data: CreatedWebhook;
+    };
+};
+export type CreateWebhookResponse = CreateWebhookResponses[keyof CreateWebhookResponses];
+export type DisableWebhookData = {
+    body?: never;
+    path: {
+        /**
+         * Webhook ID.
+         */
+        webhook_id: string;
+    };
+    query?: never;
+    url: '/webhooks/{webhook_id}';
+};
+export type DisableWebhookErrors = {
+    /**
+     * `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;
+    /**
+     * `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 DisableWebhookError = DisableWebhookErrors[keyof DisableWebhookErrors];
+export type DisableWebhookResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Webhook;
+    };
+};
+export type DisableWebhookResponse = DisableWebhookResponses[keyof DisableWebhookResponses];
+export type TestWebhookData = {
+    body?: never;
+    path: {
+        /**
+         * Webhook ID.
+         */
+        webhook_id: string;
+    };
+    query?: never;
+    url: '/webhooks/{webhook_id}/test';
+};
+export type TestWebhookErrors = {
+    /**
+     * `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;
+    /**
+     * `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 TestWebhookError = TestWebhookErrors[keyof TestWebhookErrors];
+export type TestWebhookResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: WebhookTestResult;
+    };
+};
+export type TestWebhookResponse = TestWebhookResponses[keyof TestWebhookResponses];
+export type RotateWebhookSecretData = {
+    body: RotateWebhookSecret;
+    path: {
+        /**
+         * Webhook ID.
+         */
+        webhook_id: string;
+    };
+    query?: never;
+    url: '/webhooks/{webhook_id}/rotate-secret';
+};
+export type RotateWebhookSecretErrors = {
+    /**
+     * `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;
+    /**
+     * `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 RotateWebhookSecretError = RotateWebhookSecretErrors[keyof RotateWebhookSecretErrors];
+export type RotateWebhookSecretResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: CreatedWebhook;
+    };
+};
+export type RotateWebhookSecretResponse = RotateWebhookSecretResponses[keyof RotateWebhookSecretResponses];
+export type ListWebhookDeliveriesData = {
+    body?: never;
+    path: {
+        /**
+         * Webhook ID.
+         */
+        webhook_id: string;
+    };
+    query?: never;
+    url: '/webhooks/{webhook_id}/deliveries';
+};
+export type ListWebhookDeliveriesErrors = {
+    /**
+     * `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;
+    /**
+     * `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 ListWebhookDeliveriesError = ListWebhookDeliveriesErrors[keyof ListWebhookDeliveriesErrors];
+export type ListWebhookDeliveriesResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: Array<WebhookDelivery>;
+        /**
+         * Pass as `cursor` for the next page; null on the last page.
+         */
+        next_cursor: string | null;
+    };
+};
+export type ListWebhookDeliveriesResponse = ListWebhookDeliveriesResponses[keyof ListWebhookDeliveriesResponses];
+export type RetryWebhookDeliveryData = {
+    body?: never;
+    path: {
+        /**
+         * Webhook ID.
+         */
+        webhook_id: string;
+        /**
+         * Delivery ID.
+         */
+        delivery_id: string;
+    };
+    query?: never;
+    url: '/webhooks/{webhook_id}/deliveries/{delivery_id}/retry';
+};
+export type RetryWebhookDeliveryErrors = {
+    /**
+     * `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;
+    /**
+     * `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 RetryWebhookDeliveryError = RetryWebhookDeliveryErrors[keyof RetryWebhookDeliveryErrors];
+export type RetryWebhookDeliveryResponses = {
+    /**
+     * Success.
+     */
+    200: {
+        data: WebhookDelivery;
+    };
+};
+export type RetryWebhookDeliveryResponse = RetryWebhookDeliveryResponses[keyof RetryWebhookDeliveryResponses];
+export type WebhookMessageReceivedWebhookPayload = WebhookEvent;
+export type WebhookMessageReceivedWebhookRequest = {
+    body: WebhookMessageReceivedWebhookPayload;
+    key: 'message.received';
+    path?: never;
+    query?: never;
+};
+export type WebhookMessageSentWebhookPayload = WebhookEvent;
+export type WebhookMessageSentWebhookRequest = {
+    body: WebhookMessageSentWebhookPayload;
+    key: 'message.sent';
+    path?: never;
+    query?: never;
+};
+export type WebhookMessageDeliveredWebhookPayload = WebhookEvent;
+export type WebhookMessageDeliveredWebhookRequest = {
+    body: WebhookMessageDeliveredWebhookPayload;
+    key: 'message.delivered';
+    path?: never;
+    query?: never;
+};
+export type WebhookMessageReadWebhookPayload = WebhookEvent;
+export type WebhookMessageReadWebhookRequest = {
+    body: WebhookMessageReadWebhookPayload;
+    key: 'message.read';
+    path?: never;
+    query?: never;
+};
+export type WebhookMessageFailedWebhookPayload = WebhookEvent;
+export type WebhookMessageFailedWebhookRequest = {
+    body: WebhookMessageFailedWebhookPayload;
+    key: 'message.failed';
+    path?: never;
+    query?: never;
+};
+export type WebhookConversationOpenedWebhookPayload = WebhookEvent;
+export type WebhookConversationOpenedWebhookRequest = {
+    body: WebhookConversationOpenedWebhookPayload;
+    key: 'conversation.opened';
+    path?: never;
+    query?: never;
+};
+export type WebhookConversationClosedWebhookPayload = WebhookEvent;
+export type WebhookConversationClosedWebhookRequest = {
+    body: WebhookConversationClosedWebhookPayload;
+    key: 'conversation.closed';
+    path?: never;
+    query?: never;
+};
+export type WebhookConversationAssignmentChangedWebhookPayload = WebhookEvent;
+export type WebhookConversationAssignmentChangedWebhookRequest = {
+    body: WebhookConversationAssignmentChangedWebhookPayload;
+    key: 'conversation.assignment_changed';
+    path?: never;
+    query?: never;
+};
+export type WebhookContactCreatedWebhookPayload = WebhookEvent;
+export type WebhookContactCreatedWebhookRequest = {
+    body: WebhookContactCreatedWebhookPayload;
+    key: 'contact.created';
+    path?: never;
+    query?: never;
+};
+export type WebhookContactUpdatedWebhookPayload = WebhookEvent;
+export type WebhookContactUpdatedWebhookRequest = {
+    body: WebhookContactUpdatedWebhookPayload;
+    key: 'contact.updated';
+    path?: never;
+    query?: never;
+};
+export type WebhookWebhookTestWebhookPayload = WebhookEvent;
+export type WebhookWebhookTestWebhookRequest = {
+    body: WebhookWebhookTestWebhookPayload;
+    key: 'webhook.test';
+    path?: never;
+    query?: never;
+};