@trycourier/courier 6.1.1 → 6.1.3

package/api/resources/profiles/types/SubscribeToListsRequestListObject.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface SubscribeToListsRequestListObject {
     listId: string;
     preferences?: Courier.RecipientPreferences;

package/api/resources/profiles/types/UserProfile.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface UserProfile {
     address: Courier.Address;
     birthdate: string;

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface AudienceRecipient {
     /** A unique identifier associated with an Audience. A message will be sent to each user in the audience. */
     audience_id: string;

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface BaseMessage {
     /**
      * An arbitrary object that includes any data you want to pass to the message.

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface BaseMessageSendTo {
     /** The recipient or a list of recipients of the message */
     to?: Courier.MessageRecipient;

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface BrandSettingsEmail {
     templateOverride?: Courier.BrandTemplateOverride;
     head?: Courier.EmailHead;

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface BrandSettingsInApp {
     borderRadius?: string;
     disableMessageIcon?: boolean;

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface BrandSettingsSocialPresence {
     inheritDefault?: boolean;
     facebook?: Courier.BaseSocialPresence;

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface BrandTemplateOverride extends Courier.BrandTemplate {
     mjml: Courier.BrandTemplate;
     footerBackgroundColor?: string;

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface Channel {
     /**
      * Id of the brand that should be used for rendering the message.

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface ChannelMetadata {
     utm?: Courier.Utm;
 }

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

@@ -1,5 +1,5 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export declare type Content = Courier.ElementalContent | Courier.ElementalContentSugar;

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 /**
  * The message property has the following primary top-level properties. They define the destination and content of the message.
  * Additional advanced configuration fields [are defined below](https://www.courier.com/docs/reference/send/message/#other-message-properties).

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 /**
  * Allows the user to execute an action. Can be a button or a link.
  */

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 /**
  * The channel element allows a notification to be customized based on which channel it is sent through.
  * For example, you may want to display a detailed message when the notification is sent through email,

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface ElementalContent {
     /** For example, "2022-01-01" */
     version: string;

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 /**
  * Renders a dividing line between elements.
  */

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 /**
  * Allows you to group elements together. This can be useful when used in combination with "if" or "loop". See [control flow docs](https://www.courier.com/docs/platform/content/elemental/control-flow/) for more details.
  */

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 /**
  * Used to embed an image into the notification.
  */

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 /**
  * The meta element contains information describing the notification that may
  * be used by a particular channel or provider. One important field is the title

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export 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 declare namespace ElementalNode {
     interface Text extends Courier.ElementalTextNode {

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 /**
  * Renders a quote block.
  */

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 /**
  * Represents a body of text to be rendered inside of the notification.
  */

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface EmailHeader {
     inheritDefault?: boolean;
     barColor?: string;

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface Expiry {
     /** An epoch timestamp or ISO8601 timestamp with timezone `(YYYY-MM-DDThh:mm:ss.sTZD)` that describes the time in which a message expires. */
     expires_at?: string;

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

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

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface IProfilePreferences {
     categories?: Courier.IPreferences;
     notifications: Courier.IPreferences;

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface ListPatternRecipient extends Courier.ListPatternRecipientType {
     list_pattern?: string;
     data?: Courier.MessageData;

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface ListRecipient extends Courier.ListRecipientType {
     list_id?: string;
     data?: Courier.MessageData;

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

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

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

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

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface MessageChannelEmailOverride {
     attachments?: Courier.Attachment[];
     bcc?: string;

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

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

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface MessageMetadata {
     /** An arbitrary string to tracks the event that generated this request (e.g. 'signup'). */
     event?: string;

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

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

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface MessageProvidersType {
     /** Provider specific overrides. */
     override?: Record<string, any>;

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

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

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface Metadata {
     utm?: Courier.Utm;
 }

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface MsTeamsRecipient {
     ms_teams: Courier.MsTeams;
 }

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface Preference {
     status: Courier.PreferenceStatus;
     rules?: Courier.Rule[];

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

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

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 /**
  * Allows you to customize which channel(s) Courier will potentially deliver the message.
  * If no routing key is specified, Courier will use the default routing configuration or

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

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

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface RoutingStrategyChannel {
     channel: string;
     config?: Record<string, any>;

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface RoutingStrategyProvider {
     name: string;
     config?: Record<string, any>;

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface SlackRecipient {
     slack: Courier.Slack;
 }

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface TemplateMessage extends Courier.BaseMessage, Courier.BaseMessageSendTo {
     /**
      * The id of the notification template to be rendered and sent to the recipient(s).

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface Timeout {
     provider?: Record<string, number>;
     channel?: Record<string, number>;

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface UserRecipient extends Courier.UserRecipientType {
     /** Use `tenant_id` instad. */
     account_id?: string;

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

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export declare namespace Templates {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
@@ -20,6 +20,14 @@ export declare class Templates {
     constructor(_options?: Templates.Options);
     /**
      * Returns a list of notification templates
+     *
+     * @param {Courier.ListTemplatesRequest} request
+     * @param {Templates.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.templates.list({
+     *         cursor: "string"
+     *     })
      */
     list(request?: Courier.ListTemplatesRequest, requestOptions?: Templates.RequestOptions): Promise<Courier.ListTemplatesResponse>;
     protected _getAuthorizationHeader(): Promise<string>;

package/api/resources/templates/client/Client.js

@@ -42,13 +42,21 @@ exports.Templates = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
 const url_join_1 = __importDefault(require("url-join"));
-const errors = __importStar(require("../../../../errors"));
+const errors = __importStar(require("../../../../errors/index"));
 class Templates {
     constructor(_options = {}) {
         this._options = _options;
     }
     /**
      * Returns a list of notification templates
+     *
+     * @param {Courier.ListTemplatesRequest} request
+     * @param {Templates.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.templates.list({
+     *         cursor: "string"
+     *     })
      */
     list(request = {}, requestOptions) {
         var _a, _b;
@@ -65,7 +73,9 @@ class Templates {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.1",
+                    "X-Fern-SDK-Version": "v6.1.3",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -99,7 +109,7 @@ class Templates {
     _getAuthorizationHeader() {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const bearer = (_a = (yield core.Supplier.get(this._options.authorizationToken))) !== null && _a !== void 0 ? _a : process.env["COURIER_AUTH_TOKEN"];
+            const bearer = (_a = (yield core.Supplier.get(this._options.authorizationToken))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["COURIER_AUTH_TOKEN"];
             if (bearer == null) {
                 throw new errors.CourierError({
                     message: "Please specify COURIER_AUTH_TOKEN when instantiating the client.",

package/api/resources/templates/client/requests/ListTemplatesRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         cursor: "string"
+ *     }
+ */
 export interface ListTemplatesRequest {
     /**
      * A unique identifier that allows for fetching the next set of templates

package/api/resources/templates/client/requests/index.d.ts

@@ -1 +1 @@
-export { ListTemplatesRequest } from "./ListTemplatesRequest";
+export { type ListTemplatesRequest } from "./ListTemplatesRequest";

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface ListTemplatesResponse {
     paging: Courier.Paging;
     /** An array of Notification Templates */

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface NotificationTemplates {
     /** A UTC timestamp at which notification was created. This is stored as a millisecond representation of the Unix epoch (the time passed since January 1, 1970). */
     created_at: number;

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface RoutingStrategy {
     /** The method for selecting channels to send the message with. Value can be either 'single' or 'all'. If not provided will default to 'single' */
     method: Courier.RoutingStrategyMethod;

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface Tag {
     data: Courier.TagData[];
 }