@trycourier/courier 5.7.0 → 6.0.0

package/api/resources/commons/types/ChannelPreference.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/commons/types/Conflict.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface Conflict extends Courier.BaseError {
+    type: "invalid_request_error";
+}

package/api/resources/commons/types/Conflict.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/commons/types/Email.d.ts

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

package/api/resources/commons/types/Email.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/commons/types/MessageNotFound.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface MessageNotFound extends Courier.BaseError {
+    type: "invalid_request_error";
+}

package/api/resources/commons/types/MessageNotFound.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/commons/types/NotFound.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface NotFound extends Courier.BaseError {
+    type: "invalid_request_error";
+}

package/api/resources/commons/types/NotFound.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/commons/types/NotificationPreferenceDetails.d.ts

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

package/api/resources/commons/types/NotificationPreferenceDetails.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/commons/types/NotificationPreferences.d.ts

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

package/api/resources/commons/types/NotificationPreferences.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/commons/types/Paging.d.ts

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

package/api/resources/commons/types/Paging.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/commons/types/PaymentRequired.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface PaymentRequired extends Courier.BaseError {
+    type: "authorization_error";
+}

package/api/resources/commons/types/PaymentRequired.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/commons/types/PreferenceStatus.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type PreferenceStatus = "OPTED_IN" | "OPTED_OUT" | "REQUIRED";
+export declare const PreferenceStatus: {
+    readonly OptedIn: "OPTED_IN";
+    readonly OptedOut: "OPTED_OUT";
+    readonly Required: "REQUIRED";
+};

package/api/resources/commons/types/PreferenceStatus.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.PreferenceStatus = void 0;
+exports.PreferenceStatus = {
+    OptedIn: "OPTED_IN",
+    OptedOut: "OPTED_OUT",
+    Required: "REQUIRED",
+};

package/api/resources/commons/types/RecipientPreferences.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+export interface RecipientPreferences {
+    categories?: Courier.NotificationPreferences;
+    notifications?: Courier.NotificationPreferences;
+}

package/api/resources/commons/types/RecipientPreferences.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/commons/types/Rule.d.ts

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

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

@@ -0,0 +1,16 @@
+export * from "./Paging";
+export * from "./BaseError";
+export * from "./BadRequest";
+export * from "./PaymentRequired";
+export * from "./AlreadyExists";
+export * from "./Conflict";
+export * from "./NotFound";
+export * from "./MessageNotFound";
+export * from "./Rule";
+export * from "./PreferenceStatus";
+export * from "./ChannelClassification";
+export * from "./ChannelPreference";
+export * from "./NotificationPreferences";
+export * from "./NotificationPreferenceDetails";
+export * from "./RecipientPreferences";
+export * from "./Email";

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

@@ -0,0 +1,32 @@
+"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("./Paging"), exports);
+__exportStar(require("./BaseError"), exports);
+__exportStar(require("./BadRequest"), exports);
+__exportStar(require("./PaymentRequired"), exports);
+__exportStar(require("./AlreadyExists"), exports);
+__exportStar(require("./Conflict"), exports);
+__exportStar(require("./NotFound"), exports);
+__exportStar(require("./MessageNotFound"), exports);
+__exportStar(require("./Rule"), exports);
+__exportStar(require("./PreferenceStatus"), exports);
+__exportStar(require("./ChannelClassification"), exports);
+__exportStar(require("./ChannelPreference"), exports);
+__exportStar(require("./NotificationPreferences"), exports);
+__exportStar(require("./NotificationPreferenceDetails"), exports);
+__exportStar(require("./RecipientPreferences"), exports);
+__exportStar(require("./Email"), exports);

package/api/resources/index.d.ts

@@ -0,0 +1,39 @@
+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 lists from "./lists";
+export * from "./lists/types";
+export * as messages from "./messages";
+export * from "./messages/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 tokenManagement from "./tokenManagement";
+export * from "./tokenManagement/types";
+export * as userPreferences from "./userPreferences";
+export * from "./userPreferences/types";
+export * from "./commons/errors";
+export * as translations from "./translations";
+export * from "./audiences/client/requests";
+export * from "./auditEvents/client/requests";
+export * from "./brands/client/requests";
+export * from "./lists/client/requests";
+export * from "./messages/client/requests";
+export * from "./profiles/client/requests";
+export * from "./templates/client/requests";

package/api/resources/index.js

@@ -0,0 +1,68 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __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.userPreferences = exports.tokenManagement = exports.tenants = exports.templates = exports.send = exports.profiles = exports.messages = exports.lists = 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.lists = __importStar(require("./lists"));
+__exportStar(require("./lists/types"), exports);
+exports.messages = __importStar(require("./messages"));
+__exportStar(require("./messages/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.tokenManagement = __importStar(require("./tokenManagement"));
+__exportStar(require("./tokenManagement/types"), exports);
+exports.userPreferences = __importStar(require("./userPreferences"));
+__exportStar(require("./userPreferences/types"), exports);
+__exportStar(require("./commons/errors"), exports);
+exports.translations = __importStar(require("./translations"));
+__exportStar(require("./audiences/client/requests"), exports);
+__exportStar(require("./auditEvents/client/requests"), exports);
+__exportStar(require("./brands/client/requests"), exports);
+__exportStar(require("./lists/client/requests"), exports);
+__exportStar(require("./messages/client/requests"), exports);
+__exportStar(require("./profiles/client/requests"), exports);
+__exportStar(require("./templates/client/requests"), exports);

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

@@ -0,0 +1,63 @@
+/**
+ * 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 Lists {
+    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 Lists {
+    protected readonly _options: Lists.Options;
+    constructor(_options: Lists.Options);
+    /**
+     * Returns all of the lists, with the ability to filter based on a pattern.
+     * @throws {@link Courier.BadRequestError}
+     */
+    list(request?: Courier.GetAllListsRequest, requestOptions?: Lists.RequestOptions): Promise<Courier.ListGetAllResponse>;
+    /**
+     * Returns a list based on the list ID provided.
+     * @throws {@link Courier.NotFoundError}
+     */
+    get(listId: string, request?: Courier.GetListRequest, requestOptions?: Lists.RequestOptions): Promise<Courier.List>;
+    /**
+     * Create or replace an existing list with the supplied values.
+     */
+    update(listId: string, request: Courier.ListPutParams, requestOptions?: Lists.RequestOptions): Promise<Courier.List>;
+    /**
+     * Get the list's subscriptions.
+     * @throws {@link Courier.NotFoundError}
+     */
+    getSubscriptions(listId: string, request?: Courier.GetSubscriptionForListRequest, requestOptions?: Lists.RequestOptions): Promise<Courier.ListGetSubscriptionsResponse>;
+    /**
+     * Subscribes the users to the list, overwriting existing subscriptions. If the list does not exist, it will be automatically created.
+     * @throws {@link Courier.BadRequestError}
+     */
+    putSubscriptions(listId: string, request: Courier.PutSubscriptionsRecipient[], requestOptions?: Lists.RequestOptions): Promise<void>;
+    /**
+     * Subscribes additional users to the list, without modifying existing subscriptions. If the list does not exist, it will be automatically created.
+     * @throws {@link Courier.BadRequestError}
+     */
+    postSubscriptions(listId: string, request: Courier.PutSubscriptionsRecipient[], requestOptions?: Lists.IdempotentRequestOptions): Promise<void>;
+    /**
+     * Subscribe a user to an existing list (note: if the List does not exist, it will be automatically created).
+     */
+    subscribe(listId: string, userId: string, request: Courier.SubscribeUserToListRequest, requestOptions?: Lists.RequestOptions): Promise<void>;
+    /**
+     * Delete a subscription to a list by list ID and user ID.
+     * @throws {@link Courier.NotFoundError}
+     */
+    unsubscribe(listId: string, userId: string, requestOptions?: Lists.RequestOptions): Promise<void>;
+    protected _getAuthorizationHeader(): Promise<string>;
+}