@trycourier/courier 5.6.0 → 6.0.0

package/api/resources/messages/client/requests/ListMessagesRequest.d.ts

@@ -0,0 +1,49 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ListMessagesRequest {
+    /**
+     * A boolean value that indicates whether archived messages should be included in the response.
+     */
+    archived?: boolean;
+    /**
+     * A unique identifier that allows for fetching the next set of message statuses.
+     */
+    cursor?: string;
+    /**
+     * A unique identifier representing the event that was used to send the event.
+     */
+    event?: string;
+    /**
+     * A unique identifier representing the list the message was sent to.
+     */
+    list?: string;
+    /**
+     * A unique identifier representing the message_id returned from either /send or /send/list.
+     */
+    messageId?: string;
+    /**
+     * A unique identifier representing the notification that was used to send the event.
+     */
+    notification?: string;
+    /**
+     * A unique identifier representing the recipient associated with the requested profile.
+     */
+    recipient?: string;
+    /**
+     * An indicator of the current status of the message. Multiple status values can be passed in.
+     */
+    status?: string;
+    /**
+     * A comma delimited list of 'tags'. Messages will be returned if they match any of the tags passed in.
+     */
+    tags?: string;
+    /**
+     * The enqueued datetime of a message to filter out messages received before.
+     */
+    enqueuedAfter?: string;
+    /**
+     * The unique identifier used to trace the requests
+     */
+    traceId?: string;
+}

package/api/resources/messages/client/requests/ListMessagesRequest.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/messages/client/requests/index.d.ts

@@ -0,0 +1,2 @@
+export { ListMessagesRequest } from "./ListMessagesRequest";
+export { GetMessageHistoryRequest } from "./GetMessageHistoryRequest";

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

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

package/api/resources/messages/index.js

@@ -0,0 +1,18 @@
+"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);
+__exportStar(require("./client"), exports);

package/api/resources/messages/types/ListMessagesResponse.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface ListMessagesResponse {
+    /** Paging information for the result set. */
+    paging: Courier.Paging;
+    /** An array of messages with their details. */
+    results: Courier.MessageDetails[];
+}

package/api/resources/messages/types/ListMessagesResponse.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/messages/types/MessageDetails.d.ts

@@ -0,0 +1,30 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface MessageDetails {
+    /** A unique identifier associated with the message you wish to retrieve (results from a send). */
+    id: string;
+    /** The current status of the message. */
+    status: Courier.MessageStatus;
+    /** A UTC timestamp at which Courier received the message request. Stored as a millisecond representation of the Unix epoch. */
+    enqueued: number;
+    /** A UTC timestamp at which Courier passed the message to the Integration provider. Stored as a millisecond representation of the Unix epoch. */
+    sent: number;
+    /** A UTC timestamp at which the Integration provider delivered the message. Stored as a millisecond representation of the Unix epoch. */
+    delivered: number;
+    /** A UTC timestamp at which the recipient opened a message for the first time. Stored as a millisecond representation of the Unix epoch. */
+    opened: number;
+    /** A UTC timestamp at which the recipient clicked on a tracked link for the first time. Stored as a millisecond representation of the Unix epoch. */
+    clicked: number;
+    /** A unique identifier associated with the recipient of the delivered message. */
+    recipient: string;
+    /** A unique identifier associated with the event of the delivered message. */
+    event: string;
+    /** A unique identifier associated with the notification of the delivered message. */
+    notification: string;
+    /** A message describing the error that occurred. */
+    error?: string;
+    /** The reason for the current status of the message. */
+    reason?: Courier.Reason;
+}

package/api/resources/messages/types/MessageDetails.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/messages/types/MessageHistoryResponse.d.ts

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

package/api/resources/messages/types/MessageHistoryResponse.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/messages/types/MessageStatus.d.ts

@@ -0,0 +1,42 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type MessageStatus = 
+/**
+ * The recipient has clicked on any link in the message at least one time. */
+"CLICKED"
+/**
+ * The provider successfully delivered the message to the recipient. */
+ | "DELIVERED"
+/**
+ * The request has been received to send a message, is waiting in the work queue. */
+ | "ENQUEUED"
+/**
+ * The recipient has opened the message at least one time. */
+ | "OPENED"
+/**
+ * The message has been canceled such that it will not be delivered. */
+ | "CANCELED"
+/**
+ * The message has been accepted by the provider. */
+ | "SENT"
+/**
+ * The message could not be delivered to at least one provider, or the provider could not deliver the message to the recipient. This can happen for multiple reasons: an error, insufficient profile data, invalid notification setup, invalid integration configuration, etc. */
+ | "UNDELIVERABLE"
+/**
+ * Could not find a corresponding notification or event for the messages. */
+ | "UNMAPPED"
+/**
+ * The message could not be routed to any channel or provider. This can happen for multiple reasons: insufficient profile data, invalid notification setup, invalid integration configuration, etc. */
+ | "UNROUTABLE";
+export declare const MessageStatus: {
+    readonly Clicked: "CLICKED";
+    readonly Delivered: "DELIVERED";
+    readonly Enqueued: "ENQUEUED";
+    readonly Opened: "OPENED";
+    readonly Canceled: "CANCELED";
+    readonly Sent: "SENT";
+    readonly Undeliverable: "UNDELIVERABLE";
+    readonly Unmapped: "UNMAPPED";
+    readonly Unroutable: "UNROUTABLE";
+};

package/api/resources/messages/types/MessageStatus.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessageStatus = void 0;
+exports.MessageStatus = {
+    Clicked: "CLICKED",
+    Delivered: "DELIVERED",
+    Enqueued: "ENQUEUED",
+    Opened: "OPENED",
+    Canceled: "CANCELED",
+    Sent: "SENT",
+    Undeliverable: "UNDELIVERABLE",
+    Unmapped: "UNMAPPED",
+    Unroutable: "UNROUTABLE",
+};

package/api/resources/messages/types/Reason.d.ts

@@ -0,0 +1,30 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type Reason = 
+/**
+ * The recipient did not receive the notification because of a condition that passed. */
+"FILTERED"
+/**
+ * The notification did not contain any valid channels. */
+ | "NO_CHANNELS"
+/**
+ * The notification did not contain a configured provider for a channel. */
+ | "NO_PROVIDERS"
+/**
+ * The Integration provider had an error when sending a notification. */
+ | "PROVIDER_ERROR"
+/**
+ * The notification hasn't been published yet. */
+ | "UNPUBLISHED"
+/**
+ * The recipient did not receive the notification because they chose to unsubscribe from it. */
+ | "UNSUBSCRIBED";
+export declare const Reason: {
+    readonly Filtered: "FILTERED";
+    readonly NoChannels: "NO_CHANNELS";
+    readonly NoProviders: "NO_PROVIDERS";
+    readonly ProviderError: "PROVIDER_ERROR";
+    readonly Unpublished: "UNPUBLISHED";
+    readonly Unsubscribed: "UNSUBSCRIBED";
+};

package/api/resources/messages/types/Reason.js

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Reason = void 0;
+exports.Reason = {
+    Filtered: "FILTERED",
+    NoChannels: "NO_CHANNELS",
+    NoProviders: "NO_PROVIDERS",
+    ProviderError: "PROVIDER_ERROR",
+    Unpublished: "UNPUBLISHED",
+    Unsubscribed: "UNSUBSCRIBED",
+};

package/api/resources/messages/types/RenderOutput.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface RenderOutput {
+    /** The channel used for rendering the message. */
+    channel: string;
+    /** The ID of channel used for rendering the message. */
+    channel_id: string;
+    /** Content details of the rendered message. */
+    content: Courier.RenderedMessageContent;
+}

package/api/resources/messages/types/RenderOutput.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/messages/types/RenderOutputResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface RenderOutputResponse {
+    /** An array of render output of a previously sent message. */
+    results: Courier.RenderOutput[];
+}

package/api/resources/messages/types/RenderOutputResponse.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/messages/types/RenderedMessageBlock.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface RenderedMessageBlock {
+    /** The block type of the rendered message block. */
+    type: string;
+    /** The block text of the rendered message block. */
+    text: string;
+}

package/api/resources/messages/types/RenderedMessageBlock.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/messages/types/RenderedMessageContent.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface RenderedMessageContent {
+    /** The html content of the rendered message. */
+    html: string;
+    /** The title of the rendered message. */
+    title: string;
+    /** The body of the rendered message. */
+    body: string;
+    /** The subject of the rendered message. */
+    subject: string;
+    /** The text of the rendered message. */
+    text: string;
+    /** The blocks of the rendered message. */
+    blocks: Courier.RenderedMessageBlock[];
+}

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

@@ -0,0 +1,9 @@
+export * from "./MessageStatus";
+export * from "./MessageDetails";
+export * from "./Reason";
+export * from "./ListMessagesResponse";
+export * from "./MessageHistoryResponse";
+export * from "./RenderOutputResponse";
+export * from "./RenderedMessageBlock";
+export * from "./RenderedMessageContent";
+export * from "./RenderOutput";

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

@@ -0,0 +1,25 @@
+"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("./MessageStatus"), exports);
+__exportStar(require("./MessageDetails"), exports);
+__exportStar(require("./Reason"), exports);
+__exportStar(require("./ListMessagesResponse"), exports);
+__exportStar(require("./MessageHistoryResponse"), exports);
+__exportStar(require("./RenderOutputResponse"), exports);
+__exportStar(require("./RenderedMessageBlock"), exports);
+__exportStar(require("./RenderedMessageContent"), exports);
+__exportStar(require("./RenderOutput"), exports);

package/api/resources/profiles/client/Client.d.ts

@@ -0,0 +1,64 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as Courier from "../../..";
+export declare namespace Profiles {
+    interface Options {
+        environment?: core.Supplier<environments.CourierEnvironment | string>;
+        authorizationToken: core.Supplier<core.BearerToken | undefined>;
+    }
+    interface RequestOptions {
+        timeoutInSeconds?: number;
+        maxRetries?: number;
+    }
+    interface IdempotentRequestOptions extends RequestOptions {
+        idempotencyKey?: string | undefined;
+        idempotencyExpiry?: number | undefined;
+    }
+}
+export declare class Profiles {
+    protected readonly _options: Profiles.Options;
+    constructor(_options: Profiles.Options);
+    /**
+     * Returns the specified user profile.
+     * @throws {@link Courier.BadRequestError}
+     */
+    get(userId: string, requestOptions?: Profiles.RequestOptions): Promise<Courier.ProfileGetResponse>;
+    /**
+     * Merge the supplied values with an existing profile or create a new profile if one doesn't already exist.
+     * @throws {@link Courier.BadRequestError}
+     */
+    merge(userId: string, request: Courier.MergeProfileRequest, requestOptions?: Profiles.IdempotentRequestOptions): Promise<Courier.MergeProfileResponse>;
+    /**
+     * When using `PUT`, be sure to include all the key-value pairs required by the recipient's profile.
+     * Any key-value pairs that exist in the profile but fail to be included in the `PUT` request will be
+     * removed from the profile. Remember, a `PUT` update is a full replacement of the data. For partial updates,
+     * use the [Patch](https://www.courier.com/docs/reference/profiles/patch/) request.
+     *
+     * @throws {@link Courier.BadRequestError}
+     */
+    replace(userId: string, request: Courier.ReplaceProfileRequest, requestOptions?: Profiles.RequestOptions): Promise<Courier.ReplaceProfileResponse>;
+    /**
+     * Deletes the specified user profile.
+     * @throws {@link Courier.BadRequestError}
+     */
+    delete(userId: string, requestOptions?: Profiles.RequestOptions): Promise<void>;
+    /**
+     * Returns the subscribed lists for a specified user.
+     * @throws {@link Courier.BadRequestError}
+     */
+    getListSubscriptions(userId: string, request?: Courier.GetListSubscriptionsRequest, requestOptions?: Profiles.RequestOptions): Promise<void>;
+    /**
+     * Subscribes the given user to one or more lists. If the list does not exist, it will be created.
+     * @throws {@link Courier.BadRequestError}
+     */
+    subscribeToLists(userId: string, request: Courier.SubscribeToListsRequest, requestOptions?: Profiles.IdempotentRequestOptions): Promise<Courier.SubscribeToListsResponse>;
+    /**
+     * Removes all list subscriptions for given user.
+     * @throws {@link Courier.BadRequestError}
+     */
+    deleteListSubscription(userId: string, requestOptions?: Profiles.RequestOptions): Promise<Courier.DeleteListSubscriptionResponse>;
+    protected _getAuthorizationHeader(): Promise<string>;
+}