@trycourier/courier 6.6.1-alpha0 → 6.7.0-alpha2

package/resources/send.d.ts

@@ -1,484 +1,45 @@
 import { APIResource } from "../core/resource.js";
 import * as SendAPI from "./send.js";
 import * as BulkAPI from "./bulk.js";
+import * as Shared from "./shared.js";
+import * as TemplatesAPI from "./tenants/templates.js";
 import { APIPromise } from "../core/api-promise.js";
 import { RequestOptions } from "../internal/request-options.js";
 export declare class Send extends APIResource {
     /**
      * Use the send API to send a message to one or more recipients.
+     *
+     * @example
+     * ```ts
+     * const response = await client.send.message({
+     *   message: {
+     *     to: { user_id: 'example_user' },
+     *     template: 'template_id',
+     *     data: { name: 'Example Name' },
+     *   },
+     * });
+     * ```
      */
-    sendMessage(body: SendSendMessageParams, options?: RequestOptions): APIPromise<SendSendMessageResponse>;
-}
-export interface BaseMessage {
-    brand_id?: string | null;
-    /**
-     * "Define run-time configuration for one or more channels. If you don't specify
-     * channels, the default configuration for each channel will be used. Valid
-     * ChannelId's are: email, sms, push, inbox, direct_message, banner, and webhook."
-     */
-    channels?: {
-        [key: string]: BaseMessage.Channels;
-    } | null;
-    /**
-     * Context to load with this recipient. Will override any context set on
-     * message.context.
-     */
-    context?: MessageContext | null;
-    /**
-     * An arbitrary object that includes any data you want to pass to the message. The
-     * data will populate the corresponding template or elements variables.
-     */
-    data?: {
-        [key: string]: unknown;
-    } | null;
-    /**
-     * Defines the time to wait before delivering the message. You can specify one of
-     * the following options. Duration with the number of milliseconds to delay. Until
-     * with an ISO 8601 timestamp that specifies when it should be delivered. Until
-     * with an OpenStreetMap opening_hours-like format that specifies the
-     * [Delivery Window](https://www.courier.com/docs/platform/sending/failover/#delivery-window)
-     * (e.g., 'Mo-Fr 08:00-18:00pm')
-     */
-    delay?: BaseMessage.Delay | null;
-    /**
-     * "Expiry allows you to set an absolute or relative time in which a message
-     * expires. Note: This is only valid for the Courier Inbox channel as of
-     * 12-08-2022."
-     */
-    expiry?: BaseMessage.Expiry | null;
-    /**
-     * Metadata such as utm tracking attached with the notification through this
-     * channel.
-     */
-    metadata?: BaseMessage.Metadata | null;
-    preferences?: BaseMessage.Preferences | null;
-    /**
-     * An object whose keys are valid provider identifiers which map to an object.
-     */
-    providers?: {
-        [key: string]: BaseMessage.Providers;
-    } | null;
-    /**
-     * Allows you to customize which channel(s) Courier will potentially deliver the
-     * message. If no routing key is specified, Courier will use the default routing
-     * configuration or routing defined by the template.
-     */
-    routing?: BaseMessage.Routing | null;
-    /**
-     * Time in ms to attempt the channel before failing over to the next available
-     * channel.
-     */
-    timeout?: BaseMessage.Timeout | null;
-}
-export declare namespace BaseMessage {
-    interface Channels {
-        /**
-         * Id of the brand that should be used for rendering the message. If not specified,
-         * the brand configured as default brand will be used.
-         */
-        brand_id?: string | null;
-        /**
-         * A JavaScript conditional expression to determine if the message should be sent
-         * through the channel. Has access to the data and profile object. For example,
-         * `data.name === profile.name`
-         */
-        if?: string | null;
-        metadata?: Channels.Metadata | null;
-        /**
-         * Channel specific overrides.
-         */
-        override?: {
-            [key: string]: unknown;
-        } | null;
-        /**
-         * A list of providers enabled for this channel. Courier will select one provider
-         * to send through unless routing_method is set to all.
-         */
-        providers?: Array<string> | null;
-        /**
-         * The method for selecting the providers to send the message with. Single will
-         * send to one of the available providers for this channel, all will send the
-         * message through all channels. Defaults to `single`.
-         */
-        routing_method?: SendAPI.RoutingMethod | null;
-        timeouts?: Channels.Timeouts | null;
-    }
-    namespace Channels {
-        interface Metadata {
-            utm?: SendAPI.Utm | null;
-        }
-        interface Timeouts {
-            channel?: number | null;
-            provider?: number | null;
-        }
-    }
-    /**
-     * Defines the time to wait before delivering the message. You can specify one of
-     * the following options. Duration with the number of milliseconds to delay. Until
-     * with an ISO 8601 timestamp that specifies when it should be delivered. Until
-     * with an OpenStreetMap opening_hours-like format that specifies the
-     * [Delivery Window](https://www.courier.com/docs/platform/sending/failover/#delivery-window)
-     * (e.g., 'Mo-Fr 08:00-18:00pm')
-     */
-    interface Delay {
-        /**
-         * The duration of the delay in milliseconds.
-         */
-        duration?: number | null;
-        /**
-         * An ISO 8601 timestamp that specifies when it should be delivered or an
-         * OpenStreetMap opening_hours-like format that specifies the
-         * [Delivery Window](https://www.courier.com/docs/platform/sending/failover/#delivery-window)
-         * (e.g., 'Mo-Fr 08:00-18:00pm')
-         */
-        until?: string | null;
-    }
-    /**
-     * "Expiry allows you to set an absolute or relative time in which a message
-     * expires. Note: This is only valid for the Courier Inbox channel as of
-     * 12-08-2022."
-     */
-    interface Expiry {
-        /**
-         * A duration in the form of milliseconds or an ISO8601 Duration format (i.e.
-         * P1DT4H).
-         */
-        expires_in: string | number;
-        /**
-         * An epoch timestamp or ISO8601 timestamp with timezone
-         * `(YYYY-MM-DDThh:mm:ss.sTZD)` that describes the time in which a message expires.
-         */
-        expires_at?: string | null;
-    }
-    /**
-     * Metadata such as utm tracking attached with the notification through this
-     * channel.
-     */
-    interface Metadata {
-        /**
-         * An arbitrary string to tracks the event that generated this request (e.g.
-         * 'signup').
-         */
-        event?: string | null;
-        /**
-         * An array of up to 9 tags you wish to associate with this request (and
-         * corresponding messages) for later analysis. Individual tags cannot be more than
-         * 30 characters in length.
-         */
-        tags?: Array<string> | null;
-        /**
-         * A unique ID used to correlate this request to processing on your servers. Note:
-         * Courier does not verify the uniqueness of this ID.
-         */
-        trace_id?: string | null;
-        /**
-         * Identify the campaign that refers traffic to a specific website, and attributes
-         * the browser's website session.
-         */
-        utm?: SendAPI.Utm | null;
-    }
-    interface Preferences {
-        /**
-         * The ID of the subscription topic you want to apply to the message. If this is a
-         * templated message, it will override the subscription topic if already associated
-         */
-        subscription_topic_id: string;
-    }
-    interface Providers {
-        /**
-         * A JavaScript conditional expression to determine if the message should be sent
-         * through the channel. Has access to the data and profile object. For example,
-         * `data.name === profile.name`
-         */
-        if?: string | null;
-        metadata?: Providers.Metadata | null;
-        /**
-         * Provider specific overrides.
-         */
-        override?: {
-            [key: string]: unknown;
-        } | null;
-        timeouts?: number | null;
-    }
-    namespace Providers {
-        interface Metadata {
-            utm?: SendAPI.Utm | null;
-        }
-    }
-    /**
-     * Allows you to customize which channel(s) Courier will potentially deliver the
-     * message. If no routing key is specified, Courier will use the default routing
-     * configuration or routing defined by the template.
-     */
-    interface Routing {
-        /**
-         * A list of channels or providers to send the message through. Can also
-         * recursively define sub-routing methods, which can be useful for defining
-         * advanced push notification delivery strategies.
-         */
-        channels: Array<Routing.RoutingStrategyChannel | Routing.RoutingStrategyProvider | string>;
-        method: SendAPI.RoutingMethod;
-    }
-    namespace Routing {
-        interface RoutingStrategyChannel {
-            channel: string;
-            config?: {
-                [key: string]: unknown;
-            } | null;
-            if?: string | null;
-            method?: SendAPI.RoutingMethod | null;
-            providers?: {
-                [key: string]: RoutingStrategyChannel.Providers;
-            } | null;
-        }
-        namespace RoutingStrategyChannel {
-            interface Providers {
-                /**
-                 * A JavaScript conditional expression to determine if the message should be sent
-                 * through the channel. Has access to the data and profile object. For example,
-                 * `data.name === profile.name`
-                 */
-                if?: string | null;
-                metadata?: Providers.Metadata | null;
-                /**
-                 * Provider specific overrides.
-                 */
-                override?: {
-                    [key: string]: unknown;
-                } | null;
-                timeouts?: number | null;
-            }
-            namespace Providers {
-                interface Metadata {
-                    utm?: SendAPI.Utm | null;
-                }
-            }
-        }
-        interface RoutingStrategyProvider {
-            metadata: RoutingStrategyProvider.Metadata;
-            name: string;
-            config?: {
-                [key: string]: unknown;
-            } | null;
-            if?: string | null;
-        }
-        namespace RoutingStrategyProvider {
-            interface Metadata {
-                utm?: SendAPI.Utm | null;
-            }
-        }
-    }
-    /**
-     * Time in ms to attempt the channel before failing over to the next available
-     * channel.
-     */
-    interface Timeout {
-        channel?: {
-            [key: string]: number;
-        } | null;
-        criteria?: 'no-escalation' | 'delivered' | 'viewed' | 'engaged' | null;
-        escalation?: number | null;
-        message?: number | null;
-        provider?: {
-            [key: string]: number;
-        } | null;
-    }
-}
-export interface BaseMessageSendTo {
-    /**
-     * The recipient or a list of recipients of the message
-     */
-    to?: BaseMessageSendTo.AudienceRecipient | BaseMessageSendTo.UnionMember1 | BaseMessageSendTo.UnionMember2 | BulkAPI.UserRecipient | BaseMessageSendTo.SlackRecipient | BaseMessageSendTo.MsTeamsRecipient | {
-        [key: string]: unknown;
-    } | BaseMessageSendTo.PagerdutyRecipient | BaseMessageSendTo.WebhookRecipient | Array<Recipient> | null;
-}
-export declare namespace BaseMessageSendTo {
-    interface AudienceRecipient {
-        /**
-         * A unique identifier associated with an Audience. A message will be sent to each
-         * user in the audience.
-         */
-        audience_id: string;
-        data?: {
-            [key: string]: unknown;
-        } | null;
-        filters?: Array<AudienceRecipient.Filter> | null;
-    }
-    namespace AudienceRecipient {
-        interface Filter {
-            /**
-             * Send to users only if they are member of the account
-             */
-            operator: 'MEMBER_OF';
-            path: 'account_id';
-            value: string;
-        }
-    }
-    interface UnionMember1 {
-        data?: {
-            [key: string]: unknown;
-        } | null;
-        filters?: Array<UnionMember1.Filter> | null;
-        list_id?: string | null;
-    }
-    namespace UnionMember1 {
-        interface Filter {
-            /**
-             * Send to users only if they are member of the account
-             */
-            operator: 'MEMBER_OF';
-            path: 'account_id';
-            value: string;
-        }
-    }
-    interface UnionMember2 {
-        data?: {
-            [key: string]: unknown;
-        } | null;
-        list_pattern?: string | null;
-    }
-    interface SlackRecipient {
-        slack: SlackRecipient.SendToSlackChannel | SlackRecipient.SendToSlackEmail | SlackRecipient.SendToSlackUserID;
-    }
-    namespace SlackRecipient {
-        interface SendToSlackChannel extends SendAPI.SlackBaseProperties {
-            channel: string;
-        }
-        interface SendToSlackEmail extends SendAPI.SlackBaseProperties {
-            email: string;
-        }
-        interface SendToSlackUserID extends SendAPI.SlackBaseProperties {
-            user_id: string;
-        }
-    }
-    interface MsTeamsRecipient {
-        ms_teams: MsTeamsRecipient.SendToMsTeamsUserID | MsTeamsRecipient.SendToMsTeamsEmail | MsTeamsRecipient.SendToMsTeamsChannelID | MsTeamsRecipient.SendToMsTeamsConversationID | MsTeamsRecipient.SendToMsTeamsChannelName;
-    }
-    namespace MsTeamsRecipient {
-        interface SendToMsTeamsUserID extends SendAPI.MsTeamsBaseProperties {
-            user_id: string;
-        }
-        interface SendToMsTeamsEmail extends SendAPI.MsTeamsBaseProperties {
-            email: string;
-        }
-        interface SendToMsTeamsChannelID extends SendAPI.MsTeamsBaseProperties {
-            channel_id: string;
-        }
-        interface SendToMsTeamsConversationID extends SendAPI.MsTeamsBaseProperties {
-            conversation_id: string;
-        }
-        interface SendToMsTeamsChannelName extends SendAPI.MsTeamsBaseProperties {
-            channel_name: string;
-            team_id: string;
-        }
-    }
-    interface PagerdutyRecipient {
-        pagerduty: PagerdutyRecipient.Pagerduty;
-    }
-    namespace PagerdutyRecipient {
-        interface Pagerduty {
-            event_action?: string | null;
-            routing_key?: string | null;
-            severity?: string | null;
-            source?: string | null;
-        }
-    }
-    interface WebhookRecipient {
-        webhook: WebhookRecipient.Webhook;
-    }
-    namespace WebhookRecipient {
-        interface Webhook {
-            /**
-             * The URL to send the webhook request to.
-             */
-            url: string;
-            /**
-             * Authentication configuration for the webhook request.
-             */
-            authentication?: Webhook.Authentication | null;
-            /**
-             * Custom headers to include in the webhook request.
-             */
-            headers?: {
-                [key: string]: string;
-            } | null;
-            /**
-             * The HTTP method to use for the webhook request. Defaults to POST if not
-             * specified.
-             */
-            method?: 'POST' | 'PUT' | null;
-            /**
-             * Specifies what profile information is included in the request payload. Defaults
-             * to 'limited' if not specified.
-             */
-            profile?: 'limited' | 'expanded' | null;
-        }
-        namespace Webhook {
-            /**
-             * Authentication configuration for the webhook request.
-             */
-            interface Authentication {
-                /**
-                 * The authentication mode to use. Defaults to 'none' if not specified.
-                 */
-                mode: 'none' | 'basic' | 'bearer';
-                /**
-                 * Token for bearer authentication.
-                 */
-                token?: string | null;
-                /**
-                 * Password for basic authentication.
-                 */
-                password?: string | null;
-                /**
-                 * Username for basic authentication.
-                 */
-                username?: string | null;
-            }
-        }
-    }
+    message(body: SendMessageParams, options?: RequestOptions): APIPromise<SendMessageResponse>;
 }
 /**
- * Syntatic Sugar to provide a fast shorthand for Courier Elemental Blocks.
+ * The channel element allows a notification to be customized based on which
+ * channel it is sent through. For example, you may want to display a detailed
+ * message when the notification is sent through email, and a more concise message
+ * in a push notification. Channel elements are only valid as top-level elements;
+ * you cannot nest channel elements. If there is a channel element specified at the
+ * top-level of the document, all sibling elements must be channel elements. Note:
+ * As an alternative, most elements support a `channel` property. Which allows you
+ * to selectively display an individual element on a per channel basis. See the
+ * [control flow docs](https://www.courier.com/docs/platform/content/elemental/control-flow/)
+ * for more details.
  */
-export type Content = Content.ElementalContent | Content.ElementalContentSugar;
-export declare namespace Content {
-    interface ElementalContent {
-        elements: Array<SendAPI.ElementalNode>;
-        /**
-         * For example, "2022-01-01"
-         */
-        version: string;
-        brand?: unknown;
-    }
-    /**
-     * Syntatic Sugar to provide a fast shorthand for Courier Elemental Blocks.
-     */
-    interface ElementalContentSugar {
-        /**
-         * The text content displayed in the notification.
-         */
-        body: string;
-        /**
-         * The title to be displayed by supported channels i.e. push, email (as subject)
-         */
-        title: string;
-    }
-}
-export interface ElementalChannelNode {
+export interface ElementalChannelNode extends Shared.ElementalBaseNode {
     /**
      * The channel the contents of this element should be applied to. Can be `email`,
      * `push`, `direct_message`, `sms` or a provider such as slack
      */
     channel: string;
-    channels?: Array<string> | null;
-    /**
-     * An array of elements to apply to the channel. If `raw` has not been specified,
-     * `elements` is `required`.
-     */
-    elements?: Array<ElementalNode> | null;
-    if?: string | null;
-    loop?: string | null;
     /**
      * Raw data to apply to the channel. If `elements` has not been specified, `raw` is
      * `required`.
@@ -486,17 +47,6 @@ export interface ElementalChannelNode {
     raw?: {
         [key: string]: unknown;
     } | null;
-    ref?: string | null;
-}
-export interface ElementalGroupNode {
-    /**
-     * Sub elements to render.
-     */
-    elements: Array<ElementalNode>;
-    channels?: Array<string> | null;
-    if?: string | null;
-    loop?: string | null;
-    ref?: string | null;
 }
 /**
  * The channel element allows a notification to be customized based on which
@@ -510,20 +60,12 @@ export interface ElementalGroupNode {
  * [control flow docs](https://www.courier.com/docs/platform/content/elemental/control-flow/)
  * for more details.
  */
-export type ElementalNode = ElementalNode.UnionMember0 | ElementalNode.UnionMember1 | ElementalNode.UnionMember2 | ElementalNode.UnionMember3 | ElementalNode.UnionMember4 | ElementalNode.UnionMember5 | ElementalNode.UnionMember6 | ElementalNode.UnionMember7;
+export type ElementalNode = ElementalNode.UnionMember0 | ElementalNode.UnionMember1 | ElementalNode.UnionMember2 | ElementalNode.UnionMember3 | ElementalNode.UnionMember4 | ElementalNode.UnionMember5 | ElementalNode.UnionMember6;
 export declare namespace ElementalNode {
-    interface UnionMember0 {
-        channels?: Array<string> | null;
-        if?: string | null;
-        loop?: string | null;
-        ref?: string | null;
+    interface UnionMember0 extends Shared.ElementalBaseNode {
         type?: 'text';
     }
-    interface UnionMember1 {
-        channels?: Array<string> | null;
-        if?: string | null;
-        loop?: string | null;
-        ref?: string | null;
+    interface UnionMember1 extends Shared.ElementalBaseNode {
         type?: 'meta';
     }
     /**
@@ -541,270 +83,272 @@ export declare namespace ElementalNode {
     interface UnionMember2 extends SendAPI.ElementalChannelNode {
         type?: 'channel';
     }
-    interface UnionMember3 {
-        channels?: Array<string> | null;
-        if?: string | null;
-        loop?: string | null;
-        ref?: string | null;
+    interface UnionMember3 extends Shared.ElementalBaseNode {
         type?: 'image';
     }
     interface UnionMember4 {
-        channels?: Array<string> | null;
-        if?: string | null;
-        loop?: string | null;
-        ref?: string | null;
+        /**
+         * A unique id used to identify the action when it is executed.
+         */
+        action_id?: string | null;
+        /**
+         * The alignment of the action button. Defaults to "center".
+         */
+        align?: Shared.Alignment | null;
+        /**
+         * The background color of the action button.
+         */
+        background_color?: string | null;
+        /**
+         * The text content of the action shown to the user.
+         */
+        content?: string;
+        /**
+         * The target URL of the action.
+         */
+        href?: string;
+        /**
+         * Region specific content. See
+         * [locales docs](https://www.courier.com/docs/platform/content/elemental/locales/)
+         * for more details.
+         */
+        locales?: {
+            [key: string]: UnionMember4.Locales;
+        } | null;
+        /**
+         * Defaults to `button`.
+         */
+        style?: 'button' | 'link' | null;
         type?: 'action';
     }
-    interface UnionMember5 {
-        channels?: Array<string> | null;
-        if?: string | null;
-        loop?: string | null;
-        ref?: string | null;
-        type?: 'divider';
+    namespace UnionMember4 {
+        interface Locales {
+            content: string;
+        }
     }
-    /**
-     * Allows you to group elements together. This can be useful when used in
-     * combination with "if" or "loop". See
-     * [control flow docs](https://www.courier.com/docs/platform/content/elemental/control-flow/)
-     * for more details.
-     */
-    interface UnionMember6 extends SendAPI.ElementalGroupNode {
-        type?: 'group';
+    interface UnionMember5 extends Shared.ElementalBaseNode {
+        type?: 'divider';
     }
-    interface UnionMember7 {
-        channels?: Array<string> | null;
-        if?: string | null;
-        loop?: string | null;
-        ref?: string | null;
+    interface UnionMember6 extends Shared.ElementalBaseNode {
         type?: 'quote';
     }
 }
-/**
- * Describes the content of the message in a way that will work for email, push,
- * chat, or any channel.
- */
-export type Message = Message.ContentMessage | Message.TemplateMessage;
-export declare namespace Message {
+export interface MessageContext {
     /**
-     * Describes the content of the message in a way that will work for email, push,
-     * chat, or any channel.
+     * Tenant id used to load brand/default preferences/context.
      */
-    interface ContentMessage extends SendAPI.BaseMessage, SendAPI.BaseMessageSendTo {
-        /**
-         * Describes the content of the message in a way that will work for email, push,
-         * chat, or any channel. Either this or template must be specified.
-         */
-        content: SendAPI.Content;
-    }
+    tenant_id?: string | null;
+}
+export interface Recipient {
     /**
-     * A template for a type of message that can be sent more than once. For example,
-     * you might create an "Appointment Reminder" Notification or “Reset Password”
-     * Notifications.
+     * Use `tenant_id` instead.
      */
-    interface TemplateMessage extends SendAPI.BaseMessage, SendAPI.BaseMessageSendTo {
-        /**
-         * The id of the notification template to be rendered and sent to the recipient(s).
-         * This field or the content field must be supplied.
-         */
-        template: string;
+    account_id?: string | null;
+    /**
+     * Context such as tenant_id to send the notification with.
+     */
+    context?: MessageContext | null;
+    data?: {
+        [key: string]: unknown;
+    } | null;
+    email?: string | null;
+    /**
+     * The user's preferred ISO 639-1 language code.
+     */
+    locale?: string | null;
+    phone_number?: string | null;
+    preferences?: Recipient.Preferences | null;
+    /**
+     * Tenant id. Will load brand, default preferences and base context data.
+     */
+    tenant_id?: string | null;
+    user_id?: string | null;
+}
+export declare namespace Recipient {
+    interface Preferences {
+        notifications: {
+            [key: string]: Shared.Preference;
+        };
+        categories?: {
+            [key: string]: Shared.Preference;
+        } | null;
+        templateId?: string | null;
     }
 }
-export interface MessageContext {
+export interface Utm {
+    campaign?: string | null;
+    content?: string | null;
+    medium?: string | null;
+    source?: string | null;
+    term?: string | null;
+}
+export interface SendMessageResponse {
     /**
-     * An id of a tenant, see
-     * [tenants api docs](https://www.courier.com/docs/reference/tenants/). Will load
-     * brand, default preferences and any other base context data associated with this
-     * tenant.
+     * A successful call to `POST /send` returns a `202` status code along with a
+     * `requestId` in the response body. For single-recipient requests, the `requestId`
+     * is the derived message_id. For multiple recipients, Courier assigns a unique
+     * message_id to each derived message.
      */
-    tenant_id?: string | null;
+    requestId: string;
 }
-export interface MsTeamsBaseProperties {
-    service_url: string;
-    tenant_id: string;
+export interface SendMessageParams {
+    /**
+     * The message property has the following primary top-level properties. They define
+     * the destination and content of the message.
+     */
+    message: SendMessageParams.Message;
 }
-export type Recipient = Recipient.AudienceRecipient | Recipient.UnionMember1 | Recipient.UnionMember2 | BulkAPI.UserRecipient | Recipient.SlackRecipient | Recipient.MsTeamsRecipient | {
-    [key: string]: unknown;
-} | Recipient.PagerdutyRecipient | Recipient.WebhookRecipient;
-export declare namespace Recipient {
-    interface AudienceRecipient {
+export declare namespace SendMessageParams {
+    /**
+     * The message property has the following primary top-level properties. They define
+     * the destination and content of the message.
+     */
+    interface Message {
+        brand_id?: string | null;
         /**
-         * A unique identifier associated with an Audience. A message will be sent to each
-         * user in the audience.
+         * Define run-time configuration for channels. Valid ChannelId's: email, sms, push,
+         * inbox, direct_message, banner, webhook.
          */
-        audience_id: string;
+        channels?: {
+            [key: string]: Message.Channels;
+        } | null;
+        /**
+         * Describes content that will work for email, inbox, push, chat, or any channel
+         * id.
+         */
+        content?: Shared.ElementalContentSugar | TemplatesAPI.ElementalContent;
+        context?: SendAPI.MessageContext | null;
         data?: {
             [key: string]: unknown;
         } | null;
-        filters?: Array<AudienceRecipient.Filter> | null;
+        delay?: Message.Delay | null;
+        expiry?: Message.Expiry | null;
+        metadata?: Message.Metadata | null;
+        preferences?: Message.Preferences | null;
+        providers?: {
+            [key: string]: Message.Providers;
+        } | null;
+        /**
+         * Customize which channels/providers Courier may deliver the message through.
+         */
+        routing?: Message.Routing | null;
+        timeout?: Message.Timeout | null;
+        /**
+         * The recipient or a list of recipients of the message
+         */
+        to?: BulkAPI.UserRecipient | Array<SendAPI.Recipient> | null;
     }
-    namespace AudienceRecipient {
-        interface Filter {
+    namespace Message {
+        interface Channels {
             /**
-             * Send to users only if they are member of the account
+             * Brand id used for rendering.
              */
-            operator: 'MEMBER_OF';
-            path: 'account_id';
-            value: string;
-        }
-    }
-    interface UnionMember1 {
-        data?: {
-            [key: string]: unknown;
-        } | null;
-        filters?: Array<UnionMember1.Filter> | null;
-        list_id?: string | null;
-    }
-    namespace UnionMember1 {
-        interface Filter {
+            brand_id?: string | null;
             /**
-             * Send to users only if they are member of the account
+             * JS conditional with access to data/profile.
              */
-            operator: 'MEMBER_OF';
-            path: 'account_id';
-            value: string;
-        }
-    }
-    interface UnionMember2 {
-        data?: {
-            [key: string]: unknown;
-        } | null;
-        list_pattern?: string | null;
-    }
-    interface SlackRecipient {
-        slack: SlackRecipient.SendToSlackChannel | SlackRecipient.SendToSlackEmail | SlackRecipient.SendToSlackUserID;
-    }
-    namespace SlackRecipient {
-        interface SendToSlackChannel extends SendAPI.SlackBaseProperties {
-            channel: string;
-        }
-        interface SendToSlackEmail extends SendAPI.SlackBaseProperties {
-            email: string;
-        }
-        interface SendToSlackUserID extends SendAPI.SlackBaseProperties {
-            user_id: string;
-        }
-    }
-    interface MsTeamsRecipient {
-        ms_teams: MsTeamsRecipient.SendToMsTeamsUserID | MsTeamsRecipient.SendToMsTeamsEmail | MsTeamsRecipient.SendToMsTeamsChannelID | MsTeamsRecipient.SendToMsTeamsConversationID | MsTeamsRecipient.SendToMsTeamsChannelName;
-    }
-    namespace MsTeamsRecipient {
-        interface SendToMsTeamsUserID extends SendAPI.MsTeamsBaseProperties {
-            user_id: string;
-        }
-        interface SendToMsTeamsEmail extends SendAPI.MsTeamsBaseProperties {
-            email: string;
-        }
-        interface SendToMsTeamsChannelID extends SendAPI.MsTeamsBaseProperties {
-            channel_id: string;
-        }
-        interface SendToMsTeamsConversationID extends SendAPI.MsTeamsBaseProperties {
-            conversation_id: string;
-        }
-        interface SendToMsTeamsChannelName extends SendAPI.MsTeamsBaseProperties {
-            channel_name: string;
-            team_id: string;
+            if?: string | null;
+            metadata?: Channels.Metadata | null;
+            /**
+             * Channel specific overrides.
+             */
+            override?: {
+                [key: string]: unknown;
+            } | null;
+            /**
+             * Providers enabled for this channel.
+             */
+            providers?: Array<string> | null;
+            /**
+             * Defaults to `single`.
+             */
+            routing_method?: 'all' | 'single' | null;
+            timeouts?: Channels.Timeouts | null;
         }
-    }
-    interface PagerdutyRecipient {
-        pagerduty: PagerdutyRecipient.Pagerduty;
-    }
-    namespace PagerdutyRecipient {
-        interface Pagerduty {
-            event_action?: string | null;
-            routing_key?: string | null;
-            severity?: string | null;
-            source?: string | null;
+        namespace Channels {
+            interface Metadata {
+                utm?: SendAPI.Utm | null;
+            }
+            interface Timeouts {
+                channel?: number | null;
+                provider?: number | null;
+            }
         }
-    }
-    interface WebhookRecipient {
-        webhook: WebhookRecipient.Webhook;
-    }
-    namespace WebhookRecipient {
-        interface Webhook {
+        interface Delay {
             /**
-             * The URL to send the webhook request to.
+             * The duration of the delay in milliseconds.
              */
-            url: string;
+            duration?: number | null;
             /**
-             * Authentication configuration for the webhook request.
+             * ISO 8601 timestamp or opening_hours-like format.
              */
-            authentication?: Webhook.Authentication | null;
+            until?: string | null;
+        }
+        interface Expiry {
             /**
-             * Custom headers to include in the webhook request.
+             * Duration in ms or ISO8601 duration (e.g. P1DT4H).
              */
-            headers?: {
-                [key: string]: string;
-            } | null;
+            expires_in: string | number;
             /**
-             * The HTTP method to use for the webhook request. Defaults to POST if not
-             * specified.
+             * Epoch or ISO8601 timestamp with timezone.
              */
-            method?: 'POST' | 'PUT' | null;
+            expires_at?: string | null;
+        }
+        interface Metadata {
+            event?: string | null;
+            tags?: Array<string> | null;
+            trace_id?: string | null;
+            utm?: SendAPI.Utm | null;
+        }
+        interface Preferences {
             /**
-             * Specifies what profile information is included in the request payload. Defaults
-             * to 'limited' if not specified.
+             * The subscription topic to apply to the message.
              */
-            profile?: 'limited' | 'expanded' | null;
+            subscription_topic_id: string;
         }
-        namespace Webhook {
+        interface Providers {
+            /**
+             * JS conditional with access to data/profile.
+             */
+            if?: string | null;
+            metadata?: Providers.Metadata | null;
             /**
-             * Authentication configuration for the webhook request.
+             * Provider-specific overrides.
              */
-            interface Authentication {
-                /**
-                 * The authentication mode to use. Defaults to 'none' if not specified.
-                 */
-                mode: 'none' | 'basic' | 'bearer';
-                /**
-                 * Token for bearer authentication.
-                 */
-                token?: string | null;
-                /**
-                 * Password for basic authentication.
-                 */
-                password?: string | null;
-                /**
-                 * Username for basic authentication.
-                 */
-                username?: string | null;
+            override?: {
+                [key: string]: unknown;
+            } | null;
+            timeouts?: number | null;
+        }
+        namespace Providers {
+            interface Metadata {
+                utm?: SendAPI.Utm | null;
             }
         }
+        /**
+         * Customize which channels/providers Courier may deliver the message through.
+         */
+        interface Routing {
+            /**
+             * A list of channels or providers (or nested routing rules).
+             */
+            channels: Array<Shared.MessageRoutingChannel>;
+            method: 'all' | 'single';
+        }
+        interface Timeout {
+            channel?: {
+                [key: string]: number;
+            } | null;
+            criteria?: 'no-escalation' | 'delivered' | 'viewed' | 'engaged' | null;
+            escalation?: number | null;
+            message?: number | null;
+            provider?: {
+                [key: string]: number;
+            } | null;
+        }
     }
 }
-export type RoutingMethod = 'all' | 'single';
-export interface SlackBaseProperties {
-    access_token: string;
-}
-export interface Utm {
-    campaign?: string | null;
-    content?: string | null;
-    medium?: string | null;
-    source?: string | null;
-    term?: string | null;
-}
-export interface SendSendMessageResponse {
-    /**
-     * A successful call to `POST /send` returns a `202` status code along with a
-     * `requestId` in the response body.
-     *
-     * For send requests that have a single recipient, the `requestId` is assigned to
-     * the derived message as its message_id. Therefore the `requestId` can be supplied
-     * to the Message's API for single recipient messages.
-     *
-     * For send requests that have multiple recipients (accounts, audiences, lists,
-     * etc.), Courier assigns a unique id to each derived message as its `message_id`.
-     * Therefore the `requestId` cannot be supplied to the Message's API for
-     * single-recipient messages.
-     */
-    requestId: string;
-}
-export interface SendSendMessageParams {
-    /**
-     * Defines the message to be delivered
-     */
-    message: Message;
-}
 export declare namespace Send {
-    export { type BaseMessage as BaseMessage, type BaseMessageSendTo as BaseMessageSendTo, type Content as Content, type ElementalChannelNode as ElementalChannelNode, type ElementalGroupNode as ElementalGroupNode, type ElementalNode as ElementalNode, type Message as Message, type MessageContext as MessageContext, type MsTeamsBaseProperties as MsTeamsBaseProperties, type Recipient as Recipient, type RoutingMethod as RoutingMethod, type SlackBaseProperties as SlackBaseProperties, type Utm as Utm, type SendSendMessageResponse as SendSendMessageResponse, type SendSendMessageParams as SendSendMessageParams, };
+    export { type ElementalChannelNode as ElementalChannelNode, type ElementalNode as ElementalNode, type MessageContext as MessageContext, type Recipient as Recipient, type Utm as Utm, type SendMessageResponse as SendMessageResponse, type SendMessageParams as SendMessageParams, };
 }
 //# sourceMappingURL=send.d.ts.map