@trycourier/courier 5.7.0 → 6.0.1

package/api/resources/profiles/types/IntercomeRecipient.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/profiles/types/MergeProfileResponse.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface MergeProfileResponse {
+    status: "SUCCESS";
+}

package/api/resources/profiles/types/MergeProfileResponse.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/profiles/types/MsTeams.d.ts

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

package/api/resources/profiles/types/MsTeams.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/profiles/types/MultipleTokens.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface MultipleTokens {
+    tokens: Courier.Token[];
+}

package/api/resources/profiles/types/MultipleTokens.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/profiles/types/ProfileGetParameters.d.ts

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

package/api/resources/profiles/types/ProfileGetParameters.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/profiles/types/ProfileGetResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface ProfileGetResponse {
+    profile: Record<string, any>;
+    preferences?: Courier.RecipientPreferences;
+}

package/api/resources/profiles/types/ProfileGetResponse.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/profiles/types/ReplaceProfileResponse.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ReplaceProfileResponse {
+    status: "SUCCESS";
+}

package/api/resources/profiles/types/ReplaceProfileResponse.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/profiles/types/SendDirectMessage.d.ts

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

package/api/resources/profiles/types/SendDirectMessage.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/profiles/types/SendToChannel.d.ts

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

package/api/resources/profiles/types/SendToChannel.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/profiles/types/SendToMsTeamsChannel.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface SendToMsTeamsChannel {
+    conversation_id: string;
+    tenant_id: string;
+    service_url: string;
+}

package/api/resources/profiles/types/SendToMsTeamsChannel.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/profiles/types/SendToMsTeamsUser.d.ts

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

package/api/resources/profiles/types/SendToMsTeamsUser.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/profiles/types/SnoozeRule.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface SnoozeRule {
+    type: Courier.SnoozeRuleType;
+    start: string;
+    until: string;
+}

package/api/resources/profiles/types/SnoozeRule.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/profiles/types/SnoozeRuleType.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type SnoozeRuleType = "snooze";
+export declare const SnoozeRuleType: {
+    readonly Snooze: "snooze";
+};

package/api/resources/profiles/types/SnoozeRuleType.js

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

package/api/resources/profiles/types/SubscribeToListsRequest.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface SubscribeToListsRequest {
+    lists?: Courier.List[];
+    preferences?: Courier.RecipientPreferences;
+}

package/api/resources/profiles/types/SubscribeToListsRequest.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/profiles/types/SubscribeToListsResponse.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface SubscribeToListsResponse {
+    status: "SUCCESS";
+}

package/api/resources/profiles/types/SubscribeToListsResponse.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/profiles/types/Token.d.ts

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

package/api/resources/profiles/types/Token.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/profiles/types/UserProfile.d.ts

@@ -0,0 +1,37 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface UserProfile {
+    address: Courier.Address;
+    birthdate: string;
+    email: string;
+    email_verified: boolean;
+    family_name: string;
+    gender: string;
+    given_name: string;
+    locale: string;
+    middle_name: string;
+    name: string;
+    nickname: string;
+    phone_number: string;
+    phone_number_verified: boolean;
+    picture: string;
+    preferred_name: string;
+    profile: string;
+    sub: string;
+    updated_at: string;
+    website: string;
+    zoneinfo: string;
+    /** A free form object. Due to a limitation of the API Explorer, you can only enter string key/values below, but this API accepts more complex object structures. */
+    custom?: any;
+    airship: Courier.AirshipProfile;
+    apn: string;
+    target_arn: string;
+    discord: Courier.Discord;
+    expo: Courier.Expo;
+    facebookPSID: string;
+    firebaseToken: string;
+    intercom: Courier.Intercom;
+    ms_teams: Courier.MsTeams;
+}

package/api/resources/profiles/types/UserProfile.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/profiles/types/index.d.ts

@@ -0,0 +1,25 @@
+export * from "./Address";
+export * from "./UserProfile";
+export * from "./AirshipProfile";
+export * from "./AirshipProfileAudience";
+export * from "./DeviceType";
+export * from "./SnoozeRuleType";
+export * from "./SnoozeRule";
+export * from "./Discord";
+export * from "./SendToChannel";
+export * from "./SendDirectMessage";
+export * from "./Expo";
+export * from "./Token";
+export * from "./MultipleTokens";
+export * from "./Intercom";
+export * from "./IntercomeRecipient";
+export * from "./MsTeams";
+export * from "./SendToMsTeamsUser";
+export * from "./SendToMsTeamsChannel";
+export * from "./ProfileGetParameters";
+export * from "./ProfileGetResponse";
+export * from "./MergeProfileResponse";
+export * from "./ReplaceProfileResponse";
+export * from "./SubscribeToListsRequest";
+export * from "./SubscribeToListsResponse";
+export * from "./DeleteListSubscriptionResponse";

package/api/resources/profiles/types/index.js

@@ -0,0 +1,41 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Address"), exports);
+__exportStar(require("./UserProfile"), exports);
+__exportStar(require("./AirshipProfile"), exports);
+__exportStar(require("./AirshipProfileAudience"), exports);
+__exportStar(require("./DeviceType"), exports);
+__exportStar(require("./SnoozeRuleType"), exports);
+__exportStar(require("./SnoozeRule"), exports);
+__exportStar(require("./Discord"), exports);
+__exportStar(require("./SendToChannel"), exports);
+__exportStar(require("./SendDirectMessage"), exports);
+__exportStar(require("./Expo"), exports);
+__exportStar(require("./Token"), exports);
+__exportStar(require("./MultipleTokens"), exports);
+__exportStar(require("./Intercom"), exports);
+__exportStar(require("./IntercomeRecipient"), exports);
+__exportStar(require("./MsTeams"), exports);
+__exportStar(require("./SendToMsTeamsUser"), exports);
+__exportStar(require("./SendToMsTeamsChannel"), exports);
+__exportStar(require("./ProfileGetParameters"), exports);
+__exportStar(require("./ProfileGetResponse"), exports);
+__exportStar(require("./MergeProfileResponse"), exports);
+__exportStar(require("./ReplaceProfileResponse"), exports);
+__exportStar(require("./SubscribeToListsRequest"), exports);
+__exportStar(require("./SubscribeToListsResponse"), exports);
+__exportStar(require("./DeleteListSubscriptionResponse"), exports);

package/api/resources/send/index.d.ts

@@ -0,0 +1 @@
+export * from "./types";

package/api/resources/send/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);

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

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

package/api/resources/send/types/Attachment.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/AudienceFilter.d.ts

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

package/api/resources/send/types/AudienceFilter.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/AudienceRecipient.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface AudienceRecipient {
+    /** A unique identifier associated with an Audience. A message will be sent to each user in the audience. */
+    audience_id: string;
+    data?: Courier.MessageData;
+    filters?: Courier.AudienceFilter[];
+}

package/api/resources/send/types/AudienceRecipient.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/BaseMessage.d.ts

@@ -0,0 +1,37 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface BaseMessage {
+    /** The recipient or a list of recipients of the message */
+    to: Courier.MessageRecipient;
+    /**
+     * 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?: Courier.MessageData;
+    brand_id?: string;
+    /**
+     * "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?: Courier.MessageChannels;
+    /** Context to load with this recipient. Will override any context set on message.context. */
+    context?: Courier.MessageContext;
+    /** Metadata such as utm tracking attached with the notification through this channel. */
+    metadata?: Courier.MessageMetadata;
+    /** An object whose keys are valid provider identifiers which map to an object. */
+    providers?: Courier.MessageProviders;
+    routing?: Courier.Routing;
+    /** Time in ms to attempt the channel before failing over to the next available channel. */
+    timeout?: Courier.Timeout;
+    /** Defines the time to wait before delivering the message. */
+    delay?: Courier.Delay;
+    /**
+     * "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?: Courier.Expiry;
+}

package/api/resources/send/types/BaseMessage.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/BaseSocialPresence.d.ts

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

package/api/resources/send/types/BaseSocialPresence.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/BrandSettingsEmail.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface BrandSettingsEmail {
+    templateOverride?: Courier.BrandTemplateOverride;
+    head?: Courier.EmailHead;
+    footer?: Courier.EmailFooter;
+    header?: Courier.EmailHeader;
+}

package/api/resources/send/types/BrandSettingsEmail.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/BrandSettingsInApp.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface BrandSettingsInApp {
+    borderRadius?: string;
+    disableMessageIcon?: boolean;
+    fontFamily?: string;
+    placement?: Courier.InAppPlacement;
+    widgetBackground: Courier.WidgetBackground;
+    colors: Courier.BrandColors;
+    icons: Courier.Icons;
+    preferences: Courier.Preferences;
+}

package/api/resources/send/types/BrandSettingsInApp.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/BrandSettingsSocialPresence.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface BrandSettingsSocialPresence {
+    inheritDefault?: boolean;
+    facebook?: Courier.BaseSocialPresence;
+    instagram?: Courier.BaseSocialPresence;
+    linkedin?: Courier.BaseSocialPresence;
+    medium?: Courier.BaseSocialPresence;
+    twitter?: Courier.BaseSocialPresence;
+}

package/api/resources/send/types/BrandSettingsSocialPresence.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/BrandTemplate.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface BrandTemplate {
+    backgroundColor?: string;
+    blocksBackgroundColor?: string;
+    enabled: boolean;
+    footer?: string;
+    head?: string;
+    header?: string;
+    width?: string;
+}

package/api/resources/send/types/BrandTemplate.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/BrandTemplateOverride.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface BrandTemplateOverride extends Courier.BrandTemplate {
+    mjml: Courier.BrandTemplate;
+    footerBackgroundColor?: string;
+    footerFullWidth?: boolean;
+}

package/api/resources/send/types/BrandTemplateOverride.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/Channel.d.ts

@@ -0,0 +1,36 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface Channel {
+    /**
+     * 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;
+    /**
+     * A list of providers enabled for this channel. Courier will select
+     * one provider to send through unless routing_method is set to all.
+     *
+     */
+    providers?: string[];
+    /**
+     * 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?: Courier.RoutingMethod;
+    /**
+     * 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?: Courier.Timeouts;
+    /** Channel specific overrides. */
+    override?: Courier.Override;
+    metadata?: Courier.ChannelMetadata;
+}

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

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