@trycourier/courier 6.3.1 → 6.4.0

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

@@ -9,21 +9,19 @@ import { Tokens } from "../resources/tokens/client/Client";
 export declare namespace Users {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
         authorizationToken?: core.Supplier<core.BearerToken | undefined>;
         fetcher?: core.FetchFunction;
     }
-    interface RequestOptions {
-        timeoutInSeconds?: number;
-        maxRetries?: number;
-    }
 }
 export declare class Users {
     protected readonly _options: Users.Options;
-    constructor(_options?: Users.Options);
     protected _preferences: Preferences | undefined;
-    get preferences(): Preferences;
     protected _tenants: Tenants | undefined;
-    get tenants(): Tenants;
     protected _tokens: Tokens | undefined;
+    constructor(_options?: Users.Options);
+    get preferences(): Preferences;
+    get tenants(): Tenants;
     get tokens(): Tokens;
 }

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

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };

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

@@ -7,12 +7,20 @@ import * as Courier from "../../../../../index";
 export declare namespace Preferences {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
         authorizationToken?: core.Supplier<core.BearerToken | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 export declare class Preferences {
@@ -28,9 +36,7 @@ export declare class Preferences {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.users.preferences.list("string", {
-     *         tenant_id: "string"
-     *     })
+     *     await client.users.preferences.list("user_id")
      */
     list(userId: string, request?: Courier.users.UserPreferencesParams, requestOptions?: Preferences.RequestOptions): Promise<Courier.users.UserPreferencesListResponse>;
     /**
@@ -44,9 +50,7 @@ export declare class Preferences {
      * @throws {@link Courier.NotFoundError}
      *
      * @example
-     *     await courier.users.preferences.get("string", "string", {
-     *         tenant_id: "string"
-     *     })
+     *     await client.users.preferences.get("user_id", "topic_id")
      */
     get(userId: string, topicId: string, request?: Courier.users.UserPreferencesTopicParams, requestOptions?: Preferences.RequestOptions): Promise<Courier.users.UserPreferencesGetResponse>;
     /**
@@ -60,11 +64,11 @@ export declare class Preferences {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.users.preferences.update("abc-123", "74Q4QGFBEX481DP6JRPMV751H4XT", {
+     *     await client.users.preferences.update("abc-123", "74Q4QGFBEX481DP6JRPMV751H4XT", {
      *         topic: {
-     *             status: Courier.PreferenceStatus.OptedIn,
+     *             status: "OPTED_IN",
      *             has_custom_routing: true,
-     *             custom_routing: [Courier.ChannelClassification.Inbox, Courier.ChannelClassification.Email]
+     *             custom_routing: ["inbox", "email"]
      *         }
      *     })
      */

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

@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -69,33 +79,26 @@ class Preferences {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.users.preferences.list("string", {
-     *         tenant_id: "string"
-     *     })
+     *     await client.users.preferences.list("user_id")
      */
-    list(userId, request = {}, requestOptions) {
-        var _a, _b;
-        return __awaiter(this, void 0, void 0, function* () {
+    list(userId_1) {
+        return __awaiter(this, arguments, void 0, function* (userId, request = {}, requestOptions) {
+            var _a, _b, _c;
             const { tenant_id: tenantId } = request;
             const _queryParams = {};
             if (tenantId != null) {
                 _queryParams["tenant_id"] = tenantId;
             }
             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/${encodeURIComponent(userId)}/preferences`),
+                url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : 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.3.1",
-                    "X-Fern-Runtime": core.RUNTIME.type,
-                    "X-Fern-Runtime-Version": core.RUNTIME.version,
-                },
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@trycourier/courier", "X-Fern-SDK-Version": "6.4.0", "User-Agent": "@trycourier/courier/6.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 queryParameters: _queryParams,
+                requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return _response.body;
@@ -118,7 +121,7 @@ class Preferences {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling GET /users/{user_id}/preferences.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -137,33 +140,26 @@ class Preferences {
      * @throws {@link Courier.NotFoundError}
      *
      * @example
-     *     await courier.users.preferences.get("string", "string", {
-     *         tenant_id: "string"
-     *     })
+     *     await client.users.preferences.get("user_id", "topic_id")
      */
-    get(userId, topicId, request = {}, requestOptions) {
-        var _a, _b;
-        return __awaiter(this, void 0, void 0, function* () {
+    get(userId_1, topicId_1) {
+        return __awaiter(this, arguments, void 0, function* (userId, topicId, request = {}, requestOptions) {
+            var _a, _b, _c;
             const { tenant_id: tenantId } = request;
             const _queryParams = {};
             if (tenantId != null) {
                 _queryParams["tenant_id"] = tenantId;
             }
             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/${encodeURIComponent(userId)}/preferences/${encodeURIComponent(topicId)}`),
+                url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : 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.3.1",
-                    "X-Fern-Runtime": core.RUNTIME.type,
-                    "X-Fern-Runtime-Version": core.RUNTIME.version,
-                },
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@trycourier/courier", "X-Fern-SDK-Version": "6.4.0", "User-Agent": "@trycourier/courier/6.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 queryParameters: _queryParams,
+                requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return _response.body;
@@ -186,7 +182,7 @@ class Preferences {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling GET /users/{user_id}/preferences/{topic_id}.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -205,38 +201,33 @@ class Preferences {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.users.preferences.update("abc-123", "74Q4QGFBEX481DP6JRPMV751H4XT", {
+     *     await client.users.preferences.update("abc-123", "74Q4QGFBEX481DP6JRPMV751H4XT", {
      *         topic: {
-     *             status: Courier.PreferenceStatus.OptedIn,
+     *             status: "OPTED_IN",
      *             has_custom_routing: true,
-     *             custom_routing: [Courier.ChannelClassification.Inbox, Courier.ChannelClassification.Email]
+     *             custom_routing: ["inbox", "email"]
      *         }
      *     })
      */
     update(userId, topicId, request, requestOptions) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
             const { tenant_id: tenantId } = request, _body = __rest(request, ["tenant_id"]);
             const _queryParams = {};
             if (tenantId != null) {
                 _queryParams["tenant_id"] = tenantId;
             }
             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/${encodeURIComponent(userId)}/preferences/${encodeURIComponent(topicId)}`),
+                url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : 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.3.1",
-                    "X-Fern-Runtime": core.RUNTIME.type,
-                    "X-Fern-Runtime-Version": core.RUNTIME.version,
-                },
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@trycourier/courier", "X-Fern-SDK-Version": "6.4.0", "User-Agent": "@trycourier/courier/6.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 queryParameters: _queryParams,
+                requestType: "json",
                 body: _body,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return _response.body;
@@ -259,7 +250,7 @@ class Preferences {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling PUT /users/{user_id}/preferences/{topic_id}.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -268,12 +259,12 @@ class Preferences {
         });
     }
     _getAuthorizationHeader() {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             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.",
+                    message: "Please specify a bearer by either passing it in to the constructor or initializing a COURIER_AUTH_TOKEN environment variable",
                 });
             }
             return `Bearer ${bearer}`;

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

@@ -3,9 +3,7 @@
  */
 /**
  * @example
- *     {
- *         tenant_id: "string"
- *     }
+ *     {}
  */
 export interface UserPreferencesParams {
     /**

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

@@ -3,9 +3,7 @@
  */
 /**
  * @example
- *     {
- *         tenant_id: "string"
- *     }
+ *     {}
  */
 export interface UserPreferencesTopicParams {
     /**

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

@@ -6,9 +6,9 @@ import * as Courier from "../../../../../../index";
  * @example
  *     {
  *         topic: {
- *             status: Courier.PreferenceStatus.OptedIn,
+ *             status: "OPTED_IN",
  *             has_custom_routing: true,
- *             custom_routing: [Courier.ChannelClassification.Inbox, Courier.ChannelClassification.Email]
+ *             custom_routing: ["inbox", "email"]
  *         }
  *     }
  */

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

@@ -7,12 +7,20 @@ import * as Courier from "../../../../../index";
 export declare namespace Tenants {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
         authorizationToken?: core.Supplier<core.BearerToken | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 export declare class Tenants {
@@ -30,16 +38,17 @@ export declare class Tenants {
      * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.users.tenants.addMultple("string", {
+     *     await client.users.tenants.addMultple("user_id", {
      *         tenants: [{
-     *                 user_id: "string",
-     *                 type: "user",
-     *                 tenant_id: "string",
-     *                 profile: {
-     *                     "string": {
-     *                         "key": "value"
-     *                     }
-     *                 }
+     *                 user_id: undefined,
+     *                 type: undefined,
+     *                 tenant_id: "tenant_id",
+     *                 profile: undefined
+     *             }, {
+     *                 user_id: undefined,
+     *                 type: undefined,
+     *                 tenant_id: "tenant_id",
+     *                 profile: undefined
      *             }]
      *     })
      */
@@ -57,12 +66,8 @@ export declare class Tenants {
      * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.users.tenants.add("string", "string", {
-     *         profile: {
-     *             "string": {
-     *                 "key": "value"
-     *             }
-     *         }
+     *     await client.users.tenants.add("user_id", "tenant_id", {
+     *         profile: undefined
      *     })
      */
     add(userId: string, tenantId: string, request?: Courier.users.AddUserToSingleTenantsParams, requestOptions?: Tenants.RequestOptions): Promise<void>;
@@ -73,7 +78,7 @@ export declare class Tenants {
      * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.users.tenants.removeAll("string")
+     *     await client.users.tenants.removeAll("user_id")
      */
     removeAll(userId: string, requestOptions?: Tenants.RequestOptions): Promise<void>;
     /**
@@ -84,7 +89,7 @@ export declare class Tenants {
      * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.users.tenants.remove("string", "string")
+     *     await client.users.tenants.remove("user_id", "tenant_id")
      */
     remove(userId: string, tenantId: string, requestOptions?: Tenants.RequestOptions): Promise<void>;
     /**
@@ -95,10 +100,7 @@ export declare class Tenants {
      * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.users.tenants.list("string", {
-     *         limit: 1,
-     *         cursor: "string"
-     *     })
+     *     await client.users.tenants.list("user_id")
      */
     list(userId: string, request?: Courier.users.ListTenantsForUserParams, requestOptions?: Tenants.RequestOptions): Promise<Courier.users.ListTenantsForUserResponse>;
     protected _getAuthorizationHeader(): Promise<string>;