@trycourier/courier 6.6.0 → 6.7.0-alpha2

package/dist/api/resources/send/types/ChannelMetadata.d.ts

@@ -1,7 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../../index";
-export interface ChannelMetadata {
-    utm?: Courier.Utm;
-}

package/dist/api/resources/send/types/ChannelMetadata.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/ChannelSource.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type ChannelSource = "subscription" | "list" | "recipient";
-export declare const ChannelSource: {
-    readonly Subscription: "subscription";
-    readonly List: "list";
-    readonly Recipient: "recipient";
-};

package/dist/api/resources/send/types/ChannelSource.js

@@ -1,11 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChannelSource = void 0;
-exports.ChannelSource = {
-    Subscription: "subscription",
-    List: "list",
-    Recipient: "recipient",
-};

package/dist/api/resources/send/types/Content.d.ts

@@ -1,5 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../../index";
-export type Content = Courier.ElementalContent | Courier.ElementalContentSugar;

package/dist/api/resources/send/types/Content.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/ContentMessage.d.ts

@@ -1,15 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../../index";
-/**
- * The message property has the following primary top-level properties. They define the destination and content of the message.
- * Additional advanced configuration fields [are defined below](https://www.courier.com/docs/reference/send/message/#other-message-properties).
- */
-export interface ContentMessage extends Courier.BaseMessage, Courier.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: Courier.Content;
-}

package/dist/api/resources/send/types/ContentMessage.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/Criteria.d.ts

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type Criteria = "no-escalation" | "delivered" | "viewed" | "engaged";
-export declare const Criteria: {
-    readonly NoEscalation: "no-escalation";
-    readonly Delivered: "delivered";
-    readonly Viewed: "viewed";
-    readonly Engaged: "engaged";
-};

package/dist/api/resources/send/types/Criteria.js

@@ -1,12 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Criteria = void 0;
-exports.Criteria = {
-    NoEscalation: "no-escalation",
-    Delivered: "delivered",
-    Viewed: "viewed",
-    Engaged: "engaged",
-};

package/dist/api/resources/send/types/Delay.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface Delay {
-    /** The duration of the delay in milliseconds. */
-    duration?: number;
-    /** 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;
-}

package/dist/api/resources/send/types/Delay.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/ElementalActionNode.d.ts

@@ -1,23 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../../index";
-/**
- * Allows the user to execute an action. Can be a button or a link.
- */
-export interface ElementalActionNode extends Courier.ElementalBaseNode {
-    /** The text content of the action shown to the user. */
-    content: string;
-    /** The target URL of the action. */
-    href: string;
-    /** A unique id used to identify the action when it is executed. */
-    action_id?: string;
-    /** The alignment of the action button. Defaults to "center". */
-    align?: Courier.IAlignment;
-    /** The background color of the action button. */
-    background_color?: string;
-    /** Defaults to `button`. */
-    style?: Courier.IActionButtonStyle;
-    /** Region specific content. See [locales docs](https://www.courier.com/docs/platform/content/elemental/locales/) for more details. */
-    locales?: Courier.Locales;
-}

package/dist/api/resources/send/types/ElementalActionNode.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/ElementalBaseNode.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface ElementalBaseNode {
-    channels?: string[];
-    ref?: string;
-    if?: string;
-    loop?: string;
-}

package/dist/api/resources/send/types/ElementalBaseNode.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/ElementalChannelNode.d.ts

@@ -1,31 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../../index";
-/**
- * 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 Courier.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;
-    /**
-     * An array of elements to apply to the channel. If `raw` has not been
-     * specified, `elements` is `required`.
-     */
-    elements?: Courier.ElementalNode[];
-    /**
-     * Raw data to apply to the channel. If `elements` has not been
-     * specified, `raw` is `required`.
-     */
-    raw?: Record<string, any>;
-}

package/dist/api/resources/send/types/ElementalChannelNode.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/ElementalContent.d.ts

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../../index";
-export interface ElementalContent {
-    /** For example, "2022-01-01" */
-    version: string;
-    brand?: any;
-    elements: Courier.ElementalNode[];
-}

package/dist/api/resources/send/types/ElementalContent.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/ElementalContentSugar.d.ts

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Syntatic Sugar to provide a fast shorthand for Courier Elemental Blocks.
- */
-export interface ElementalContentSugar {
-    /** The title to be displayed by supported channels i.e. push, email (as subject) */
-    title: string;
-    /** The text content displayed in the notification. */
-    body: string;
-}

package/dist/api/resources/send/types/ElementalContentSugar.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/ElementalDividerNode.d.ts

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../../index";
-/**
- * Renders a dividing line between elements.
- */
-export interface ElementalDividerNode extends Courier.ElementalBaseNode {
-    /** The CSS color to render the line with. For example, `#fff` */
-    color?: string;
-}

package/dist/api/resources/send/types/ElementalDividerNode.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/ElementalGroupNode.d.ts

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../../index";
-/**
- * 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.
- */
-export interface ElementalGroupNode extends Courier.ElementalBaseNode {
-    /** Sub elements to render. */
-    elements: Courier.ElementalNode[];
-}

package/dist/api/resources/send/types/ElementalGroupNode.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/ElementalImageNode.d.ts

@@ -1,19 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../../index";
-/**
- * Used to embed an image into the notification.
- */
-export interface ElementalImageNode extends Courier.ElementalBaseNode {
-    /** The source of the image. */
-    src: string;
-    /** A URL to link to when the image is clicked. */
-    href?: string;
-    /** The alignment of the image. */
-    align?: Courier.IAlignment;
-    /** Alternate text for the image. */
-    altText?: string;
-    /** CSS width properties to apply to the image. For example, 50px */
-    width?: string;
-}

package/dist/api/resources/send/types/ElementalImageNode.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/ElementalMetaNode.d.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../../index";
-/**
- * The meta element contains information describing the notification that may
- * be used by a particular channel or provider. One important field is the title
- * field which will be used as the title for channels that support it.
- */
-export interface ElementalMetaNode extends Courier.ElementalBaseNode {
-    /** The title to be displayed by supported channels. For example, the email subject. */
-    title?: string;
-}

package/dist/api/resources/send/types/ElementalMetaNode.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/ElementalNode.d.ts

@@ -1,31 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../../index";
-export type ElementalNode = Courier.ElementalNode.Text | Courier.ElementalNode.Meta | Courier.ElementalNode.Channel | Courier.ElementalNode.Image | Courier.ElementalNode.Action | Courier.ElementalNode.Divider | Courier.ElementalNode.Group | Courier.ElementalNode.Quote;
-export declare namespace ElementalNode {
-    interface Text extends Courier.ElementalTextNode {
-        type: "text";
-    }
-    interface Meta extends Courier.ElementalMetaNode {
-        type: "meta";
-    }
-    interface Channel extends Courier.ElementalChannelNode {
-        type: "channel";
-    }
-    interface Image extends Courier.ElementalImageNode {
-        type: "image";
-    }
-    interface Action extends Courier.ElementalActionNode {
-        type: "action";
-    }
-    interface Divider extends Courier.ElementalDividerNode {
-        type: "divider";
-    }
-    interface Group extends Courier.ElementalGroupNode {
-        type: "group";
-    }
-    interface Quote extends Courier.ElementalQuoteNode {
-        type: "quote";
-    }
-}

package/dist/api/resources/send/types/ElementalNode.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/ElementalQuoteNode.d.ts

@@ -1,18 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../../index";
-/**
- * Renders a quote block.
- */
-export interface ElementalQuoteNode extends Courier.ElementalBaseNode {
-    /** The text value of the quote. */
-    content: string;
-    /** Alignment of the quote. */
-    align?: Courier.IAlignment;
-    /** CSS border color property. For example, `#fff` */
-    borderColor?: string;
-    text_style: Courier.TextStyle;
-    /** Region specific content. See [locales docs](https://www.courier.com/docs/platform/content/elemental/locales/) for more details. */
-    locales?: Courier.Locales;
-}

package/dist/api/resources/send/types/ElementalQuoteNode.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/ElementalTextNode.d.ts

@@ -1,31 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../../index";
-/**
- * Represents a body of text to be rendered inside of the notification.
- */
-export interface ElementalTextNode extends Courier.ElementalBaseNode {
-    /**
-     * The text content displayed in the notification. Either this
-     * field must be specified, or the elements field
-     */
-    content: string;
-    /** Text alignment. */
-    align: Courier.TextAlign;
-    /** Allows the text to be rendered as a heading level. */
-    text_style?: Courier.TextStyle;
-    /** Specifies the color of text. Can be any valid css color value */
-    color?: string;
-    /** Apply bold to the text */
-    bold?: string;
-    /** Apply italics to the text */
-    italic?: string;
-    /** Apply a strike through the text */
-    strikethrough?: string;
-    /** Apply an underline to the text */
-    underline?: string;
-    /** Region specific content. See [locales docs](https://www.courier.com/docs/platform/content/elemental/locales/) for more details. */
-    locales?: Courier.Locales | undefined;
-    format?: "markdown";
-}

package/dist/api/resources/send/types/ElementalTextNode.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/EmailFooter.d.ts

@@ -1,7 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface EmailFooter {
-    content?: any;
-    inheritDefault?: boolean;
-}

package/dist/api/resources/send/types/EmailFooter.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/EmailHead.d.ts

@@ -1,7 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface EmailHead {
-    inheritDefault: boolean;
-    content?: string;
-}

package/dist/api/resources/send/types/EmailHead.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/EmailHeader.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../../index";
-export interface EmailHeader {
-    inheritDefault?: boolean;
-    barColor?: string;
-    logo: Courier.Logo;
-}

package/dist/api/resources/send/types/EmailHeader.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/ExpiresInType.d.ts

@@ -1,4 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type ExpiresInType = string | number;

package/dist/api/resources/send/types/ExpiresInType.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/Expiry.d.ts

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../../index";
-export interface Expiry {
-    /** 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;
-    /** A duration in the form of milliseconds or an ISO8601 Duration format (i.e. P1DT4H). */
-    expires_in: Courier.ExpiresInType;
-}

package/dist/api/resources/send/types/Expiry.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/IActionButtonStyle.d.ts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type IActionButtonStyle = "button" | "link";
-export declare const IActionButtonStyle: {
-    readonly Button: "button";
-    readonly Link: "link";
-};

package/dist/api/resources/send/types/IActionButtonStyle.js

@@ -1,10 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IActionButtonStyle = void 0;
-exports.IActionButtonStyle = {
-    Button: "button",
-    Link: "link",
-};

package/dist/api/resources/send/types/IAlignment.d.ts

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type IAlignment = "center" | "left" | "right" | "full";
-export declare const IAlignment: {
-    readonly Center: "center";
-    readonly Left: "left";
-    readonly Right: "right";
-    readonly Full: "full";
-};

package/dist/api/resources/send/types/IAlignment.js

@@ -1,12 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IAlignment = void 0;
-exports.IAlignment = {
-    Center: "center",
-    Left: "left",
-    Right: "right",
-    Full: "full",
-};

package/dist/api/resources/send/types/IPreferences.d.ts

@@ -1,5 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../../index";
-export type IPreferences = Record<string, Courier.Preference>;

package/dist/api/resources/send/types/IPreferences.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/IProfilePreferences.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../../index";
-export interface IProfilePreferences {
-    categories?: Courier.IPreferences;
-    notifications: Courier.IPreferences;
-    templateId?: string;
-}

package/dist/api/resources/send/types/IProfilePreferences.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/Icons.d.ts

@@ -1,7 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface Icons {
-    bell?: string;
-    message?: string;
-}

package/dist/api/resources/send/types/Icons.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/send/types/InAppPlacement.d.ts

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type InAppPlacement = "top" | "bottom" | "left" | "right";
-export declare const InAppPlacement: {
-    readonly Top: "top";
-    readonly Bottom: "bottom";
-    readonly Left: "left";
-    readonly Right: "right";
-};