@trycourier/courier 6.1.0 → 6.1.2

package/dist/api/resources/tenants/types/SubscriptionTopicNew.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../../index";
+export interface SubscriptionTopicNew {
+    status: Courier.SubscriptionTopicStatus;
+    /** Override channel routing with custom preferences. This will override any template prefernces that are set, but a user can still customize their preferences */
+    has_custom_routing?: boolean;
+    /** The default channels to send to this tenant when has_custom_routing is enabled */
+    custom_routing?: Courier.ChannelClassification[];
+}

package/dist/api/resources/tenants/types/SubscriptionTopicNew.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/tenants/types/TemplateProperty.d.ts

@@ -1,4 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * Unused type for tenants
+ */
 export declare type TemplateProperty = any;

package/dist/api/resources/tenants/types/Tenant.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 Tenant {
     /** Id of the tenant. */
     id: string;
@@ -12,7 +12,7 @@ export interface Tenant {
     /** Defines the preferences used for the account when the user hasn't specified their own. */
     default_preferences?: Courier.DefaultPreferences;
     /** Arbitrary properties accessible to a template. */
-    properties?: Courier.TemplateProperty | undefined;
+    properties?: Record<string, any>;
     /** A user profile object merged with user profile on send. */
     user_profile?: Record<string, any>;
     /** Brand to be used for the account when one is not specified by the send call. */

package/dist/api/resources/tenants/types/TenantListResponse.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 TenantListResponse {
     /** A pointer to the next page of results. Defined only when has_more is set to true. */
     cursor?: string;

package/dist/api/resources/tenants/types/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./DefaultPreferences";
+export * from "./SubscriptionTopicNew";
 export * from "./SubscriptionTopic";
 export * from "./SubscriptionTopicStatus";
 export * from "./Tenant";

package/dist/api/resources/tenants/types/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./DefaultPreferences"), exports);
+__exportStar(require("./SubscriptionTopicNew"), exports);
 __exportStar(require("./SubscriptionTopic"), exports);
 __exportStar(require("./SubscriptionTopicStatus"), exports);
 __exportStar(require("./Tenant"), exports);

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

@@ -19,12 +19,29 @@ export declare class Translations {
     constructor(_options?: Translations.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: string, locale: string, requestOptions?: Translations.RequestOptions): Promise<string>;
     /**
      * 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: string, locale: string, request: string, requestOptions?: Translations.RequestOptions): Promise<void>;
     protected _getAuthorizationHeader(): Promise<string>;

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.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,
@@ -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.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,
@@ -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,17 +20,47 @@ 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
+     *     await courier.users.preferences.update("abc-123", "74Q4QGFBEX481DP6JRPMV751H4XT", {
+     *         topic: {
+     *             status: Courier.PreferenceStatus.OptedIn,
+     *             has_custom_routing: true,
+     *             custom_routing: [Courier.ChannelClassification.Inbox, Courier.ChannelClassification.Email]
+     *         }
+     *     })
      */
     update(userId: string, topicId: string, request: Courier.users.UserPreferencesUpdateParams, requestOptions?: Preferences.RequestOptions): Promise<Courier.users.UserPreferencesUpdateResponse>;
     protected _getAuthorizationHeader(): Promise<string>;

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.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,
@@ -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.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,
@@ -148,19 +167,36 @@ 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
+     *     await courier.users.preferences.update("abc-123", "74Q4QGFBEX481DP6JRPMV751H4XT", {
+     *         topic: {
+     *             status: Courier.PreferenceStatus.OptedIn,
+     *             has_custom_routing: true,
+     *             custom_routing: [Courier.ChannelClassification.Inbox, Courier.ChannelClassification.Email]
+     *         }
+     *     })
      */
     update(userId, topicId, 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}/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.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,
@@ -199,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,11 +1,17 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../../../../..";
+import * as Courier from "../../../../../../index";
+/**
+ * @example
+ *     {
+ *         topic: {
+ *             status: Courier.PreferenceStatus.OptedIn,
+ *             has_custom_routing: true,
+ *             custom_routing: [Courier.ChannelClassification.Inbox, Courier.ChannelClassification.Email]
+ *         }
+ *     }
+ */
 export interface UserPreferencesUpdateParams {
-    status: Courier.PreferenceStatus;
-    /** The Channels a user has chosen to receive notifications through for this topic */
-    custom_routing?: Courier.ChannelClassification[];
-    default_status: Courier.PreferenceStatus;
-    has_custom_routing?: boolean;
+    topic: Courier.users.TopicPreferenceUpdate;
 }

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../../../../index";
+export interface TopicPreferenceUpdate {
+    status: Courier.PreferenceStatus;
+    /** The Channels a user has chosen to receive notifications through for this topic */
+    custom_routing?: Courier.ChannelClassification[];
+    has_custom_routing?: boolean;
+}

package/dist/api/resources/users/resources/preferences/types/TopicPreferenceUpdate.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/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/preferences/types/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./UserPreferencesListResponse";
 export * from "./UserPreferencesGetResponse";
 export * from "./TopicPreference";
+export * from "./TopicPreferenceUpdate";
 export * from "./UserPreferencesUpdateResponse";

package/dist/api/resources/users/resources/preferences/types/index.js

@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./UserPreferencesListResponse"), exports);
 __exportStar(require("./UserPreferencesGetResponse"), exports);
 __exportStar(require("./TopicPreference"), exports);
+__exportStar(require("./TopicPreferenceUpdate"), exports);
 __exportStar(require("./UserPreferencesUpdateResponse"), exports);

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>;