@trycourier/courier 6.6.0 → 6.7.0-alpha2

package/api/resources/inbound/client/Client.js

@@ -1,145 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Inbound = void 0;
-const environments = __importStar(require("../../../../environments"));
-const core = __importStar(require("../../../../core"));
-const Courier = __importStar(require("../../../index"));
-const url_join_1 = __importDefault(require("url-join"));
-const errors = __importStar(require("../../../../errors/index"));
-class Inbound {
-    constructor(_options = {}) {
-        this._options = _options;
-    }
-    /**
-     * @param {Courier.InboundTrackEvent} request
-     * @param {Inbound.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Courier.BadRequestError}
-     * @throws {@link Courier.ConflictError}
-     *
-     * @example
-     *     await client.inbound.track({
-     *         event: "New Order Placed",
-     *         messageId: "4c62c457-b329-4bea-9bfc-17bba86c393f",
-     *         userId: "1234",
-     *         type: "track",
-     *         properties: {
-     *             "order_id": 123,
-     *             "total_orders": 5,
-     *             "last_order_id": 122
-     *         }
-     *     })
-     */
-    track(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__track(request, requestOptions));
-    }
-    __track(request, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c;
-            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CourierEnvironment.Production, "/inbound/courier"),
-                method: "POST",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@trycourier/courier", "X-Fern-SDK-Version": "6.6.0", "User-Agent": "@trycourier/courier/6.6.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
-                contentType: "application/json",
-                requestType: "json",
-                body: request,
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
-                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-            });
-            if (_response.ok) {
-                return { data: _response.body, rawResponse: _response.rawResponse };
-            }
-            if (_response.error.reason === "status-code") {
-                switch (_response.error.statusCode) {
-                    case 400:
-                        throw new Courier.BadRequestError(_response.error.body, _response.rawResponse);
-                    case 409:
-                        throw new Courier.ConflictError(_response.error.body, _response.rawResponse);
-                    default:
-                        throw new errors.CourierError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.body,
-                            rawResponse: _response.rawResponse,
-                        });
-                }
-            }
-            switch (_response.error.reason) {
-                case "non-json":
-                    throw new errors.CourierError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
-                        rawResponse: _response.rawResponse,
-                    });
-                case "timeout":
-                    throw new errors.CourierTimeoutError("Timeout exceeded when calling POST /inbound/courier.");
-                case "unknown":
-                    throw new errors.CourierError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
-        });
-    }
-    _getAuthorizationHeader() {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            const bearer = (_a = (yield core.Supplier.get(this._options.authorizationToken))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["COURIER_AUTH_TOKEN"];
-            if (bearer == null) {
-                throw new errors.CourierError({
-                    message: "Please specify a bearer by either passing it in to the constructor or initializing a COURIER_AUTH_TOKEN environment variable",
-                });
-            }
-            return `Bearer ${bearer}`;
-        });
-    }
-}
-exports.Inbound = Inbound;

package/api/resources/inbound/client/index.d.ts

@@ -1 +0,0 @@
-export {};

package/api/resources/inbound/client/index.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

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

package/api/resources/inbound/index.js

@@ -1,18 +0,0 @@
-"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/inbound/types/InboundTrackEvent.d.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface InboundTrackEvent {
-    /** A descriptive name of the event. This name will appear as a trigger in the Courier Automation Trigger node. */
-    event: string;
-    /** A required unique identifier that will be used to de-duplicate requests. If not unique, will respond with 409 Conflict status */
-    messageId: string;
-    properties: Record<string, any>;
-    type: "track";
-    /** The user id assocatiated with the track */
-    userId?: string;
-}

package/api/resources/inbound/types/InboundTrackEvent.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/api/resources/inbound/types/TrackAcceptedResponse.d.ts

@@ -1,7 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface TrackAcceptedResponse {
-    /** A successful call returns a `202` status code along with a `requestId` in the response body. */
-    messageId: string;
-}

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

@@ -1,2 +0,0 @@
-export * from "./InboundTrackEvent";
-export * from "./TrackAcceptedResponse";

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

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

package/api/resources/index.d.ts

@@ -1,44 +0,0 @@
-export * as audiences from "./audiences";
-export * from "./audiences/types";
-export * as auditEvents from "./auditEvents";
-export * from "./auditEvents/types";
-export * as authTokens from "./authTokens";
-export * from "./authTokens/types";
-export * as automations from "./automations";
-export * from "./automations/types";
-export * as brands from "./brands";
-export * from "./brands/types";
-export * as commons from "./commons";
-export * from "./commons/types";
-export * as bulk from "./bulk";
-export * from "./bulk/types";
-export * as inbound from "./inbound";
-export * from "./inbound/types";
-export * as lists from "./lists";
-export * from "./lists/types";
-export * as messages from "./messages";
-export * from "./messages/types";
-export * as notifications from "./notifications";
-export * from "./notifications/types";
-export * as profiles from "./profiles";
-export * from "./profiles/types";
-export * as send from "./send";
-export * from "./send/types";
-export * as templates from "./templates";
-export * from "./templates/types";
-export * as tenants from "./tenants";
-export * from "./tenants/types";
-export * as users from "./users";
-export * from "./commons/errors";
-export * as translations from "./translations";
-export * from "./audiences/client/requests";
-export * from "./auditEvents/client/requests";
-export * from "./authTokens/client/requests";
-export * from "./brands/client/requests";
-export * from "./bulk/client/requests";
-export * from "./lists/client/requests";
-export * from "./messages/client/requests";
-export * from "./notifications/client/requests";
-export * from "./profiles/client/requests";
-export * from "./templates/client/requests";
-export * from "./tenants/client/requests";

package/api/resources/index.js

@@ -1,83 +0,0 @@
-"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-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 });
-exports.translations = exports.users = exports.tenants = exports.templates = exports.send = exports.profiles = exports.notifications = exports.messages = exports.lists = exports.inbound = exports.bulk = exports.commons = exports.brands = exports.automations = exports.authTokens = exports.auditEvents = exports.audiences = void 0;
-exports.audiences = __importStar(require("./audiences"));
-__exportStar(require("./audiences/types"), exports);
-exports.auditEvents = __importStar(require("./auditEvents"));
-__exportStar(require("./auditEvents/types"), exports);
-exports.authTokens = __importStar(require("./authTokens"));
-__exportStar(require("./authTokens/types"), exports);
-exports.automations = __importStar(require("./automations"));
-__exportStar(require("./automations/types"), exports);
-exports.brands = __importStar(require("./brands"));
-__exportStar(require("./brands/types"), exports);
-exports.commons = __importStar(require("./commons"));
-__exportStar(require("./commons/types"), exports);
-exports.bulk = __importStar(require("./bulk"));
-__exportStar(require("./bulk/types"), exports);
-exports.inbound = __importStar(require("./inbound"));
-__exportStar(require("./inbound/types"), exports);
-exports.lists = __importStar(require("./lists"));
-__exportStar(require("./lists/types"), exports);
-exports.messages = __importStar(require("./messages"));
-__exportStar(require("./messages/types"), exports);
-exports.notifications = __importStar(require("./notifications"));
-__exportStar(require("./notifications/types"), exports);
-exports.profiles = __importStar(require("./profiles"));
-__exportStar(require("./profiles/types"), exports);
-exports.send = __importStar(require("./send"));
-__exportStar(require("./send/types"), exports);
-exports.templates = __importStar(require("./templates"));
-__exportStar(require("./templates/types"), exports);
-exports.tenants = __importStar(require("./tenants"));
-__exportStar(require("./tenants/types"), exports);
-exports.users = __importStar(require("./users"));
-__exportStar(require("./commons/errors"), exports);
-exports.translations = __importStar(require("./translations"));
-__exportStar(require("./audiences/client/requests"), exports);
-__exportStar(require("./auditEvents/client/requests"), exports);
-__exportStar(require("./authTokens/client/requests"), exports);
-__exportStar(require("./brands/client/requests"), exports);
-__exportStar(require("./bulk/client/requests"), exports);
-__exportStar(require("./lists/client/requests"), exports);
-__exportStar(require("./messages/client/requests"), exports);
-__exportStar(require("./notifications/client/requests"), exports);
-__exportStar(require("./profiles/client/requests"), exports);
-__exportStar(require("./templates/client/requests"), exports);
-__exportStar(require("./tenants/client/requests"), exports);

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

@@ -1,185 +0,0 @@
-/**
- * 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 "../../../index";
-export declare namespace Lists {
-    interface Options {
-        environment?: core.Supplier<environments.CourierEnvironment | string>;
-        /** Specify a custom URL to connect the client to. */
-        baseUrl?: core.Supplier<string>;
-        authorizationToken?: core.Supplier<core.BearerToken | undefined>;
-        fetcher?: core.FetchFunction;
-    }
-    interface RequestOptions {
-        /** The maximum time to wait for a response in seconds. */
-        timeoutInSeconds?: number;
-        /** The number of times to retry the request. Defaults to 2. */
-        maxRetries?: number;
-        /** A hook to abort the request. */
-        abortSignal?: AbortSignal;
-        /** Additional headers to include in the request. */
-        headers?: Record<string, string>;
-    }
-    interface IdempotentRequestOptions extends RequestOptions {
-        idempotencyKey?: string | undefined;
-        idempotencyExpiry?: string | undefined;
-    }
-}
-export declare class Lists {
-    protected readonly _options: Lists.Options;
-    constructor(_options?: Lists.Options);
-    /**
-     * Returns all of the lists, with the ability to filter based on a pattern.
-     *
-     * @param {Courier.GetAllListsRequest} request
-     * @param {Lists.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Courier.BadRequestError}
-     *
-     * @example
-     *     await client.lists.list()
-     */
-    list(request?: Courier.GetAllListsRequest, requestOptions?: Lists.RequestOptions): core.HttpResponsePromise<Courier.ListGetAllResponse>;
-    private __list;
-    /**
-     * Returns a list based on the list ID provided.
-     *
-     * @param {string} listId - A unique identifier representing the list you wish to retrieve.
-     * @param {Lists.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Courier.NotFoundError}
-     *
-     * @example
-     *     await client.lists.get("list_id")
-     */
-    get(listId: string, requestOptions?: Lists.RequestOptions): core.HttpResponsePromise<Courier.List>;
-    private __get;
-    /**
-     * Create or replace an existing list with the supplied values.
-     *
-     * @param {string} listId - A unique identifier representing the list you wish to retrieve.
-     * @param {Courier.ListPutParams} request
-     * @param {Lists.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.lists.update("list_id", {
-     *         name: "name",
-     *         preferences: undefined
-     *     })
-     */
-    update(listId: string, request: Courier.ListPutParams, requestOptions?: Lists.RequestOptions): core.HttpResponsePromise<void>;
-    private __update;
-    /**
-     * Delete a list by list ID.
-     *
-     * @param {string} listId - A unique identifier representing the list you wish to retrieve.
-     * @param {Lists.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.lists.delete("list_id")
-     */
-    delete(listId: string, requestOptions?: Lists.RequestOptions): core.HttpResponsePromise<void>;
-    private __delete;
-    /**
-     * Restore a previously deleted list.
-     *
-     * @param {string} listId - A unique identifier representing the list you wish to retrieve.
-     * @param {Courier.RestoreListRequest} request
-     * @param {Lists.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.lists.restore("list_id")
-     */
-    restore(listId: string, request?: Courier.RestoreListRequest, requestOptions?: Lists.RequestOptions): core.HttpResponsePromise<void>;
-    private __restore;
-    /**
-     * Get the list's subscriptions.
-     *
-     * @param {string} listId - A unique identifier representing the list you wish to retrieve.
-     * @param {Courier.GetSubscriptionForListRequest} request
-     * @param {Lists.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Courier.NotFoundError}
-     *
-     * @example
-     *     await client.lists.getSubscribers("list_id")
-     */
-    getSubscribers(listId: string, request?: Courier.GetSubscriptionForListRequest, requestOptions?: Lists.RequestOptions): core.HttpResponsePromise<Courier.ListGetSubscriptionsResponse>;
-    private __getSubscribers;
-    /**
-     * Subscribes the users to the list, overwriting existing subscriptions. If the list does not exist, it will be automatically created.
-     *
-     * @param {string} listId - A unique identifier representing the list you wish to retrieve.
-     * @param {Courier.SubscribeUsersToListRequest} request
-     * @param {Lists.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Courier.BadRequestError}
-     *
-     * @example
-     *     await client.lists.updateSubscribers("list_id", {
-     *         recipients: [{
-     *                 recipientId: "recipientId",
-     *                 preferences: undefined
-     *             }, {
-     *                 recipientId: "recipientId",
-     *                 preferences: undefined
-     *             }]
-     *     })
-     */
-    updateSubscribers(listId: string, request: Courier.SubscribeUsersToListRequest, requestOptions?: Lists.RequestOptions): core.HttpResponsePromise<void>;
-    private __updateSubscribers;
-    /**
-     * Subscribes additional users to the list, without modifying existing subscriptions. If the list does not exist, it will be automatically created.
-     *
-     * @param {string} listId - A unique identifier representing the list you wish to retrieve.
-     * @param {Courier.AddSubscribersToList} request
-     * @param {Lists.IdempotentRequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Courier.BadRequestError}
-     *
-     * @example
-     *     await client.lists.addSubscribers("list_id", {
-     *         recipients: [{
-     *                 recipientId: "recipientId",
-     *                 preferences: undefined
-     *             }, {
-     *                 recipientId: "recipientId",
-     *                 preferences: undefined
-     *             }]
-     *     })
-     */
-    addSubscribers(listId: string, request: Courier.AddSubscribersToList, requestOptions?: Lists.IdempotentRequestOptions): core.HttpResponsePromise<void>;
-    private __addSubscribers;
-    /**
-     * Subscribe a user to an existing list (note: if the List does not exist, it will be automatically created).
-     *
-     * @param {string} listId - A unique identifier representing the list you wish to retrieve.
-     * @param {string} userId - A unique identifier representing the recipient associated with the list
-     * @param {Courier.SubscribeUserToListRequest} request
-     * @param {Lists.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.lists.subscribe("list_id", "user_id", {
-     *         preferences: undefined
-     *     })
-     */
-    subscribe(listId: string, userId: string, request?: Courier.SubscribeUserToListRequest, requestOptions?: Lists.RequestOptions): core.HttpResponsePromise<void>;
-    private __subscribe;
-    /**
-     * Delete a subscription to a list by list ID and user ID.
-     *
-     * @param {string} listId - A unique identifier representing the list you wish to retrieve.
-     * @param {string} userId - A unique identifier representing the recipient associated with the list
-     * @param {Lists.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Courier.NotFoundError}
-     *
-     * @example
-     *     await client.lists.unsubscribe("list_id", "user_id")
-     */
-    unsubscribe(listId: string, userId: string, requestOptions?: Lists.RequestOptions): core.HttpResponsePromise<void>;
-    private __unsubscribe;
-    protected _getAuthorizationHeader(): Promise<string>;
-}