@trycourier/courier 6.1.1 → 6.1.3

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

@@ -41,28 +41,38 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Translations = 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 Translations {
     constructor(_options = {}) {
         this._options = _options;
     }
     /**
      * Get translations by locale
+     *
+     * @param {string} domain - The domain you want to retrieve translations for. Only `default` is supported at the moment
+     * @param {string} locale - The locale you want to retrieve the translations for
+     * @param {Translations.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.NotFoundError}
+     *
+     * @example
+     *     await courier.translations.get("string", "string")
      */
     get(domain, locale, 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, `/translations/${domain}/${locale}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/translations/${encodeURIComponent(domain)}/${encodeURIComponent(locale)}`),
                 method: "GET",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.1",
+                    "X-Fern-SDK-Version": "v6.1.3",
+                    "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,
@@ -99,19 +109,30 @@ class Translations {
     }
     /**
      * Update a translation
+     *
+     * @param {string} domain - The domain you want to retrieve translations for. Only `default` is supported at the moment
+     * @param {string} locale - The locale you want to retrieve the translations for
+     * @param {string} request
+     * @param {Translations.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.NotFoundError}
+     *
+     * @example
+     *     await courier.translations.update("string", "string", "string")
      */
     update(domain, locale, 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, `/translations/${domain}/${locale}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/translations/${encodeURIComponent(domain)}/${encodeURIComponent(locale)}`),
                 method: "PUT",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.1",
+                    "X-Fern-SDK-Version": "v6.1.3",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 body: request,
@@ -150,7 +171,7 @@ class Translations {
     _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/users/resources/preferences/client/Client.d.ts

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../../../environments";
 import * as core from "../../../../../../core";
-import * as Courier from "../../../../..";
+import * as Courier from "../../../../../index";
 export declare namespace Preferences {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
@@ -20,16 +20,37 @@ export declare class Preferences {
     constructor(_options?: Preferences.Options);
     /**
      * Fetch all user preferences.
+     *
+     * @param {string} userId - A unique identifier associated with the user whose preferences you wish to retrieve.
+     * @param {Preferences.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.BadRequestError}
+     *
+     * @example
+     *     await courier.users.preferences.list("string")
      */
     list(userId: string, requestOptions?: Preferences.RequestOptions): Promise<Courier.users.UserPreferencesListResponse>;
     /**
      * Fetch user preferences for a specific subscription topic.
+     *
+     * @param {string} userId - A unique identifier associated with the user whose preferences you wish to retrieve.
+     * @param {string} topicId - A unique identifier associated with a subscription topic.
+     * @param {Preferences.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.NotFoundError}
+     *
+     * @example
+     *     await courier.users.preferences.get("string", "string")
      */
     get(userId: string, topicId: string, requestOptions?: Preferences.RequestOptions): Promise<Courier.users.UserPreferencesGetResponse>;
     /**
      * Update or Create user preferences for a specific subscription topic.
+     *
+     * @param {string} userId - A unique identifier associated with the user whose preferences you wish to retrieve.
+     * @param {string} topicId - A unique identifier associated with a subscription topic.
+     * @param {Courier.users.UserPreferencesUpdateParams} request
+     * @param {Preferences.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.BadRequestError}
      *
      * @example

package/dist/api/resources/users/resources/preferences/client/Client.js

@@ -41,28 +41,37 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Preferences = 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 Preferences {
     constructor(_options = {}) {
         this._options = _options;
     }
     /**
      * Fetch all user preferences.
+     *
+     * @param {string} userId - A unique identifier associated with the user whose preferences you wish to retrieve.
+     * @param {Preferences.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.BadRequestError}
+     *
+     * @example
+     *     await courier.users.preferences.list("string")
      */
     list(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, `/users/${userId}/preferences`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/users/${encodeURIComponent(userId)}/preferences`),
                 method: "GET",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.1",
+                    "X-Fern-SDK-Version": "v6.1.3",
+                    "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,
@@ -99,19 +108,29 @@ class Preferences {
     }
     /**
      * Fetch user preferences for a specific subscription topic.
+     *
+     * @param {string} userId - A unique identifier associated with the user whose preferences you wish to retrieve.
+     * @param {string} topicId - A unique identifier associated with a subscription topic.
+     * @param {Preferences.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.NotFoundError}
+     *
+     * @example
+     *     await courier.users.preferences.get("string", "string")
      */
     get(userId, topicId, 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, `/users/${userId}/preferences/${topicId}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/users/${encodeURIComponent(userId)}/preferences/${encodeURIComponent(topicId)}`),
                 method: "GET",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.1",
+                    "X-Fern-SDK-Version": "v6.1.3",
+                    "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,
@@ -148,6 +167,12 @@ class Preferences {
     }
     /**
      * Update or Create user preferences for a specific subscription topic.
+     *
+     * @param {string} userId - A unique identifier associated with the user whose preferences you wish to retrieve.
+     * @param {string} topicId - A unique identifier associated with a subscription topic.
+     * @param {Courier.users.UserPreferencesUpdateParams} request
+     * @param {Preferences.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.BadRequestError}
      *
      * @example
@@ -163,13 +188,15 @@ class Preferences {
         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, `/users/${userId}/preferences/${topicId}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/users/${encodeURIComponent(userId)}/preferences/${encodeURIComponent(topicId)}`),
                 method: "PUT",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.1",
+                    "X-Fern-SDK-Version": "v6.1.3",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 body: request,
@@ -208,7 +235,7 @@ class Preferences {
     _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/users/resources/preferences/client/requests/UserPreferencesUpdateParams.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";
 /**
  * @example
  *     {

package/dist/api/resources/users/resources/preferences/client/requests/index.d.ts

@@ -1 +1 @@
-export { UserPreferencesUpdateParams } from "./UserPreferencesUpdateParams";
+export { type UserPreferencesUpdateParams } from "./UserPreferencesUpdateParams";

package/dist/api/resources/users/resources/preferences/types/TopicPreference.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 TopicPreference {
     /** The Channels a user has chosen to receive notifications through for this topic */
     custom_routing?: Courier.ChannelClassification[];

package/dist/api/resources/users/resources/preferences/types/TopicPreferenceUpdate.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 TopicPreferenceUpdate {
     status: Courier.PreferenceStatus;
     /** The Channels a user has chosen to receive notifications through for this topic */

package/dist/api/resources/users/resources/preferences/types/UserPreferencesGetResponse.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 UserPreferencesGetResponse {
     topic: Courier.users.TopicPreference;
 }

package/dist/api/resources/users/resources/preferences/types/UserPreferencesListResponse.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 UserPreferencesListResponse {
     paging: Courier.Paging;
     /** The Preferences associated with the user_id. */

package/dist/api/resources/users/resources/tenants/client/Client.d.ts

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../../../environments";
 import * as core from "../../../../../../core";
-import * as Courier from "../../../../..";
+import * as Courier from "../../../../../index";
 export declare namespace Tenants {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
@@ -24,6 +24,24 @@ export declare class Tenants {
      * A custom profile can also be supplied for each tenant.
      * This profile will be merged with the user's main
      * profile when sending to the user with that tenant.
+     *
+     * @param {string} userId - The user's ID. This can be any uniquely identifiable string.
+     * @param {Courier.users.AddUserToMultipleTenantsParams} request
+     * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.users.tenants.addMultple("string", {
+     *         tenants: [{
+     *                 user_id: "string",
+     *                 type: "user",
+     *                 tenant_id: "string",
+     *                 profile: {
+     *                     "string": {
+     *                         "key": "value"
+     *                     }
+     *                 }
+     *             }]
+     *     })
      */
     addMultple(userId: string, request: Courier.users.AddUserToMultipleTenantsParams, requestOptions?: Tenants.RequestOptions): Promise<void>;
     /**
@@ -32,18 +50,55 @@ export declare class Tenants {
      * A custom profile can also be supplied with the tenant.
      * This profile will be merged with the user's main profile
      * when sending to the user with that tenant.
+     *
+     * @param {string} userId - Id of the user to be added to the supplied tenant.
+     * @param {string} tenantId - Id of the tenant the user should be added to.
+     * @param {Courier.users.AddUserToSingleTenantsParams} request
+     * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.users.tenants.add("string", "string", {
+     *         profile: {
+     *             "string": {
+     *                 "key": "value"
+     *             }
+     *         }
+     *     })
      */
-    add(userId: string, tenantId: string, request: Courier.users.AddUserToSingleTenantsParams, requestOptions?: Tenants.RequestOptions): Promise<void>;
+    add(userId: string, tenantId: string, request?: Courier.users.AddUserToSingleTenantsParams, requestOptions?: Tenants.RequestOptions): Promise<void>;
     /**
      * Removes a user from any tenants they may have been associated with.
+     *
+     * @param {string} userId - Id of the user to be removed from the supplied tenant.
+     * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.users.tenants.removeAll("string")
      */
     removeAll(userId: string, requestOptions?: Tenants.RequestOptions): Promise<void>;
     /**
      * Removes a user from the supplied tenant.
+     *
+     * @param {string} userId - Id of the user to be removed from the supplied tenant.
+     * @param {string} tenantId - Id of the tenant the user should be removed from.
+     * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.users.tenants.remove("string", "string")
      */
     remove(userId: string, tenantId: string, requestOptions?: Tenants.RequestOptions): Promise<void>;
     /**
      * Returns a paginated list of user tenant associations.
+     *
+     * @param {string} userId - Id of the user to retrieve all associated tenants for.
+     * @param {Courier.users.ListTenantsForUserParams} request
+     * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.users.tenants.list("string", {
+     *         limit: 1,
+     *         cursor: "string"
+     *     })
      */
     list(userId: string, request?: Courier.users.ListTenantsForUserParams, requestOptions?: Tenants.RequestOptions): Promise<Courier.users.ListTenantsForUserResponse>;
     protected _getAuthorizationHeader(): Promise<string>;

package/dist/api/resources/users/resources/tenants/client/Client.js

@@ -42,7 +42,7 @@ exports.Tenants = void 0;
 const environments = __importStar(require("../../../../../../environments"));
 const core = __importStar(require("../../../../../../core"));
 const url_join_1 = __importDefault(require("url-join"));
-const errors = __importStar(require("../../../../../../errors"));
+const errors = __importStar(require("../../../../../../errors/index"));
 class Tenants {
     constructor(_options = {}) {
         this._options = _options;
@@ -53,18 +53,38 @@ class Tenants {
      * A custom profile can also be supplied for each tenant.
      * This profile will be merged with the user's main
      * profile when sending to the user with that tenant.
+     *
+     * @param {string} userId - The user's ID. This can be any uniquely identifiable string.
+     * @param {Courier.users.AddUserToMultipleTenantsParams} request
+     * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.users.tenants.addMultple("string", {
+     *         tenants: [{
+     *                 user_id: "string",
+     *                 type: "user",
+     *                 tenant_id: "string",
+     *                 profile: {
+     *                     "string": {
+     *                         "key": "value"
+     *                     }
+     *                 }
+     *             }]
+     *     })
      */
     addMultple(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, `users/${userId}/tenants`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `users/${encodeURIComponent(userId)}/tenants`),
                 method: "PUT",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.1",
+                    "X-Fern-SDK-Version": "v6.1.3",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 body: request,
@@ -101,18 +121,34 @@ class Tenants {
      * A custom profile can also be supplied with the tenant.
      * This profile will be merged with the user's main profile
      * when sending to the user with that tenant.
+     *
+     * @param {string} userId - Id of the user to be added to the supplied tenant.
+     * @param {string} tenantId - Id of the tenant the user should be added to.
+     * @param {Courier.users.AddUserToSingleTenantsParams} request
+     * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.users.tenants.add("string", "string", {
+     *         profile: {
+     *             "string": {
+     *                 "key": "value"
+     *             }
+     *         }
+     *     })
      */
-    add(userId, tenantId, request, requestOptions) {
+    add(userId, tenantId, 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, `users/${userId}/tenants/${tenantId}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `users/${encodeURIComponent(userId)}/tenants/${encodeURIComponent(tenantId)}`),
                 method: "PUT",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.1",
+                    "X-Fern-SDK-Version": "v6.1.3",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 body: request,
@@ -145,18 +181,26 @@ class Tenants {
     }
     /**
      * Removes a user from any tenants they may have been associated with.
+     *
+     * @param {string} userId - Id of the user to be removed from the supplied tenant.
+     * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.users.tenants.removeAll("string")
      */
     removeAll(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, `users/${userId}/tenants`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `users/${encodeURIComponent(userId)}/tenants`),
                 method: "DELETE",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.1",
+                    "X-Fern-SDK-Version": "v6.1.3",
+                    "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,
@@ -188,18 +232,27 @@ class Tenants {
     }
     /**
      * Removes a user from the supplied tenant.
+     *
+     * @param {string} userId - Id of the user to be removed from the supplied tenant.
+     * @param {string} tenantId - Id of the tenant the user should be removed from.
+     * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.users.tenants.remove("string", "string")
      */
     remove(userId, tenantId, 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, `users/${userId}/tenants/${tenantId}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `users/${encodeURIComponent(userId)}/tenants/${encodeURIComponent(tenantId)}`),
                 method: "DELETE",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.1",
+                    "X-Fern-SDK-Version": "v6.1.3",
+                    "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,
@@ -231,6 +284,16 @@ class Tenants {
     }
     /**
      * Returns a paginated list of user tenant associations.
+     *
+     * @param {string} userId - Id of the user to retrieve all associated tenants for.
+     * @param {Courier.users.ListTenantsForUserParams} request
+     * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.users.tenants.list("string", {
+     *         limit: 1,
+     *         cursor: "string"
+     *     })
      */
     list(userId, request = {}, requestOptions) {
         var _a, _b;
@@ -244,13 +307,15 @@ class Tenants {
                 _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, `users/${userId}/tenants`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `users/${encodeURIComponent(userId)}/tenants`),
                 method: "GET",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.1",
+                    "X-Fern-SDK-Version": "v6.1.3",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -284,7 +349,7 @@ class Tenants {
     _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/users/resources/tenants/client/requests/AddUserToMultipleTenantsParams.d.ts

@@ -1,7 +1,22 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../../../../..";
+import * as Courier from "../../../../../../index";
+/**
+ * @example
+ *     {
+ *         tenants: [{
+ *                 user_id: "string",
+ *                 type: "user",
+ *                 tenant_id: "string",
+ *                 profile: {
+ *                     "string": {
+ *                         "key": "value"
+ *                     }
+ *                 }
+ *             }]
+ *     }
+ */
 export interface AddUserToMultipleTenantsParams {
     tenants: Courier.UserTenantAssociation[];
 }

package/dist/api/resources/users/resources/tenants/client/requests/AddUserToSingleTenantsParams.d.ts

@@ -1,7 +1,16 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../../../../..";
+/**
+ * @example
+ *     {
+ *         profile: {
+ *             "string": {
+ *                 "key": "value"
+ *             }
+ *         }
+ *     }
+ */
 export interface AddUserToSingleTenantsParams {
-    profile: Courier.users.AddUserToSingleTenantsParamsProfile;
+    profile?: Record<string, any>;
 }

package/dist/api/resources/users/resources/tenants/client/requests/ListTenantsForUserParams.d.ts

@@ -1,6 +1,13 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         limit: 1,
+ *         cursor: "string"
+ *     }
+ */
 export interface ListTenantsForUserParams {
     /**
      * The number of accounts to return

package/dist/api/resources/users/resources/tenants/client/requests/index.d.ts

@@ -1,3 +1,3 @@
-export { AddUserToMultipleTenantsParams } from "./AddUserToMultipleTenantsParams";
-export { AddUserToSingleTenantsParams } from "./AddUserToSingleTenantsParams";
-export { ListTenantsForUserParams } from "./ListTenantsForUserParams";
+export { type AddUserToMultipleTenantsParams } from "./AddUserToMultipleTenantsParams";
+export { type AddUserToSingleTenantsParams } from "./AddUserToSingleTenantsParams";
+export { type ListTenantsForUserParams } from "./ListTenantsForUserParams";