@trycourier/courier 6.3.1 → 6.4.0

package/api/resources/send/types/ElementalNode.d.ts

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Courier from "../../../index";
-export declare type ElementalNode = Courier.ElementalNode.Text | Courier.ElementalNode.Meta | Courier.ElementalNode.Channel | Courier.ElementalNode.Image | Courier.ElementalNode.Action | Courier.ElementalNode.Divider | Courier.ElementalNode.Group | Courier.ElementalNode.Quote;
+export type ElementalNode = Courier.ElementalNode.Text | Courier.ElementalNode.Meta | Courier.ElementalNode.Channel | Courier.ElementalNode.Image | Courier.ElementalNode.Action | Courier.ElementalNode.Divider | Courier.ElementalNode.Group | Courier.ElementalNode.Quote;
 export declare namespace ElementalNode {
     interface Text extends Courier.ElementalTextNode {
         type: "text";

package/api/resources/send/types/ExpiresInType.d.ts

@@ -1,4 +1,4 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type ExpiresInType = string | number;
+export type ExpiresInType = string | number;

package/api/resources/send/types/IActionButtonStyle.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type IActionButtonStyle = "button" | "link";
+export type IActionButtonStyle = "button" | "link";
 export declare const IActionButtonStyle: {
     readonly Button: "button";
     readonly Link: "link";

package/api/resources/send/types/IAlignment.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type IAlignment = "center" | "left" | "right" | "full";
+export type IAlignment = "center" | "left" | "right" | "full";
 export declare const IAlignment: {
     readonly Center: "center";
     readonly Left: "left";

package/api/resources/send/types/IPreferences.d.ts

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Courier from "../../../index";
-export declare type IPreferences = Record<string, Courier.Preference>;
+export type IPreferences = Record<string, Courier.Preference>;

package/api/resources/send/types/InAppPlacement.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type InAppPlacement = "top" | "bottom" | "left" | "right";
+export type InAppPlacement = "top" | "bottom" | "left" | "right";
 export declare const InAppPlacement: {
     readonly Top: "top";
     readonly Bottom: "bottom";

package/api/resources/send/types/Locales.d.ts

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Courier from "../../../index";
-export declare type Locales = Record<string, Courier.Locale> | undefined;
+export type Locales = Record<string, Courier.Locale> | undefined;

package/api/resources/send/types/Message.d.ts

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Courier from "../../../index";
-export declare type Message = 
+export type Message = 
 /**
  * Describes the content of the message in a way that will work for email, push, chat, or any channel. */
 Courier.ContentMessage

package/api/resources/send/types/MessageChannels.d.ts

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Courier from "../../../index";
-export declare type MessageChannels = Record<string, Courier.Channel>;
+export type MessageChannels = Record<string, Courier.Channel>;

package/api/resources/send/types/MessageData.d.ts

@@ -1,4 +1,4 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type MessageData = Record<string, any>;
+export type MessageData = Record<string, any>;

package/api/resources/send/types/MessageProviders.d.ts

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Courier from "../../../index";
-export declare type MessageProviders = Record<string, Courier.MessageProvidersType>;
+export type MessageProviders = Record<string, Courier.MessageProvidersType>;

package/api/resources/send/types/MessageRecipient.d.ts

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Courier from "../../../index";
-export declare type MessageRecipient = Courier.Recipient | Courier.Recipient[];
+export type MessageRecipient = Courier.Recipient | Courier.Recipient[];

package/api/resources/send/types/Recipient.d.ts

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Courier from "../../../index";
-export declare type Recipient = Courier.AudienceRecipient | Courier.ListRecipient | Courier.ListPatternRecipient | Courier.UserRecipient | Courier.SlackRecipient | Courier.MsTeamsRecipient | Courier.RecipientData | Courier.PagerdutyRecipient | Courier.WebhookRecipient;
+export type Recipient = Courier.AudienceRecipient | Courier.ListRecipient | Courier.ListPatternRecipient | Courier.UserRecipient | Courier.SlackRecipient | Courier.MsTeamsRecipient | Courier.RecipientData | Courier.PagerdutyRecipient | Courier.WebhookRecipient;

package/api/resources/send/types/RecipientData.d.ts

@@ -1,4 +1,4 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type RecipientData = Record<string, any>;
+export type RecipientData = Record<string, any>;

package/api/resources/send/types/RoutingChannel.d.ts

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Courier from "../../../index";
-export declare type RoutingChannel = Courier.RoutingStrategyChannel | Courier.RoutingStrategyProvider | string;
+export type RoutingChannel = Courier.RoutingStrategyChannel | Courier.RoutingStrategyProvider | string;

package/api/resources/send/types/RoutingMethod.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type RoutingMethod = "all" | "single";
+export type RoutingMethod = "all" | "single";
 export declare const RoutingMethod: {
     readonly All: "all";
     readonly Single: "single";

package/api/resources/send/types/RuleType.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type RuleType = "snooze" | "channel_preferences" | "status";
+export type RuleType = "snooze" | "channel_preferences" | "status";
 export declare const RuleType: {
     readonly Snooze: "snooze";
     readonly ChannelPreferences: "channel_preferences";

package/api/resources/send/types/TextAlign.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type TextAlign = "left" | "center" | "right";
+export type TextAlign = "left" | "center" | "right";
 export declare const TextAlign: {
     readonly Left: "left";
     readonly Center: "center";

package/api/resources/send/types/TextStyle.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type TextStyle = "text" | "h1" | "h2" | "subtext";
+export type TextStyle = "text" | "h1" | "h2" | "subtext";
 export declare const TextStyle: {
     readonly Text: "text";
     readonly H1: "h1";

package/api/resources/templates/client/Client.d.ts

@@ -7,12 +7,20 @@ import * as Courier from "../../../index";
 export declare namespace Templates {
     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 Templates {
@@ -25,9 +33,7 @@ export declare class Templates {
      * @param {Templates.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.templates.list({
-     *         cursor: "string"
-     *     })
+     *     await client.templates.list()
      */
     list(request?: Courier.ListTemplatesRequest, requestOptions?: Templates.RequestOptions): Promise<Courier.ListTemplatesResponse>;
     protected _getAuthorizationHeader(): Promise<string>;

package/api/resources/templates/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) {
@@ -54,33 +64,26 @@ class Templates {
      * @param {Templates.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.templates.list({
-     *         cursor: "string"
-     *     })
+     *     await client.templates.list()
      */
-    list(request = {}, requestOptions) {
-        var _a, _b;
-        return __awaiter(this, void 0, void 0, function* () {
+    list() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c;
             const { cursor } = request;
             const _queryParams = {};
             if (cursor != null) {
                 _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, "/notifications"),
+                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, "/notifications"),
                 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;
@@ -98,7 +101,7 @@ class Templates {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling GET /notifications.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -107,12 +110,12 @@ class Templates {
         });
     }
     _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/resources/templates/client/requests/ListTemplatesRequest.d.ts

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

package/api/resources/templates/types/ChannelIdentifier.d.ts

@@ -1,4 +1,4 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type ChannelIdentifier = string;
+export type ChannelIdentifier = string;

package/api/resources/templates/types/RoutingStrategyMethod.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type RoutingStrategyMethod = "all" | "single";
+export type RoutingStrategyMethod = "all" | "single";
 export declare const RoutingStrategyMethod: {
     readonly All: "all";
     readonly Single: "single";

package/api/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 {
@@ -26,28 +34,13 @@ export declare class Tenants {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.tenants.createOrReplace("string", {
-     *         name: "string",
-     *         parent_tenant_id: "string",
-     *         default_preferences: {
-     *             items: [{
-     *                     id: "string",
-     *                     status: Courier.SubscriptionTopicStatus.OptedOut,
-     *                     has_custom_routing: undefined,
-     *                     custom_routing: undefined
-     *                 }]
-     *         },
-     *         properties: {
-     *             "string": {
-     *                 "key": "value"
-     *             }
-     *         },
-     *         user_profile: {
-     *             "string": {
-     *                 "key": "value"
-     *             }
-     *         },
-     *         brand_id: "string"
+     *     await client.tenants.createOrReplace("tenant_id", {
+     *         name: "name",
+     *         parent_tenant_id: undefined,
+     *         default_preferences: undefined,
+     *         properties: undefined,
+     *         user_profile: undefined,
+     *         brand_id: undefined
      *     })
      */
     createOrReplace(tenantId: string, request: Courier.TenantCreateOrReplaceParams, requestOptions?: Tenants.RequestOptions): Promise<Courier.Tenant>;
@@ -58,7 +51,7 @@ export declare class Tenants {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.tenants.get("string")
+     *     await client.tenants.get("tenant_id")
      */
     get(tenantId: string, requestOptions?: Tenants.RequestOptions): Promise<Courier.Tenant>;
     /**
@@ -66,11 +59,7 @@ export declare class Tenants {
      * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.tenants.list({
-     *         parent_tenant_id: "string",
-     *         limit: 1,
-     *         cursor: "string"
-     *     })
+     *     await client.tenants.list()
      */
     list(request?: Courier.ListTenantParams, requestOptions?: Tenants.RequestOptions): Promise<Courier.TenantListResponse>;
     /**
@@ -78,7 +67,7 @@ export declare class Tenants {
      * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.tenants.delete("string")
+     *     await client.tenants.delete("tenant_id")
      */
     delete(tenantId: string, requestOptions?: Tenants.RequestOptions): Promise<void>;
     /**
@@ -89,10 +78,7 @@ export declare class Tenants {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.tenants.getUsersByTenant("string", {
-     *         limit: 1,
-     *         cursor: "string"
-     *     })
+     *     await client.tenants.getUsersByTenant("tenant_id")
      */
     getUsersByTenant(tenantId: string, request?: Courier.ListUsersForTenantParams, requestOptions?: Tenants.RequestOptions): Promise<Courier.ListUsersForTenantResponse>;
     /**
@@ -102,10 +88,10 @@ export declare class Tenants {
      * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.tenants.createOrReplaceDefaultPreferencesForTopic("tenantABC", "HB529N49MD4D5PMX9WR5P4JH78NA", {
-     *         status: Courier.SubscriptionTopicStatus.OptedIn,
+     *     await client.tenants.createOrReplaceDefaultPreferencesForTopic("tenantABC", "HB529N49MD4D5PMX9WR5P4JH78NA", {
+     *         status: "OPTED_IN",
      *         has_custom_routing: true,
-     *         custom_routing: [Courier.ChannelClassification.Inbox]
+     *         custom_routing: ["inbox"]
      *     })
      */
     createOrReplaceDefaultPreferencesForTopic(tenantId: string, topicId: string, request: Courier.SubscriptionTopicNew, requestOptions?: Tenants.RequestOptions): Promise<void>;
@@ -115,7 +101,7 @@ export declare class Tenants {
      * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.tenants.removeDefaultPreferencesForTopic("string", "string")
+     *     await client.tenants.removeDefaultPreferencesForTopic("tenant_id", "topic_id")
      */
     removeDefaultPreferencesForTopic(tenantId: string, topicId: string, requestOptions?: Tenants.RequestOptions): Promise<void>;
     protected _getAuthorizationHeader(): Promise<string>;