@trycourier/courier 6.3.1 → 6.4.1

package/dist/api/resources/profiles/client/requests/MergeProfileRequest.d.ts

@@ -5,7 +5,7 @@
  * @example
  *     {
  *         profile: {
- *             "string": {
+ *             "profile": {
  *                 "key": "value"
  *             }
  *         }

package/dist/api/resources/profiles/client/requests/ReplaceProfileRequest.d.ts

@@ -5,7 +5,7 @@
  * @example
  *     {
  *         profile: {
- *             "string": {
+ *             "profile": {
  *                 "key": "value"
  *             }
  *         }

package/dist/api/resources/profiles/types/DeviceType.d.ts

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

package/dist/api/resources/profiles/types/Discord.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 Discord = Courier.SendToChannel | Courier.SendDirectMessage;
+export type Discord = Courier.SendToChannel | Courier.SendDirectMessage;

package/dist/api/resources/profiles/types/Expo.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 Expo = Courier.Token | Courier.MultipleTokens;
+export type Expo = Courier.Token | Courier.MultipleTokens;

package/dist/api/resources/profiles/types/MsTeams.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 MsTeams = Courier.SendToMsTeamsUserId | Courier.SendToMsTeamsEmail | Courier.SendToMsTeamsChannelId | Courier.SendToMsTeamsConversationId | Courier.SendToMsTeamsChannelName;
+export type MsTeams = Courier.SendToMsTeamsUserId | Courier.SendToMsTeamsEmail | Courier.SendToMsTeamsChannelId | Courier.SendToMsTeamsConversationId | Courier.SendToMsTeamsChannelName;

package/dist/api/resources/profiles/types/ProfileUpdateRequest.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../../index";
+export interface ProfileUpdateRequest {
+    /** List of patch operations to apply to the profile. */
+    patch: Courier.UserProfilePatch[];
+}

package/dist/api/resources/profiles/types/ProfileUpdateRequest.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/profiles/types/Slack.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 Slack = Courier.SendToSlackChannel | Courier.SendToSlackEmail | Courier.SendToSlackUserId;
+export type Slack = Courier.SendToSlackChannel | Courier.SendToSlackEmail | Courier.SendToSlackUserId;

package/dist/api/resources/profiles/types/SnoozeRuleType.d.ts

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

package/dist/api/resources/profiles/types/UserProfileFirebaseToken.d.ts

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

package/dist/api/resources/profiles/types/WebhookAuthMode.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type WebhookAuthMode = "none" | "basic" | "bearer";
+export type WebhookAuthMode = "none" | "basic" | "bearer";
 export declare const WebhookAuthMode: {
     readonly None: "none";
     readonly Basic: "basic";

package/dist/api/resources/profiles/types/WebhookMethod.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type WebhookMethod = "POST" | "PUT";
+export type WebhookMethod = "POST" | "PUT";
 export declare const WebhookMethod: {
     readonly Post: "POST";
     readonly Put: "PUT";

package/dist/api/resources/profiles/types/WebhookProfileType.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type WebhookProfileType = "limited" | "expanded";
+export type WebhookProfileType = "limited" | "expanded";
 export declare const WebhookProfileType: {
     readonly Limited: "limited";
     readonly Expanded: "expanded";

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

@@ -42,4 +42,5 @@ export * from "./WebhookMethod";
 export * from "./WebhookAuthentication";
 export * from "./WebhookAuthMode";
 export * from "./WebhookProfileType";
+export * from "./ProfileUpdateRequest";
 export * from "./UserProfilePatch";

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

@@ -58,4 +58,5 @@ __exportStar(require("./WebhookMethod"), exports);
 __exportStar(require("./WebhookAuthentication"), exports);
 __exportStar(require("./WebhookAuthMode"), exports);
 __exportStar(require("./WebhookProfileType"), exports);
+__exportStar(require("./ProfileUpdateRequest"), exports);
 __exportStar(require("./UserProfilePatch"), exports);

package/dist/api/resources/send/types/Attachment.d.ts

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

package/dist/api/resources/send/types/ChannelSource.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type ChannelSource = "subscription" | "list" | "recipient";
+export type ChannelSource = "subscription" | "list" | "recipient";
 export declare const ChannelSource: {
     readonly Subscription: "subscription";
     readonly List: "list";

package/dist/api/resources/send/types/Content.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 Content = Courier.ElementalContent | Courier.ElementalContentSugar;
+export type Content = Courier.ElementalContent | Courier.ElementalContentSugar;

package/dist/api/resources/send/types/Criteria.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type Criteria = "no-escalation" | "delivered" | "viewed" | "engaged";
+export type Criteria = "no-escalation" | "delivered" | "viewed" | "engaged";
 export declare const Criteria: {
     readonly NoEscalation: "no-escalation";
     readonly Delivered: "delivered";

package/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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,10 +33,9 @@ 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>;
+    list(request?: Courier.ListTemplatesRequest, requestOptions?: Templates.RequestOptions): core.HttpResponsePromise<Courier.ListTemplatesResponse>;
+    private __list;
     protected _getAuthorizationHeader(): Promise<string>;
 }

package/dist/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,41 +64,38 @@ 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* () {
+        return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions));
+    }
+    __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.1", "User-Agent": "@trycourier/courier/6.4.1", "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;
+                return { data: _response.body, rawResponse: _response.rawResponse };
             }
             if (_response.error.reason === "status-code") {
                 throw new errors.CourierError({
                     statusCode: _response.error.statusCode,
                     body: _response.error.body,
+                    rawResponse: _response.rawResponse,
                 });
             }
             switch (_response.error.reason) {
@@ -96,23 +103,25 @@ class Templates {
                     throw new errors.CourierError({
                         statusCode: _response.error.statusCode,
                         body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
                     });
                 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,
+                        rawResponse: _response.rawResponse,
                     });
             }
         });
     }
     _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/templates/client/requests/ListTemplatesRequest.d.ts

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

package/dist/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/dist/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";