@trycourier/courier 6.1.0 → 6.1.2

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

@@ -41,16 +41,26 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Lists = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
-const Courier = __importStar(require("../../.."));
+const Courier = __importStar(require("../../../index"));
 const url_join_1 = __importDefault(require("url-join"));
-const errors = __importStar(require("../../../../errors"));
+const errors = __importStar(require("../../../../errors/index"));
 class Lists {
     constructor(_options = {}) {
         this._options = _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 courier.lists.list({
+     *         cursor: "string",
+     *         pattern: "string"
+     *     })
      */
     list(request = {}, requestOptions) {
         var _a, _b;
@@ -70,7 +80,9 @@ class Lists {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.2",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -108,19 +120,28 @@ class Lists {
     }
     /**
      * 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 courier.lists.get("string")
      */
     get(listId, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/lists/${listId}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/lists/${encodeURIComponent(listId)}`),
                 method: "GET",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.2",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -157,18 +178,55 @@ class Lists {
     }
     /**
      * 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 courier.lists.update("string", {
+     *         name: "string",
+     *         preferences: {
+     *             categories: {
+     *                 "string": {
+     *                     status: Courier.PreferenceStatus.OptedIn,
+     *                     rules: [{
+     *                             start: "string",
+     *                             until: "string"
+     *                         }],
+     *                     channel_preferences: [{
+     *                             channel: Courier.ChannelClassification.DirectMessage
+     *                         }]
+     *                 }
+     *             },
+     *             notifications: {
+     *                 "string": {
+     *                     status: Courier.PreferenceStatus.OptedIn,
+     *                     rules: [{
+     *                             start: "string",
+     *                             until: "string"
+     *                         }],
+     *                     channel_preferences: [{
+     *                             channel: Courier.ChannelClassification.DirectMessage
+     *                         }]
+     *                 }
+     *             }
+     *         }
+     *     })
      */
     update(listId, request, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/lists/${listId}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/lists/${encodeURIComponent(listId)}`),
                 method: "PUT",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.2",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 body: request,
@@ -201,18 +259,26 @@ class Lists {
     }
     /**
      * 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 courier.lists.delete("string")
      */
     delete(listId, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/lists/${listId}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/lists/${encodeURIComponent(listId)}`),
                 method: "DELETE",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.2",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -244,18 +310,26 @@ class Lists {
     }
     /**
      * Restore a previously deleted list.
+     *
+     * @param {string} listId - A unique identifier representing the list you wish to retrieve.
+     * @param {Lists.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.lists.restore("string")
      */
     restore(listId, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/lists/${listId}/restore`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/lists/${encodeURIComponent(listId)}/restore`),
                 method: "PUT",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.2",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -287,7 +361,17 @@ class Lists {
     }
     /**
      * 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 courier.lists.getSubscribers("string", {
+     *         cursor: "string"
+     *     })
      */
     getSubscribers(listId, request = {}, requestOptions) {
         var _a, _b;
@@ -298,13 +382,15 @@ class Lists {
                 _queryParams["cursor"] = cursor;
             }
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/lists/${listId}/subscriptions`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/lists/${encodeURIComponent(listId)}/subscriptions`),
                 method: "GET",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.2",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -342,19 +428,59 @@ class Lists {
     }
     /**
      * 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 courier.lists.updateSubscribers("string", {
+     *         recipients: [{
+     *                 recipientId: "string",
+     *                 preferences: {
+     *                     categories: {
+     *                         "string": {
+     *                             status: Courier.PreferenceStatus.OptedIn,
+     *                             rules: [{
+     *                                     start: "string",
+     *                                     until: "string"
+     *                                 }],
+     *                             channel_preferences: [{
+     *                                     channel: Courier.ChannelClassification.DirectMessage
+     *                                 }]
+     *                         }
+     *                     },
+     *                     notifications: {
+     *                         "string": {
+     *                             status: Courier.PreferenceStatus.OptedIn,
+     *                             rules: [{
+     *                                     start: "string",
+     *                                     until: "string"
+     *                                 }],
+     *                             channel_preferences: [{
+     *                                     channel: Courier.ChannelClassification.DirectMessage
+     *                                 }]
+     *                         }
+     *                     }
+     *                 }
+     *             }]
+     *     })
      */
     updateSubscribers(listId, request, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/lists/${listId}/subscriptions`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/lists/${encodeURIComponent(listId)}/subscriptions`),
                 method: "PUT",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.2",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 body: request,
@@ -392,23 +518,61 @@ class Lists {
     }
     /**
      * 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 courier.lists.addSubscribers("string", {
+     *         recipients: [{
+     *                 recipientId: "string",
+     *                 preferences: {
+     *                     categories: {
+     *                         "string": {
+     *                             status: Courier.PreferenceStatus.OptedIn,
+     *                             rules: [{
+     *                                     start: "string",
+     *                                     until: "string"
+     *                                 }],
+     *                             channel_preferences: [{
+     *                                     channel: Courier.ChannelClassification.DirectMessage
+     *                                 }]
+     *                         }
+     *                     },
+     *                     notifications: {
+     *                         "string": {
+     *                             status: Courier.PreferenceStatus.OptedIn,
+     *                             rules: [{
+     *                                     start: "string",
+     *                                     until: "string"
+     *                                 }],
+     *                             channel_preferences: [{
+     *                                     channel: Courier.ChannelClassification.DirectMessage
+     *                                 }]
+     *                         }
+     *                     }
+     *                 }
+     *             }]
+     *     })
      */
     addSubscribers(listId, request, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/lists/${listId}/subscriptions`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/lists/${encodeURIComponent(listId)}/subscriptions`),
                 method: "POST",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.2",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                     "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()
-                        : undefined,
+                    "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry : undefined,
                 },
                 contentType: "application/json",
                 body: request,
@@ -446,18 +610,55 @@ class Lists {
     }
     /**
      * 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 courier.lists.subscribe("string", "string", {
+     *         preferences: {
+     *             categories: {
+     *                 "string": {
+     *                     status: Courier.PreferenceStatus.OptedIn,
+     *                     rules: [{
+     *                             start: "string",
+     *                             until: "string"
+     *                         }],
+     *                     channel_preferences: [{
+     *                             channel: Courier.ChannelClassification.DirectMessage
+     *                         }]
+     *                 }
+     *             },
+     *             notifications: {
+     *                 "string": {
+     *                     status: Courier.PreferenceStatus.OptedIn,
+     *                     rules: [{
+     *                             start: "string",
+     *                             until: "string"
+     *                         }],
+     *                     channel_preferences: [{
+     *                             channel: Courier.ChannelClassification.DirectMessage
+     *                         }]
+     *                 }
+     *             }
+     *         }
+     *     })
      */
     subscribe(listId, userId, request = {}, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/lists/${listId}/subscriptions/${userId}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/lists/${encodeURIComponent(listId)}/subscriptions/${encodeURIComponent(userId)}`),
                 method: "PUT",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.2",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 body: request,
@@ -490,19 +691,29 @@ class Lists {
     }
     /**
      * 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 courier.lists.unsubscribe("string", "string")
      */
     unsubscribe(listId, userId, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/lists/${listId}/subscriptions/${userId}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/lists/${encodeURIComponent(listId)}/subscriptions/${encodeURIComponent(userId)}`),
                 method: "DELETE",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.2",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -540,7 +751,7 @@ class Lists {
     _getAuthorizationHeader() {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const bearer = (_a = (yield core.Supplier.get(this._options.authorizationToken))) !== null && _a !== void 0 ? _a : process.env["COURIER_AUTH_TOKEN"];
+            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 COURIER_AUTH_TOKEN when instantiating the client.",

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

@@ -0,0 +1,41 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../../../index";
+/**
+ * @example
+ *     {
+ *         recipients: [{
+ *                 recipientId: "string",
+ *                 preferences: {
+ *                     categories: {
+ *                         "string": {
+ *                             status: Courier.PreferenceStatus.OptedIn,
+ *                             rules: [{
+ *                                     start: "string",
+ *                                     until: "string"
+ *                                 }],
+ *                             channel_preferences: [{
+ *                                     channel: Courier.ChannelClassification.DirectMessage
+ *                                 }]
+ *                         }
+ *                     },
+ *                     notifications: {
+ *                         "string": {
+ *                             status: Courier.PreferenceStatus.OptedIn,
+ *                             rules: [{
+ *                                     start: "string",
+ *                                     until: "string"
+ *                                 }],
+ *                             channel_preferences: [{
+ *                                     channel: Courier.ChannelClassification.DirectMessage
+ *                                 }]
+ *                         }
+ *                     }
+ *                 }
+ *             }]
+ *     }
+ */
+export interface AddSubscribersToList {
+    recipients: Courier.PutSubscriptionsRecipient[];
+}

package/dist/api/resources/lists/client/requests/AddSubscribersToList.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/dist/api/resources/lists/client/requests/GetAllListsRequest.d.ts

@@ -1,6 +1,13 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         cursor: "string",
+ *         pattern: "string"
+ *     }
+ */
 export interface GetAllListsRequest {
     /**
      * A unique identifier that allows for fetching the next page of lists.

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

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         cursor: "string"
+ *     }
+ */
 export interface GetSubscriptionForListRequest {
     /**
      * A unique identifier that allows for fetching the next set of list subscriptions

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

@@ -1,7 +1,38 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../../..";
+import * as Courier from "../../../../index";
+/**
+ * @example
+ *     {
+ *         preferences: {
+ *             categories: {
+ *                 "string": {
+ *                     status: Courier.PreferenceStatus.OptedIn,
+ *                     rules: [{
+ *                             start: "string",
+ *                             until: "string"
+ *                         }],
+ *                     channel_preferences: [{
+ *                             channel: Courier.ChannelClassification.DirectMessage
+ *                         }]
+ *                 }
+ *             },
+ *             notifications: {
+ *                 "string": {
+ *                     status: Courier.PreferenceStatus.OptedIn,
+ *                     rules: [{
+ *                             start: "string",
+ *                             until: "string"
+ *                         }],
+ *                     channel_preferences: [{
+ *                             channel: Courier.ChannelClassification.DirectMessage
+ *                         }]
+ *                 }
+ *             }
+ *         }
+ *     }
+ */
 export interface SubscribeUserToListRequest {
     preferences?: Courier.RecipientPreferences;
 }

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

@@ -0,0 +1,41 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../../../index";
+/**
+ * @example
+ *     {
+ *         recipients: [{
+ *                 recipientId: "string",
+ *                 preferences: {
+ *                     categories: {
+ *                         "string": {
+ *                             status: Courier.PreferenceStatus.OptedIn,
+ *                             rules: [{
+ *                                     start: "string",
+ *                                     until: "string"
+ *                                 }],
+ *                             channel_preferences: [{
+ *                                     channel: Courier.ChannelClassification.DirectMessage
+ *                                 }]
+ *                         }
+ *                     },
+ *                     notifications: {
+ *                         "string": {
+ *                             status: Courier.PreferenceStatus.OptedIn,
+ *                             rules: [{
+ *                                     start: "string",
+ *                                     until: "string"
+ *                                 }],
+ *                             channel_preferences: [{
+ *                                     channel: Courier.ChannelClassification.DirectMessage
+ *                                 }]
+ *                         }
+ *                     }
+ *                 }
+ *             }]
+ *     }
+ */
+export interface SubscribeUsersToListRequest {
+    recipients: Courier.PutSubscriptionsRecipient[];
+}

package/dist/api/resources/lists/client/requests/SubscribeUsersToListRequest.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/dist/api/resources/lists/client/requests/index.d.ts

@@ -1,3 +1,5 @@
-export { GetAllListsRequest } from "./GetAllListsRequest";
-export { GetSubscriptionForListRequest } from "./GetSubscriptionForListRequest";
-export { SubscribeUserToListRequest } from "./SubscribeUserToListRequest";
+export { type GetAllListsRequest } from "./GetAllListsRequest";
+export { type GetSubscriptionForListRequest } from "./GetSubscriptionForListRequest";
+export { type SubscribeUsersToListRequest } from "./SubscribeUsersToListRequest";
+export { type AddSubscribersToList } from "./AddSubscribersToList";
+export { type SubscribeUserToListRequest } from "./SubscribeUserToListRequest";

package/dist/api/resources/lists/types/ListGetAllResponse.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface ListGetAllResponse {
     paging: Courier.Paging;
     items: Courier.List[];

package/dist/api/resources/lists/types/ListGetSubscriptionsResponse.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface ListGetSubscriptionsResponse {
     paging: Courier.Paging;
     items: Courier.ListSubscriptionRecipient[];

package/dist/api/resources/lists/types/ListPutParams.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface ListPutParams {
     name: string;
     preferences?: Courier.RecipientPreferences;