@trycourier/courier 5.7.0 → 6.0.1

package/api/resources/send/types/InAppPlacement.js

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

package/api/resources/send/types/InvalidListPatternRecipient.d.ts

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

package/api/resources/send/types/InvalidListPatternRecipient.js

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

package/api/resources/send/types/InvalidListRecipient.d.ts

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

package/api/resources/send/types/InvalidListRecipient.js

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

package/api/resources/send/types/InvalidUserRecipient.d.ts

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

package/api/resources/send/types/InvalidUserRecipient.js

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

package/api/resources/send/types/ListFilter.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ListFilter {
+    /** Send to users only if they are member of the account */
+    operator: "MEMBER_OF";
+    path: "account_id";
+    value: string;
+}

package/api/resources/send/types/ListFilter.js

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

package/api/resources/send/types/ListPatternRecipient.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface ListPatternRecipient extends Courier.ListPatternRecipientType {
+    list_pattern?: string;
+    data?: Courier.MessageData;
+}

package/api/resources/send/types/ListPatternRecipient.js

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

package/api/resources/send/types/ListPatternRecipientType.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ListPatternRecipientType {
+}

package/api/resources/send/types/ListPatternRecipientType.js

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

package/api/resources/send/types/ListRecipient.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface ListRecipient extends Courier.ListRecipientType {
+    list_id?: string;
+    data?: Courier.MessageData;
+    filters?: Courier.ListFilter[];
+}

package/api/resources/send/types/ListRecipient.js

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

package/api/resources/send/types/ListRecipientType.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ListRecipientType {
+}

package/api/resources/send/types/ListRecipientType.js

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

package/api/resources/send/types/Locale.d.ts

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

package/api/resources/send/types/Locale.js

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

package/api/resources/send/types/Locales.d.ts

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

package/api/resources/send/types/Locales.js

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

package/api/resources/send/types/Logo.d.ts

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

package/api/resources/send/types/Logo.js

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

package/api/resources/send/types/Message.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export declare type Message = 
+/**
+ * Describes the content of the message in a way that will work for email, push, chat, or any channel. */
+Courier.ContentMessage
+/**
+ * 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. */
+ | Courier.TemplateMessage;

package/api/resources/send/types/Message.js

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

package/api/resources/send/types/MessageChannelEmailOverride.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface MessageChannelEmailOverride {
+    attachments?: Courier.Attachment[];
+    bcc?: string;
+    brand?: Courier.Brand;
+    cc?: string;
+    from?: string;
+    html?: string;
+    reply_to?: string;
+    subject?: string;
+    text?: string;
+    tracking: Courier.TrackingOverride;
+}

package/api/resources/send/types/MessageChannelEmailOverride.js

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

package/api/resources/send/types/MessageChannels.d.ts

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

package/api/resources/send/types/MessageChannels.js

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

package/api/resources/send/types/MessageContext.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface MessageContext {
+    /**
+     * 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.
+     *
+     */
+    tenant_id?: string;
+}

package/api/resources/send/types/MessageContext.js

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

package/api/resources/send/types/MessageData.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type MessageData = Record<string, any>;

package/api/resources/send/types/MessageData.js

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

package/api/resources/send/types/MessageMetadata.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface MessageMetadata {
+    /** An arbitrary string to tracks the event that generated this request (e.g. 'signup'). */
+    event?: string;
+    /** 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?: string[];
+    /** Identify the campaign that refers traffic to a specific website, and attributes the browser's website session. */
+    utm?: Courier.Utm;
+    /** 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;
+}

package/api/resources/send/types/MessageMetadata.js

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

package/api/resources/send/types/MessageProviders.d.ts

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

package/api/resources/send/types/MessageProviders.js

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

package/api/resources/send/types/MessageProvidersType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface MessageProvidersType {
+    /** Provider specific overrides. */
+    override?: Record<string, any>;
+    /**
+     * 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;
+    timeouts?: number;
+    metadata?: Courier.Metadata;
+}

package/api/resources/send/types/MessageProvidersType.js

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

package/api/resources/send/types/MessageRecipient.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export declare type MessageRecipient = Courier.Recipient | Courier.Recipient[];

package/api/resources/send/types/MessageRecipient.js

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

package/api/resources/send/types/Metadata.d.ts

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

package/api/resources/send/types/Metadata.js

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

package/api/resources/send/types/Override.d.ts

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

package/api/resources/send/types/Override.js

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

package/api/resources/send/types/Preference.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface Preference {
+    status: Courier.PreferenceStatus;
+    rules?: Courier.Rule[];
+    channel_preferences?: Courier.ChannelPreference[];
+    source?: Courier.ChannelSource;
+}

package/api/resources/send/types/Preference.js

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

package/api/resources/send/types/Preferences.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Preferences {
+    templateIds: string[];
+}

package/api/resources/send/types/Preferences.js

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

package/api/resources/send/types/Recipient.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export declare type Recipient = Courier.AudienceRecipient | Courier.ListRecipient | Courier.ListPatternRecipient | Courier.UserRecipient;

package/api/resources/send/types/Recipient.js

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

package/api/resources/send/types/Routing.d.ts

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+/**
+ * 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.
+ *
+ */
+export interface Routing {
+    method: Courier.RoutingMethod;
+    /**
+     * 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: Courier.RoutingChannel[];
+}

package/api/resources/send/types/Routing.js

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

package/api/resources/send/types/RoutingChannel.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export declare type RoutingChannel = Courier.RoutingStrategyChannel | Courier.RoutingStrategyProvider | string;

package/api/resources/send/types/RoutingChannel.js

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

package/api/resources/send/types/RoutingMethod.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type RoutingMethod = "all" | "single";
+export declare const RoutingMethod: {
+    readonly All: "all";
+    readonly Single: "single";
+};

package/api/resources/send/types/RoutingMethod.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RoutingMethod = void 0;
+exports.RoutingMethod = {
+    All: "all",
+    Single: "single",
+};

package/api/resources/send/types/RoutingStrategyChannel.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface RoutingStrategyChannel {
+    channel: string;
+    config?: Record<string, any>;
+    method?: Courier.RoutingMethod;
+    providers?: Courier.MessageProviders;
+    if?: string;
+}

package/api/resources/send/types/RoutingStrategyChannel.js

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

package/api/resources/send/types/RoutingStrategyProvider.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface RoutingStrategyProvider {
+    name: string;
+    config?: Record<string, any>;
+    if?: string;
+    metadata: Courier.Metadata;
+}

package/api/resources/send/types/RoutingStrategyProvider.js

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

package/api/resources/send/types/RuleType.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type RuleType = "snooze" | "channel_preferences" | "status";
+export declare const RuleType: {
+    readonly Snooze: "snooze";
+    readonly ChannelPreferences: "channel_preferences";
+    readonly Status: "status";
+};

package/api/resources/send/types/RuleType.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RuleType = void 0;
+exports.RuleType = {
+    Snooze: "snooze",
+    ChannelPreferences: "channel_preferences",
+    Status: "status",
+};

package/api/resources/send/types/TemplateMessage.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface TemplateMessage extends Courier.BaseMessage {
+    /**
+     * 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;
+}

package/api/resources/send/types/TemplateMessage.js

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

package/api/resources/send/types/TextAlign.d.ts

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

package/api/resources/send/types/TextAlign.js

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

package/api/resources/send/types/TextStyle.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type TextStyle = "text" | "h1" | "h2" | "subtext";
+export declare const TextStyle: {
+    readonly Text: "text";
+    readonly H1: "h1";
+    readonly H2: "h2";
+    readonly Subtext: "subtext";
+};