@trycourier/courier 6.6.0 → 6.7.0-alpha2

package/resources/send.d.ts

@@ -0,0 +1,354 @@
+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' },
+     *   },
+     * });
+     * ```
+     */
+    message(body: SendMessageParams, options?: RequestOptions): APIPromise<SendMessageResponse>;
+}
+/**
+ * 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 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;
+    /**
+     * Raw data to apply to the channel. If `elements` has not been specified, `raw` is
+     * `required`.
+     */
+    raw?: {
+        [key: string]: unknown;
+    } | null;
+}
+/**
+ * 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 ElementalNode = ElementalNode.UnionMember0 | ElementalNode.UnionMember1 | ElementalNode.UnionMember2 | ElementalNode.UnionMember3 | ElementalNode.UnionMember4 | ElementalNode.UnionMember5 | ElementalNode.UnionMember6;
+export declare namespace ElementalNode {
+    interface UnionMember0 extends Shared.ElementalBaseNode {
+        type?: 'text';
+    }
+    interface UnionMember1 extends Shared.ElementalBaseNode {
+        type?: 'meta';
+    }
+    /**
+     * 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.
+     */
+    interface UnionMember2 extends SendAPI.ElementalChannelNode {
+        type?: 'channel';
+    }
+    interface UnionMember3 extends Shared.ElementalBaseNode {
+        type?: 'image';
+    }
+    interface UnionMember4 {
+        /**
+         * 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';
+    }
+    namespace UnionMember4 {
+        interface Locales {
+            content: string;
+        }
+    }
+    interface UnionMember5 extends Shared.ElementalBaseNode {
+        type?: 'divider';
+    }
+    interface UnionMember6 extends Shared.ElementalBaseNode {
+        type?: 'quote';
+    }
+}
+export interface MessageContext {
+    /**
+     * Tenant id used to load brand/default preferences/context.
+     */
+    tenant_id?: string | null;
+}
+export interface Recipient {
+    /**
+     * Use `tenant_id` instead.
+     */
+    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 Utm {
+    campaign?: string | null;
+    content?: string | null;
+    medium?: string | null;
+    source?: string | null;
+    term?: string | null;
+}
+export interface SendMessageResponse {
+    /**
+     * 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.
+     */
+    requestId: 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 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;
+        /**
+         * Define run-time configuration for channels. Valid ChannelId's: email, sms, push,
+         * inbox, direct_message, banner, webhook.
+         */
+        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;
+        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 Message {
+        interface Channels {
+            /**
+             * Brand id used for rendering.
+             */
+            brand_id?: string | null;
+            /**
+             * JS conditional with access to data/profile.
+             */
+            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;
+        }
+        namespace Channels {
+            interface Metadata {
+                utm?: SendAPI.Utm | null;
+            }
+            interface Timeouts {
+                channel?: number | null;
+                provider?: number | null;
+            }
+        }
+        interface Delay {
+            /**
+             * The duration of the delay in milliseconds.
+             */
+            duration?: number | null;
+            /**
+             * ISO 8601 timestamp or opening_hours-like format.
+             */
+            until?: string | null;
+        }
+        interface Expiry {
+            /**
+             * Duration in ms or ISO8601 duration (e.g. P1DT4H).
+             */
+            expires_in: string | number;
+            /**
+             * Epoch or ISO8601 timestamp with timezone.
+             */
+            expires_at?: string | null;
+        }
+        interface Metadata {
+            event?: string | null;
+            tags?: Array<string> | null;
+            trace_id?: string | null;
+            utm?: SendAPI.Utm | null;
+        }
+        interface Preferences {
+            /**
+             * The subscription topic to apply to the message.
+             */
+            subscription_topic_id: string;
+        }
+        interface Providers {
+            /**
+             * JS conditional with access to data/profile.
+             */
+            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;
+            }
+        }
+        /**
+         * 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 declare namespace Send {
+    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

package/resources/send.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"send.d.ts","sourceRoot":"","sources":["../src/resources/send.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,KAAK,OAAO;OACZ,KAAK,MAAM;OACX,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAG5F;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,oBAAqB,SAAQ,MAAM,CAAC,iBAAiB;IACpE;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,GAAG,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CACzC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,aAAa,GACrB,aAAa,CAAC,YAAY,GAC1B,aAAa,CAAC,YAAY,GAC1B,aAAa,CAAC,YAAY,GAC1B,aAAa,CAAC,YAAY,GAC1B,aAAa,CAAC,YAAY,GAC1B,aAAa,CAAC,YAAY,GAC1B,aAAa,CAAC,YAAY,CAAC;AAE/B,yBAAiB,aAAa,CAAC;IAC7B,UAAiB,YAAa,SAAQ,MAAM,CAAC,iBAAiB;QAC5D,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,YAAa,SAAQ,MAAM,CAAC,iBAAiB;QAC5D,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED;;;;;;;;;;;OAWG;IACH,UAAiB,YAAa,SAAQ,OAAO,CAAC,oBAAoB;QAChE,IAAI,CAAC,EAAE,SAAS,CAAC;KAClB;IAED,UAAiB,YAAa,SAAQ,MAAM,CAAC,iBAAiB;QAC5D,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED,UAAiB,YAAY;QAC3B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;QAEhC;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;;WAIG;QACH,OAAO,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAC,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAEzD;;WAEG;QACH,KAAK,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,IAAI,CAAC;QAEjC,IAAI,CAAC,EAAE,QAAQ,CAAC;KACjB;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,OAAO;YACtB,OAAO,EAAE,MAAM,CAAC;SACjB;KACF;IAED,UAAiB,YAAa,SAAQ,MAAM,CAAC,iBAAiB;QAC5D,IAAI,CAAC,EAAE,SAAS,CAAC;KAClB;IAED,UAAiB,YAAa,SAAQ,MAAM,CAAC,iBAAiB;QAC5D,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAEhC,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEzC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,WAAW,CAAC,EAAE,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,SAAS,CAAC;IACzB,UAAiB,WAAW;QAC1B,aAAa,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,UAAU,CAAA;SAAE,CAAC;QAEpD,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,UAAU,CAAA;SAAE,GAAG,IAAI,CAAC;QAEzD,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,GAAG;IAClB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC;CACpC;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;;OAGG;IACH,UAAiB,OAAO;QACtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;WAGG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAA;SAAE,GAAG,IAAI,CAAC;QAEtD;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC,qBAAqB,GAAG,YAAY,CAAC,gBAAgB,CAAC;QAEvE,OAAO,CAAC,EAAE,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;QAExC,IAAI,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAEzC,KAAK,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;QAE7B,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;QAE/B,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEnC,WAAW,CAAC,EAAE,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;QAEzC,SAAS,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAA;SAAE,GAAG,IAAI,CAAC;QAExD;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;QAEjC,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,EAAE,CAAC,EAAE,OAAO,CAAC,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;KAC9D;IAED,UAAiB,OAAO,CAAC;QACvB,UAAiB,QAAQ;YACvB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEnB,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC;YAEpC;;eAEG;YACH,QAAQ,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,GAAG,IAAI,CAAC;YAE7C;;eAEG;YACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;YAEjC;;eAEG;YACH,cAAc,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,IAAI,CAAC;YAEzC,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC;SACrC;QAED,UAAiB,QAAQ,CAAC;YACxB,UAAiB,QAAQ;gBACvB,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC;aAC1B;YAED,UAAiB,QAAQ;gBACvB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAExB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;aAC1B;SACF;QAED,UAAiB,KAAK;YACpB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACvB;QAED,UAAiB,MAAM;YACrB;;eAEG;YACH,UAAU,EAAE,MAAM,GAAG,MAAM,CAAC;YAE5B;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC5B;QAED,UAAiB,QAAQ;YACvB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;YAE5B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC;SAC1B;QAED,UAAiB,WAAW;YAC1B;;eAEG;YACH,qBAAqB,EAAE,MAAM,CAAC;SAC/B;QAED,UAAiB,SAAS;YACxB;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEnB,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,GAAG,IAAI,CAAC;YAErC;;eAEG;YACH,QAAQ,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,GAAG,IAAI,CAAC;YAE7C,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC1B;QAED,UAAiB,SAAS,CAAC;YACzB,UAAiB,QAAQ;gBACvB,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC;aAC1B;SACF;QAED;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;YAE9C,MAAM,EAAE,KAAK,GAAG,QAAQ,CAAC;SAC1B;QAED,UAAiB,OAAO;YACtB,OAAO,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,GAAG,IAAI,CAAC;YAE3C,QAAQ,CAAC,EAAE,eAAe,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,GAAG,IAAI,CAAC;YAEvE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB,QAAQ,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,GAAG,IAAI,CAAC;SAC7C;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,GAAG,IAAI,GAAG,EACf,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/send.js

@@ -0,0 +1,26 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Send = void 0;
+const resource_1 = require("../core/resource.js");
+class Send extends resource_1.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' },
+     *   },
+     * });
+     * ```
+     */
+    message(body, options) {
+        return this._client.post('/send', { body, ...options });
+    }
+}
+exports.Send = Send;
+//# sourceMappingURL=send.js.map

package/resources/send.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"send.js","sourceRoot":"","sources":["../src/resources/send.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAQ/C,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,IAAuB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC;CACF;AAlBD,oBAkBC"}

package/resources/send.mjs

@@ -0,0 +1,22 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+export 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' },
+     *   },
+     * });
+     * ```
+     */
+    message(body, options) {
+        return this._client.post('/send', { body, ...options });
+    }
+}
+//# sourceMappingURL=send.mjs.map

package/resources/send.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"send.mjs","sourceRoot":"","sources":["../src/resources/send.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAQtB,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,IAAuB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC;CACF"}

package/resources/shared.d.mts

@@ -0,0 +1,42 @@
+import * as PreferencesAPI from "./users/preferences.mjs";
+import * as ItemsAPI from "./tenants/default-preferences/items.mjs";
+export type Alignment = 'center' | 'left' | 'right' | 'full';
+export interface ChannelPreference {
+    channel: ItemsAPI.ChannelClassification;
+}
+export interface ElementalBaseNode {
+    channels?: Array<string> | null;
+    if?: string | null;
+    loop?: string | null;
+    ref?: string | null;
+}
+/**
+ * Syntactic sugar to provide a fast shorthand for Courier Elemental Blocks.
+ */
+export interface ElementalContentSugar {
+    /**
+     * The text content displayed in the notification.
+     */
+    body: string;
+    /**
+     * Title/subject displayed by supported channels.
+     */
+    title: string;
+}
+export interface MessageRouting {
+    channels: Array<MessageRoutingChannel>;
+    method: 'all' | 'single';
+}
+export type MessageRoutingChannel = string | MessageRouting;
+export interface Preference {
+    status: PreferencesAPI.PreferenceStatus;
+    channel_preferences?: Array<ChannelPreference> | null;
+    rules?: Array<Rule> | null;
+    source?: 'subscription' | 'list' | 'recipient' | null;
+}
+export interface Rule {
+    until: string;
+    start?: string | null;
+}
+export type TextStyle = 'text' | 'h1' | 'h2' | 'subtext';
+//# sourceMappingURL=shared.d.mts.map

package/resources/shared.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.d.mts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"OAEO,KAAK,cAAc;OACnB,KAAK,QAAQ;AAEpB,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;AAE7D,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,QAAQ,CAAC,qBAAqB,CAAC;CACzC;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEhC,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAEvC,MAAM,EAAE,KAAK,GAAG,QAAQ,CAAC;CAC1B;AAED,MAAM,MAAM,qBAAqB,GAAG,MAAM,GAAG,cAAc,CAAC;AAE5D,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,cAAc,CAAC,gBAAgB,CAAC;IAExC,mBAAmB,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IAEtD,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAE3B,MAAM,CAAC,EAAE,cAAc,GAAG,MAAM,GAAG,WAAW,GAAG,IAAI,CAAC;CACvD;AAED,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC"}

package/resources/shared.d.ts

@@ -0,0 +1,42 @@
+import * as PreferencesAPI from "./users/preferences.js";
+import * as ItemsAPI from "./tenants/default-preferences/items.js";
+export type Alignment = 'center' | 'left' | 'right' | 'full';
+export interface ChannelPreference {
+    channel: ItemsAPI.ChannelClassification;
+}
+export interface ElementalBaseNode {
+    channels?: Array<string> | null;
+    if?: string | null;
+    loop?: string | null;
+    ref?: string | null;
+}
+/**
+ * Syntactic sugar to provide a fast shorthand for Courier Elemental Blocks.
+ */
+export interface ElementalContentSugar {
+    /**
+     * The text content displayed in the notification.
+     */
+    body: string;
+    /**
+     * Title/subject displayed by supported channels.
+     */
+    title: string;
+}
+export interface MessageRouting {
+    channels: Array<MessageRoutingChannel>;
+    method: 'all' | 'single';
+}
+export type MessageRoutingChannel = string | MessageRouting;
+export interface Preference {
+    status: PreferencesAPI.PreferenceStatus;
+    channel_preferences?: Array<ChannelPreference> | null;
+    rules?: Array<Rule> | null;
+    source?: 'subscription' | 'list' | 'recipient' | null;
+}
+export interface Rule {
+    until: string;
+    start?: string | null;
+}
+export type TextStyle = 'text' | 'h1' | 'h2' | 'subtext';
+//# sourceMappingURL=shared.d.ts.map

package/resources/shared.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"OAEO,KAAK,cAAc;OACnB,KAAK,QAAQ;AAEpB,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;AAE7D,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,QAAQ,CAAC,qBAAqB,CAAC;CACzC;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEhC,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAEvC,MAAM,EAAE,KAAK,GAAG,QAAQ,CAAC;CAC1B;AAED,MAAM,MAAM,qBAAqB,GAAG,MAAM,GAAG,cAAc,CAAC;AAE5D,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,cAAc,CAAC,gBAAgB,CAAC;IAExC,mBAAmB,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IAEtD,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAE3B,MAAM,CAAC,EAAE,cAAc,GAAG,MAAM,GAAG,WAAW,GAAG,IAAI,CAAC;CACvD;AAED,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC"}

package/resources/shared.js

@@ -0,0 +1,4 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=shared.js.map

package/resources/shared.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.js","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":";AAAA,sFAAsF"}

package/resources/shared.mjs

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export {};
+//# sourceMappingURL=shared.mjs.map

package/resources/shared.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.mjs","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAAA,sFAAsF"}

package/resources/tenants/default-preferences/default-preferences.d.mts

@@ -0,0 +1,10 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as ItemsAPI from "./items.mjs";
+import { ChannelClassification, ItemDeleteParams, ItemUpdateParams, Items, SubscriptionTopicNew } from "./items.mjs";
+export declare class DefaultPreferences extends APIResource {
+    items: ItemsAPI.Items;
+}
+export declare namespace DefaultPreferences {
+    export { Items as Items, type ChannelClassification as ChannelClassification, type SubscriptionTopicNew as SubscriptionTopicNew, type ItemUpdateParams as ItemUpdateParams, type ItemDeleteParams as ItemDeleteParams, };
+}
+//# sourceMappingURL=default-preferences.d.mts.map

package/resources/tenants/default-preferences/default-preferences.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-preferences.d.mts","sourceRoot":"","sources":["../../../src/resources/tenants/default-preferences/default-preferences.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,EACL,qBAAqB,EACrB,gBAAgB,EAChB,gBAAgB,EAChB,KAAK,EACL,oBAAoB,EACrB;AAED,qBAAa,kBAAmB,SAAQ,WAAW;IACjD,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;CAC1D;AAID,MAAM,CAAC,OAAO,WAAW,kBAAkB,CAAC;IAC1C,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

package/resources/tenants/default-preferences/default-preferences.d.ts

@@ -0,0 +1,10 @@
+import { APIResource } from "../../../core/resource.js";
+import * as ItemsAPI from "./items.js";
+import { ChannelClassification, ItemDeleteParams, ItemUpdateParams, Items, SubscriptionTopicNew } from "./items.js";
+export declare class DefaultPreferences extends APIResource {
+    items: ItemsAPI.Items;
+}
+export declare namespace DefaultPreferences {
+    export { Items as Items, type ChannelClassification as ChannelClassification, type SubscriptionTopicNew as SubscriptionTopicNew, type ItemUpdateParams as ItemUpdateParams, type ItemDeleteParams as ItemDeleteParams, };
+}
+//# sourceMappingURL=default-preferences.d.ts.map

package/resources/tenants/default-preferences/default-preferences.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-preferences.d.ts","sourceRoot":"","sources":["../../../src/resources/tenants/default-preferences/default-preferences.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,EACL,qBAAqB,EACrB,gBAAgB,EAChB,gBAAgB,EAChB,KAAK,EACL,oBAAoB,EACrB;AAED,qBAAa,kBAAmB,SAAQ,WAAW;IACjD,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;CAC1D;AAID,MAAM,CAAC,OAAO,WAAW,kBAAkB,CAAC;IAC1C,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

package/resources/tenants/default-preferences/default-preferences.js

@@ -0,0 +1,17 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultPreferences = void 0;
+const tslib_1 = require("../../../internal/tslib.js");
+const resource_1 = require("../../../core/resource.js");
+const ItemsAPI = tslib_1.__importStar(require("./items.js"));
+const items_1 = require("./items.js");
+class DefaultPreferences extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.items = new ItemsAPI.Items(this._client);
+    }
+}
+exports.DefaultPreferences = DefaultPreferences;
+DefaultPreferences.Items = items_1.Items;
+//# sourceMappingURL=default-preferences.js.map

package/resources/tenants/default-preferences/default-preferences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-preferences.js","sourceRoot":"","sources":["../../../src/resources/tenants/default-preferences/default-preferences.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AACrD,6DAAoC;AACpC,sCAMiB;AAEjB,MAAa,kBAAmB,SAAQ,sBAAW;IAAnD;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3D,CAAC;CAAA;AAFD,gDAEC;AAED,kBAAkB,CAAC,KAAK,GAAG,aAAK,CAAC"}

package/resources/tenants/default-preferences/default-preferences.mjs

@@ -0,0 +1,12 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../core/resource.mjs";
+import * as ItemsAPI from "./items.mjs";
+import { Items, } from "./items.mjs";
+export class DefaultPreferences extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.items = new ItemsAPI.Items(this._client);
+    }
+}
+DefaultPreferences.Items = Items;
+//# sourceMappingURL=default-preferences.mjs.map

package/resources/tenants/default-preferences/default-preferences.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-preferences.mjs","sourceRoot":"","sources":["../../../src/resources/tenants/default-preferences/default-preferences.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,EAIL,KAAK,GAEN;AAED,MAAM,OAAO,kBAAmB,SAAQ,WAAW;IAAnD;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3D,CAAC;CAAA;AAED,kBAAkB,CAAC,KAAK,GAAG,KAAK,CAAC"}

package/resources/tenants/default-preferences/index.d.mts

@@ -0,0 +1,3 @@
+export { DefaultPreferences } from "./default-preferences.mjs";
+export { Items, type ChannelClassification, type SubscriptionTopicNew, type ItemUpdateParams, type ItemDeleteParams, } from "./items.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/tenants/default-preferences/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/tenants/default-preferences/index.ts"],"names":[],"mappings":"OAEO,EAAE,kBAAkB,EAAE;OACtB,EACL,KAAK,EACL,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,GACtB"}

package/resources/tenants/default-preferences/index.d.ts

@@ -0,0 +1,3 @@
+export { DefaultPreferences } from "./default-preferences.js";
+export { Items, type ChannelClassification, type SubscriptionTopicNew, type ItemUpdateParams, type ItemDeleteParams, } from "./items.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/tenants/default-preferences/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/tenants/default-preferences/index.ts"],"names":[],"mappings":"OAEO,EAAE,kBAAkB,EAAE;OACtB,EACL,KAAK,EACL,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,GACtB"}

package/resources/tenants/default-preferences/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Items = exports.DefaultPreferences = void 0;
+var default_preferences_1 = require("./default-preferences.js");
+Object.defineProperty(exports, "DefaultPreferences", { enumerable: true, get: function () { return default_preferences_1.DefaultPreferences; } });
+var items_1 = require("./items.js");
+Object.defineProperty(exports, "Items", { enumerable: true, get: function () { return items_1.Items; } });
+//# sourceMappingURL=index.js.map

package/resources/tenants/default-preferences/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/tenants/default-preferences/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gEAA2D;AAAlD,yHAAA,kBAAkB,OAAA;AAC3B,oCAMiB;AALf,8FAAA,KAAK,OAAA"}

package/resources/tenants/default-preferences/index.mjs

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { DefaultPreferences } from "./default-preferences.mjs";
+export { Items, } from "./items.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/tenants/default-preferences/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/tenants/default-preferences/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,kBAAkB,EAAE;OACtB,EACL,KAAK,GAKN"}