@trycourier/courier 6.3.1 → 6.4.0

package/Client.d.ts

@@ -22,12 +22,20 @@ import { Users } from "./api/resources/users/client/Client";
 export declare namespace CourierClient {
     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>;
     }
     interface IdempotentRequestOptions extends RequestOptions {
         idempotencyKey?: string | undefined;
@@ -36,7 +44,37 @@ export declare namespace CourierClient {
 }
 export declare class CourierClient {
     protected readonly _options: CourierClient.Options;
+    protected _audiences: Audiences | undefined;
+    protected _auditEvents: AuditEvents | undefined;
+    protected _authTokens: AuthTokens | undefined;
+    protected _automations: Automations | undefined;
+    protected _brands: Brands | undefined;
+    protected _bulk: Bulk | undefined;
+    protected _inbound: Inbound | undefined;
+    protected _lists: Lists | undefined;
+    protected _messages: Messages | undefined;
+    protected _notifications: Notifications | undefined;
+    protected _profiles: Profiles | undefined;
+    protected _templates: Templates | undefined;
+    protected _tenants: Tenants | undefined;
+    protected _translations: Translations | undefined;
+    protected _users: Users | undefined;
     constructor(_options?: CourierClient.Options);
+    get audiences(): Audiences;
+    get auditEvents(): AuditEvents;
+    get authTokens(): AuthTokens;
+    get automations(): Automations;
+    get brands(): Brands;
+    get bulk(): Bulk;
+    get inbound(): Inbound;
+    get lists(): Lists;
+    get messages(): Messages;
+    get notifications(): Notifications;
+    get profiles(): Profiles;
+    get templates(): Templates;
+    get tenants(): Tenants;
+    get translations(): Translations;
+    get users(): Users;
     /**
      * Use the send API to send a message to one or more recipients.
      *
@@ -44,123 +82,60 @@ export declare class CourierClient {
      * @param {CourierClient.IdempotentRequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.send({
+     *     await client.send({
      *         message: {
+     *             data: undefined,
+     *             brand_id: undefined,
+     *             channels: undefined,
+     *             context: undefined,
+     *             metadata: undefined,
+     *             preferences: undefined,
+     *             providers: undefined,
+     *             routing: undefined,
+     *             timeout: undefined,
+     *             delay: undefined,
+     *             expiry: undefined,
+     *             to: undefined,
      *             content: {
-     *                 version: "string",
-     *                 brand: {
-     *                     "key": "value"
-     *                 },
+     *                 version: "version",
+     *                 brand: undefined,
      *                 elements: [{
-     *                         type: "text"
-     *                     }]
-     *             },
-     *             data: {
-     *                 "string": {
-     *                     "key": "value"
-     *                 }
-     *             },
-     *             brand_id: "string",
-     *             channels: {
-     *                 "string": {
-     *                     brand_id: undefined,
-     *                     providers: undefined,
-     *                     routing_method: undefined,
-     *                     if: undefined,
-     *                     timeouts: undefined,
-     *                     override: undefined,
-     *                     metadata: undefined
-     *                 }
-     *             },
-     *             context: {
-     *                 tenant_id: "string"
-     *             },
-     *             metadata: {
-     *                 event: "string",
-     *                 tags: [],
-     *                 utm: {
-     *                     source: undefined,
-     *                     medium: undefined,
-     *                     campaign: undefined,
-     *                     term: undefined,
-     *                     content: undefined
-     *                 },
-     *                 trace_id: "string"
-     *             },
-     *             preferences: {
-     *                 subscription_topic_id: "string"
-     *             },
-     *             providers: {
-     *                 "string": {
-     *                     override: undefined,
-     *                     if: undefined,
-     *                     timeouts: undefined,
-     *                     metadata: undefined
-     *                 }
-     *             },
-     *             routing: {
-     *                 method: Courier.RoutingMethod.All,
-     *                 channels: [{
-     *                         channel: "string",
-     *                         config: undefined,
-     *                         method: undefined,
-     *                         providers: undefined,
-     *                         if: undefined
+     *                         type: "text",
+     *                         channels: undefined,
+     *                         ref: undefined,
+     *                         if: undefined,
+     *                         loop: undefined,
+     *                         content: "content",
+     *                         align: "left",
+     *                         text_style: undefined,
+     *                         color: undefined,
+     *                         bold: undefined,
+     *                         italic: undefined,
+     *                         strikethrough: undefined,
+     *                         underline: undefined,
+     *                         locales: undefined,
+     *                         format: undefined
+     *                     }, {
+     *                         type: "text",
+     *                         channels: undefined,
+     *                         ref: undefined,
+     *                         if: undefined,
+     *                         loop: undefined,
+     *                         content: "content",
+     *                         align: "left",
+     *                         text_style: undefined,
+     *                         color: undefined,
+     *                         bold: undefined,
+     *                         italic: undefined,
+     *                         strikethrough: undefined,
+     *                         underline: undefined,
+     *                         locales: undefined,
+     *                         format: undefined
      *                     }]
-     *             },
-     *             timeout: {
-     *                 provider: {},
-     *                 channel: {},
-     *                 message: 1,
-     *                 escalation: 1,
-     *                 criteria: Courier.Criteria.NoEscalation
-     *             },
-     *             delay: {
-     *                 duration: 1,
-     *                 until: "string"
-     *             },
-     *             expiry: {
-     *                 expires_at: "string",
-     *                 expires_in: "string"
-     *             },
-     *             to: {
-     *                 audience_id: "string",
-     *                 data: {},
-     *                 filters: []
      *             }
      *         }
      *     })
      */
     send(request: Courier.SendMessageRequest, requestOptions?: CourierClient.IdempotentRequestOptions): Promise<Courier.SendMessageResponse>;
-    protected _audiences: Audiences | undefined;
-    get audiences(): Audiences;
-    protected _auditEvents: AuditEvents | undefined;
-    get auditEvents(): AuditEvents;
-    protected _authTokens: AuthTokens | undefined;
-    get authTokens(): AuthTokens;
-    protected _automations: Automations | undefined;
-    get automations(): Automations;
-    protected _brands: Brands | undefined;
-    get brands(): Brands;
-    protected _bulk: Bulk | undefined;
-    get bulk(): Bulk;
-    protected _inbound: Inbound | undefined;
-    get inbound(): Inbound;
-    protected _lists: Lists | undefined;
-    get lists(): Lists;
-    protected _messages: Messages | undefined;
-    get messages(): Messages;
-    protected _notifications: Notifications | undefined;
-    get notifications(): Notifications;
-    protected _profiles: Profiles | undefined;
-    get profiles(): Profiles;
-    protected _templates: Templates | undefined;
-    get templates(): Templates;
-    protected _tenants: Tenants | undefined;
-    get tenants(): Tenants;
-    protected _translations: Translations | undefined;
-    get translations(): Translations;
-    protected _users: Users | undefined;
-    get users(): Users;
     protected _getAuthorizationHeader(): Promise<string>;
 }

package/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) {
@@ -62,145 +72,6 @@ class CourierClient {
     constructor(_options = {}) {
         this._options = _options;
     }
-    /**
-     * Use the send API to send a message to one or more recipients.
-     *
-     * @param {Courier.SendMessageRequest} request
-     * @param {CourierClient.IdempotentRequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await courier.send({
-     *         message: {
-     *             content: {
-     *                 version: "string",
-     *                 brand: {
-     *                     "key": "value"
-     *                 },
-     *                 elements: [{
-     *                         type: "text"
-     *                     }]
-     *             },
-     *             data: {
-     *                 "string": {
-     *                     "key": "value"
-     *                 }
-     *             },
-     *             brand_id: "string",
-     *             channels: {
-     *                 "string": {
-     *                     brand_id: undefined,
-     *                     providers: undefined,
-     *                     routing_method: undefined,
-     *                     if: undefined,
-     *                     timeouts: undefined,
-     *                     override: undefined,
-     *                     metadata: undefined
-     *                 }
-     *             },
-     *             context: {
-     *                 tenant_id: "string"
-     *             },
-     *             metadata: {
-     *                 event: "string",
-     *                 tags: [],
-     *                 utm: {
-     *                     source: undefined,
-     *                     medium: undefined,
-     *                     campaign: undefined,
-     *                     term: undefined,
-     *                     content: undefined
-     *                 },
-     *                 trace_id: "string"
-     *             },
-     *             preferences: {
-     *                 subscription_topic_id: "string"
-     *             },
-     *             providers: {
-     *                 "string": {
-     *                     override: undefined,
-     *                     if: undefined,
-     *                     timeouts: undefined,
-     *                     metadata: undefined
-     *                 }
-     *             },
-     *             routing: {
-     *                 method: Courier.RoutingMethod.All,
-     *                 channels: [{
-     *                         channel: "string",
-     *                         config: undefined,
-     *                         method: undefined,
-     *                         providers: undefined,
-     *                         if: undefined
-     *                     }]
-     *             },
-     *             timeout: {
-     *                 provider: {},
-     *                 channel: {},
-     *                 message: 1,
-     *                 escalation: 1,
-     *                 criteria: Courier.Criteria.NoEscalation
-     *             },
-     *             delay: {
-     *                 duration: 1,
-     *                 until: "string"
-     *             },
-     *             expiry: {
-     *                 expires_at: "string",
-     *                 expires_in: "string"
-     *             },
-     *             to: {
-     *                 audience_id: "string",
-     *                 data: {},
-     *                 filters: []
-     *             }
-     *         }
-     *     })
-     */
-    send(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, "/send"),
-                method: "POST",
-                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,
-                    "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 : undefined,
-                },
-                contentType: "application/json",
-                body: request,
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
-            });
-            if (_response.ok) {
-                return _response.body;
-            }
-            if (_response.error.reason === "status-code") {
-                throw new errors.CourierError({
-                    statusCode: _response.error.statusCode,
-                    body: _response.error.body,
-                });
-            }
-            switch (_response.error.reason) {
-                case "non-json":
-                    throw new errors.CourierError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
-                    });
-                case "timeout":
-                    throw new errors.CourierTimeoutError();
-                case "unknown":
-                    throw new errors.CourierError({
-                        message: _response.error.errorMessage,
-                    });
-            }
-        });
-    }
     get audiences() {
         var _a;
         return ((_a = this._audiences) !== null && _a !== void 0 ? _a : (this._audiences = new Client_1.Audiences(this._options)));
@@ -261,13 +132,112 @@ class CourierClient {
         var _a;
         return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_15.Users(this._options)));
     }
+    /**
+     * Use the send API to send a message to one or more recipients.
+     *
+     * @param {Courier.SendMessageRequest} request
+     * @param {CourierClient.IdempotentRequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.send({
+     *         message: {
+     *             data: undefined,
+     *             brand_id: undefined,
+     *             channels: undefined,
+     *             context: undefined,
+     *             metadata: undefined,
+     *             preferences: undefined,
+     *             providers: undefined,
+     *             routing: undefined,
+     *             timeout: undefined,
+     *             delay: undefined,
+     *             expiry: undefined,
+     *             to: undefined,
+     *             content: {
+     *                 version: "version",
+     *                 brand: undefined,
+     *                 elements: [{
+     *                         type: "text",
+     *                         channels: undefined,
+     *                         ref: undefined,
+     *                         if: undefined,
+     *                         loop: undefined,
+     *                         content: "content",
+     *                         align: "left",
+     *                         text_style: undefined,
+     *                         color: undefined,
+     *                         bold: undefined,
+     *                         italic: undefined,
+     *                         strikethrough: undefined,
+     *                         underline: undefined,
+     *                         locales: undefined,
+     *                         format: undefined
+     *                     }, {
+     *                         type: "text",
+     *                         channels: undefined,
+     *                         ref: undefined,
+     *                         if: undefined,
+     *                         loop: undefined,
+     *                         content: "content",
+     *                         align: "left",
+     *                         text_style: undefined,
+     *                         color: undefined,
+     *                         bold: undefined,
+     *                         italic: undefined,
+     *                         strikethrough: undefined,
+     *                         underline: undefined,
+     *                         locales: undefined,
+     *                         format: undefined
+     *                     }]
+     *             }
+     *         }
+     *     })
+     */
+    send(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                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, "/send"),
+                method: "POST",
+                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, "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 : undefined }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                contentType: "application/json",
+                requestType: "json",
+                body: request,
+                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;
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.CourierError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.CourierError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling POST /send.");
+                case "unknown":
+                    throw new errors.CourierError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
     _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/api/client/requests/SendMessageRequest.d.ts

@@ -6,87 +6,54 @@ import * as Courier from "../../index";
  * @example
  *     {
  *         message: {
+ *             data: undefined,
+ *             brand_id: undefined,
+ *             channels: undefined,
+ *             context: undefined,
+ *             metadata: undefined,
+ *             preferences: undefined,
+ *             providers: undefined,
+ *             routing: undefined,
+ *             timeout: undefined,
+ *             delay: undefined,
+ *             expiry: undefined,
+ *             to: undefined,
  *             content: {
- *                 version: "string",
- *                 brand: {
- *                     "key": "value"
- *                 },
+ *                 version: "version",
+ *                 brand: undefined,
  *                 elements: [{
- *                         type: "text"
+ *                         type: "text",
+ *                         channels: undefined,
+ *                         ref: undefined,
+ *                         if: undefined,
+ *                         loop: undefined,
+ *                         content: "content",
+ *                         align: "left",
+ *                         text_style: undefined,
+ *                         color: undefined,
+ *                         bold: undefined,
+ *                         italic: undefined,
+ *                         strikethrough: undefined,
+ *                         underline: undefined,
+ *                         locales: undefined,
+ *                         format: undefined
+ *                     }, {
+ *                         type: "text",
+ *                         channels: undefined,
+ *                         ref: undefined,
+ *                         if: undefined,
+ *                         loop: undefined,
+ *                         content: "content",
+ *                         align: "left",
+ *                         text_style: undefined,
+ *                         color: undefined,
+ *                         bold: undefined,
+ *                         italic: undefined,
+ *                         strikethrough: undefined,
+ *                         underline: undefined,
+ *                         locales: undefined,
+ *                         format: undefined
  *                     }]
- *             },
- *             data: {
- *                 "string": {
- *                     "key": "value"
- *                 }
- *             },
- *             brand_id: "string",
- *             channels: {
- *                 "string": {
- *                     brand_id: undefined,
- *                     providers: undefined,
- *                     routing_method: undefined,
- *                     if: undefined,
- *                     timeouts: undefined,
- *                     override: undefined,
- *                     metadata: undefined
- *                 }
- *             },
- *             context: {
- *                 tenant_id: "string"
- *             },
- *             metadata: {
- *                 event: "string",
- *                 tags: [],
- *                 utm: {
- *                     source: undefined,
- *                     medium: undefined,
- *                     campaign: undefined,
- *                     term: undefined,
- *                     content: undefined
- *                 },
- *                 trace_id: "string"
- *             },
- *             preferences: {
- *                 subscription_topic_id: "string"
- *             },
- *             providers: {
- *                 "string": {
- *                     override: undefined,
- *                     if: undefined,
- *                     timeouts: undefined,
- *                     metadata: undefined
- *                 }
- *             },
- *             routing: {
- *                 method: Courier.RoutingMethod.All,
- *                 channels: [{
- *                         channel: "string",
- *                         config: undefined,
- *                         method: undefined,
- *                         providers: undefined,
- *                         if: undefined
- *                     }]
- *             },
- *             timeout: {
- *                 provider: {},
- *                 channel: {},
- *                 message: 1,
- *                 escalation: 1,
- *                 criteria: Courier.Criteria.NoEscalation
- *             },
- *             delay: {
- *                 duration: 1,
- *                 until: "string"
- *             },
- *             expiry: {
- *                 expires_at: "string",
- *                 expires_in: "string"
- *             },
- *             to: {
- *                 audience_id: "string",
- *                 data: {},
- *                 filters: []
  *             }
  *         }
  *     }