@trycourier/courier 6.0.1 → 6.0.3

package/dist/api/resources/index.js

@@ -26,7 +26,7 @@ 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.translations = exports.users = exports.tenants = exports.templates = exports.send = exports.profiles = exports.notifications = 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"));
@@ -45,6 +45,8 @@ 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"));
@@ -53,16 +55,17 @@ 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);
+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/dist/api/resources/lists/client/Client.d.ts

@@ -7,7 +7,7 @@ import * as Courier from "../../..";
 export declare namespace Lists {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
-        authorizationToken: core.Supplier<core.BearerToken | undefined>;
+        authorizationToken?: core.Supplier<core.BearerToken | undefined>;
     }
     interface RequestOptions {
         timeoutInSeconds?: number;
@@ -20,7 +20,7 @@ export declare namespace Lists {
 }
 export declare class Lists {
     protected readonly _options: Lists.Options;
-    constructor(_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}
@@ -35,25 +35,33 @@ export declare class Lists {
      * Create or replace an existing list with the supplied values.
      */
     update(listId: string, request: Courier.ListPutParams, requestOptions?: Lists.RequestOptions): Promise<Courier.List>;
+    /**
+     * Delete a list by list ID.
+     */
+    delete(listId: string, requestOptions?: Lists.RequestOptions): Promise<void>;
+    /**
+     * Restore a previously deleted list.
+     */
+    restore(listId: string, requestOptions?: Lists.RequestOptions): Promise<void>;
     /**
      * Get the list's subscriptions.
      * @throws {@link Courier.NotFoundError}
      */
-    getSubscriptions(listId: string, request?: Courier.GetSubscriptionForListRequest, requestOptions?: Lists.RequestOptions): Promise<Courier.ListGetSubscriptionsResponse>;
+    getSubscribers(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>;
+    updateSubscribers(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>;
+    addSubscribers(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>;
+    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}

package/dist/api/resources/lists/client/Client.js

@@ -45,7 +45,7 @@ const Courier = __importStar(require("../../.."));
 const url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("../../../../errors"));
 class Lists {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -70,7 +70,7 @@ class Lists {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "6.0.1",
+                    "X-Fern-SDK-Version": "v6.0.3",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -128,7 +128,7 @@ class Lists {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "6.0.1",
+                    "X-Fern-SDK-Version": "v6.0.3",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -177,7 +177,7 @@ class Lists {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "6.0.1",
+                    "X-Fern-SDK-Version": "v6.0.3",
                 },
                 contentType: "application/json",
                 body: request,
@@ -208,11 +208,97 @@ class Lists {
             }
         });
     }
+    /**
+     * Delete a list by list ID.
+     */
+    delete(listId, requestOptions) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield core.fetcher({
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.CourierEnvironment.Production, `/lists/${listId}`),
+                method: "DELETE",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@trycourier/courier",
+                    "X-Fern-SDK-Version": "v6.0.3",
+                },
+                contentType: "application/json",
+                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,
+            });
+            if (_response.ok) {
+                return;
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.CourierError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.CourierError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.CourierTimeoutError();
+                case "unknown":
+                    throw new errors.CourierError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    /**
+     * Restore a previously deleted list.
+     */
+    restore(listId, requestOptions) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield core.fetcher({
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.CourierEnvironment.Production, `/lists/${listId}/restore`),
+                method: "PUT",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@trycourier/courier",
+                    "X-Fern-SDK-Version": "v6.0.3",
+                },
+                contentType: "application/json",
+                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,
+            });
+            if (_response.ok) {
+                return;
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.CourierError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.CourierError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.CourierTimeoutError();
+                case "unknown":
+                    throw new errors.CourierError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
     /**
      * Get the list's subscriptions.
      * @throws {@link Courier.NotFoundError}
      */
-    getSubscriptions(listId, request = {}, requestOptions) {
+    getSubscribers(listId, request = {}, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const { cursor } = request;
@@ -227,7 +313,7 @@ class Lists {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "6.0.1",
+                    "X-Fern-SDK-Version": "v6.0.3",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -267,7 +353,7 @@ class Lists {
      * 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, request, requestOptions) {
+    updateSubscribers(listId, request, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
@@ -277,7 +363,7 @@ class Lists {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "6.0.1",
+                    "X-Fern-SDK-Version": "v6.0.3",
                 },
                 contentType: "application/json",
                 body: request,
@@ -317,7 +403,7 @@ class Lists {
      * 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, request, requestOptions) {
+    addSubscribers(listId, request, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
@@ -327,7 +413,7 @@ class Lists {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "6.0.1",
+                    "X-Fern-SDK-Version": "v6.0.3",
                     "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
                     "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null
                         ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry.toString()
@@ -370,7 +456,7 @@ class Lists {
     /**
      * Subscribe a user to an existing list (note: if the List does not exist, it will be automatically created).
      */
-    subscribe(listId, userId, request, requestOptions) {
+    subscribe(listId, userId, request = {}, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
@@ -380,7 +466,7 @@ class Lists {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "6.0.1",
+                    "X-Fern-SDK-Version": "v6.0.3",
                 },
                 contentType: "application/json",
                 body: request,
@@ -425,7 +511,7 @@ class Lists {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "6.0.1",
+                    "X-Fern-SDK-Version": "v6.0.3",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/dist/api/resources/lists/client/requests/GetAllListsRequest.d.ts

@@ -8,7 +8,6 @@ export interface GetAllListsRequest {
     cursor?: string;
     /**
      * "A pattern used to filter the list items returned. Pattern types supported: exact match on `list_id` or a pattern of one or more pattern parts. you may replace a part with either: `*` to match all parts in that position, or `**` to signify a wildcard `endsWith` pattern match."
-     *
      */
     pattern?: string;
 }

package/dist/api/resources/lists/client/requests/GetListRequest.d.ts

@@ -8,7 +8,6 @@ export interface GetListRequest {
     cursor?: string;
     /**
      * "A pattern used to filter the list items returned. Pattern types supported: exact match on `list_id` or a pattern of one or more pattern parts. you may replace a part with either: `*` to match all parts in that position, or `**` to signify a wildcard `endsWith` pattern match."
-     *
      */
     pattern?: string;
 }

package/dist/api/resources/lists/client/requests/SubscribeUserToListRequest.d.ts

@@ -3,7 +3,5 @@
  */
 import * as Courier from "../../../..";
 export interface SubscribeUserToListRequest {
-    listId: string;
-    recipientId: string;
     preferences?: Courier.RecipientPreferences;
 }

package/dist/api/resources/messages/client/Client.d.ts

@@ -7,7 +7,7 @@ import * as Courier from "../../..";
 export declare namespace Messages {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
-        authorizationToken: core.Supplier<core.BearerToken | undefined>;
+        authorizationToken?: core.Supplier<core.BearerToken | undefined>;
     }
     interface RequestOptions {
         timeoutInSeconds?: number;
@@ -20,7 +20,7 @@ export declare namespace Messages {
 }
 export declare class Messages {
     protected readonly _options: Messages.Options;
-    constructor(_options: Messages.Options);
+    constructor(_options?: Messages.Options);
     /**
      * Fetch the statuses of messages you've previously sent.
      */

package/dist/api/resources/messages/client/Client.js

@@ -45,7 +45,7 @@ const Courier = __importStar(require("../../.."));
 const url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("../../../../errors"));
 class Messages {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -54,7 +54,7 @@ class Messages {
     list(request = {}, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const { archived, cursor, event, list, messageId, notification, recipient, status, tags, enqueuedAfter, traceId, } = request;
+            const { archived, cursor, event, list, messageId, notification, recipient, status, tags, enqueued_after: enqueuedAfter, traceId, } = request;
             const _queryParams = {};
             if (archived != null) {
                 _queryParams["archived"] = archived.toString();
@@ -96,7 +96,7 @@ class Messages {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "6.0.1",
+                    "X-Fern-SDK-Version": "v6.0.3",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -142,7 +142,7 @@ class Messages {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "6.0.1",
+                    "X-Fern-SDK-Version": "v6.0.3",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -192,7 +192,7 @@ class Messages {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "6.0.1",
+                    "X-Fern-SDK-Version": "v6.0.3",
                     "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
                     "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null
                         ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry.toString()
@@ -246,7 +246,7 @@ class Messages {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "6.0.1",
+                    "X-Fern-SDK-Version": "v6.0.3",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -298,7 +298,7 @@ class Messages {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "6.0.1",
+                    "X-Fern-SDK-Version": "v6.0.3",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -345,7 +345,7 @@ class Messages {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "6.0.1",
+                    "X-Fern-SDK-Version": "v6.0.3",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

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

@@ -41,7 +41,7 @@ export interface ListMessagesRequest {
     /**
      * The enqueued datetime of a message to filter out messages received before.
      */
-    enqueuedAfter?: string;
+    enqueued_after?: string;
     /**
      * The unique identifier used to trace the requests
      */

package/dist/api/resources/notifications/client/Client.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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 Notifications {
+    interface Options {
+        environment?: core.Supplier<environments.CourierEnvironment | string>;
+        authorizationToken?: core.Supplier<core.BearerToken | undefined>;
+    }
+    interface RequestOptions {
+        timeoutInSeconds?: number;
+        maxRetries?: number;
+    }
+}
+export declare class Notifications {
+    protected readonly _options: Notifications.Options;
+    constructor(_options?: Notifications.Options);
+    list(request?: Courier.NotificationListParams, requestOptions?: Notifications.RequestOptions): Promise<Courier.NotificationListResponse>;
+    getContent(id: string, requestOptions?: Notifications.RequestOptions): Promise<Courier.NotificationGetContentResponse>;
+    getDraftContent(id: string, requestOptions?: Notifications.RequestOptions): Promise<Courier.NotificationGetContentResponse>;
+    updateVariations(id: string, request?: Courier.NotificationUpdateVariationsParams, requestOptions?: Notifications.RequestOptions): Promise<void>;
+    updateDraftVariations(id: string, request?: Courier.NotificationDraftUpdateVariationsParams, requestOptions?: Notifications.RequestOptions): Promise<void>;
+    getSubmissionChecks(id: string, submissionId: string, requestOptions?: Notifications.RequestOptions): Promise<Courier.SubmissionChecksGetResponse>;
+    replaceSubmissionChecks(id: string, submissionId: string, request: Courier.SubmissionChecksReplaceParams, requestOptions?: Notifications.RequestOptions): Promise<Courier.SubmissionChecksReplaceResponse>;
+    cancelSubmission(id: string, submissionId: string, requestOptions?: Notifications.RequestOptions): Promise<void>;
+    protected _getAuthorizationHeader(): Promise<string>;
+}