@trycourier/courier 6.0.8 → 6.1.1

package/dist/api/resources/translations/client/Client.js

@@ -62,7 +62,7 @@ class Translations {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.0.8",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -111,7 +111,7 @@ class Translations {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.0.8",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 body: request,

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

@@ -31,6 +31,15 @@ export declare class Preferences {
     /**
      * Update or Create user preferences for a specific subscription topic.
      * @throws {@link Courier.BadRequestError}
+     *
+     * @example
+     *     await courier.users.preferences.update("abc-123", "74Q4QGFBEX481DP6JRPMV751H4XT", {
+     *         topic: {
+     *             status: Courier.PreferenceStatus.OptedIn,
+     *             has_custom_routing: true,
+     *             custom_routing: [Courier.ChannelClassification.Inbox, Courier.ChannelClassification.Email]
+     *         }
+     *     })
      */
     update(userId: string, topicId: string, request: Courier.users.UserPreferencesUpdateParams, requestOptions?: Preferences.RequestOptions): Promise<Courier.users.UserPreferencesUpdateResponse>;
     protected _getAuthorizationHeader(): Promise<string>;

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

@@ -62,7 +62,7 @@ class Preferences {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.0.8",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -111,7 +111,7 @@ class Preferences {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.0.8",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -149,6 +149,15 @@ class Preferences {
     /**
      * Update or Create user preferences for a specific subscription topic.
      * @throws {@link Courier.BadRequestError}
+     *
+     * @example
+     *     await courier.users.preferences.update("abc-123", "74Q4QGFBEX481DP6JRPMV751H4XT", {
+     *         topic: {
+     *             status: Courier.PreferenceStatus.OptedIn,
+     *             has_custom_routing: true,
+     *             custom_routing: [Courier.ChannelClassification.Inbox, Courier.ChannelClassification.Email]
+     *         }
+     *     })
      */
     update(userId, topicId, request, requestOptions) {
         var _a, _b;
@@ -160,7 +169,7 @@ class Preferences {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.0.8",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 body: request,

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

@@ -2,10 +2,16 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Courier from "../../../../../..";
+/**
+ * @example
+ *     {
+ *         topic: {
+ *             status: Courier.PreferenceStatus.OptedIn,
+ *             has_custom_routing: true,
+ *             custom_routing: [Courier.ChannelClassification.Inbox, Courier.ChannelClassification.Email]
+ *         }
+ *     }
+ */
 export interface UserPreferencesUpdateParams {
-    status: Courier.PreferenceStatus;
-    /** The Channels a user has chosen to receive notifications through for this topic */
-    custom_routing?: Courier.ChannelClassification[];
-    default_status: Courier.PreferenceStatus;
-    has_custom_routing?: boolean;
+    topic: Courier.users.TopicPreferenceUpdate;
 }

package/dist/api/resources/users/resources/preferences/types/TopicPreferenceUpdate.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../../../..";
+export interface TopicPreferenceUpdate {
+    status: Courier.PreferenceStatus;
+    /** The Channels a user has chosen to receive notifications through for this topic */
+    custom_routing?: Courier.ChannelClassification[];
+    has_custom_routing?: boolean;
+}

package/dist/api/resources/users/resources/preferences/types/TopicPreferenceUpdate.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/users/resources/preferences/types/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./UserPreferencesListResponse";
 export * from "./UserPreferencesGetResponse";
 export * from "./TopicPreference";
+export * from "./TopicPreferenceUpdate";
 export * from "./UserPreferencesUpdateResponse";

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

@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./UserPreferencesListResponse"), exports);
 __exportStar(require("./UserPreferencesGetResponse"), exports);
 __exportStar(require("./TopicPreference"), exports);
+__exportStar(require("./TopicPreferenceUpdate"), exports);
 __exportStar(require("./UserPreferencesUpdateResponse"), exports);

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

@@ -64,7 +64,7 @@ class Tenants {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.0.8",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 body: request,
@@ -112,7 +112,7 @@ class Tenants {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.0.8",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 body: request,
@@ -156,7 +156,7 @@ class Tenants {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.0.8",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -199,7 +199,7 @@ class Tenants {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.0.8",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -235,13 +235,13 @@ class Tenants {
     list(userId, request = {}, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
-            const { limit, starting_after: startingAfter } = request;
+            const { limit, cursor } = request;
             const _queryParams = {};
             if (limit != null) {
                 _queryParams["limit"] = limit.toString();
             }
-            if (startingAfter != null) {
-                _queryParams["starting_after"] = startingAfter.toString();
+            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, `users/${userId}/tenants`),
@@ -250,7 +250,7 @@ class Tenants {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.0.8",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,

package/dist/api/resources/users/resources/tenants/client/requests/ListTenantsForUserParams.d.ts

@@ -8,7 +8,7 @@ export interface ListTenantsForUserParams {
      */
     limit?: number;
     /**
-     * Value of next_page from previous response
+     * Continue the pagination with the next cursor
      */
-    starting_after?: number;
+    cursor?: string;
 }

package/dist/api/resources/users/resources/tenants/types/ListTenantsForUserResponse.d.ts

@@ -3,7 +3,7 @@
  */
 import * as Courier from "../../../../..";
 export interface ListTenantsForUserResponse {
-    items?: Courier.UserTenantAssociation;
+    items?: Courier.UserTenantAssociation[];
     /** Set to true when there are more pages that can be retrieved. */
     has_more: boolean;
     /** A url that may be used to generate these results. */

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

@@ -62,7 +62,7 @@ class Tokens {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.0.8",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -111,7 +111,7 @@ class Tokens {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.0.8",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 body: request,
@@ -161,7 +161,7 @@ class Tokens {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.0.8",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 body: request,
@@ -211,7 +211,7 @@ class Tokens {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.0.8",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -260,7 +260,7 @@ class Tokens {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.0.8",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/dist/core/fetcher/Fetcher.js

@@ -15,9 +15,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetcher = void 0;
 const form_data_1 = __importDefault(require("form-data"));
 const qs_1 = __importDefault(require("qs"));
-if (typeof window === "undefined") {
-    global.fetch = require("node-fetch");
-}
 const INITIAL_RETRY_DELAY = 1;
 const MAX_RETRY_DELAY = 60;
 const DEFAULT_MAX_RETRIES = 2;
@@ -46,18 +43,19 @@ function fetcherImpl(args) {
         else {
             body = JSON.stringify(args.body);
         }
+        const fetchFn = typeof fetch == "function" ? fetch : require("node-fetch");
         const makeRequest = () => __awaiter(this, void 0, void 0, function* () {
             const controller = new AbortController();
             let abortId = undefined;
             if (args.timeoutMs != null) {
                 abortId = setTimeout(() => controller.abort(), args.timeoutMs);
             }
-            const response = yield fetch(url, {
+            const response = yield fetchFn(url, {
                 method: args.method,
                 headers,
                 body,
                 signal: controller.signal,
-                credentials: args.withCredentials ? "same-origin" : undefined,
+                credentials: args.withCredentials ? "include" : undefined,
             });
             if (abortId != null) {
                 clearTimeout(abortId);

package/jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+    preset: "ts-jest",
+    testEnvironment: "node",
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@trycourier/courier",
-    "version": "v6.0.8",
+    "version": "v6.1.1",
     "private": false,
     "repository": "https://github.com/trycourier/courier-node",
     "main": "./index.js",
@@ -8,7 +8,8 @@
     "scripts": {
         "format": "prettier --write 'src/**/*.ts'",
         "build": "tsc",
-        "prepack": "cp -rv dist/. ."
+        "prepack": "cp -rv dist/. .",
+        "test": "jest"
     },
     "dependencies": {
         "url-join": "4.0.1",
@@ -21,6 +22,9 @@
         "@types/url-join": "4.0.1",
         "@types/qs": "6.9.8",
         "@types/node-fetch": "2.6.9",
+        "jest": "^29.7.0",
+        "@types/jest": "^29.5.5",
+        "ts-jest": "^29.1.1",
         "@types/node": "17.0.33",
         "prettier": "2.7.1",
         "typescript": "4.6.4"

package/tests/client.test.ts

@@ -0,0 +1,11 @@
+/**
+* This is a test file for the SDK.
+* 
+* Add any tests here and make sure to mark this file
+* in `.fernignore`. 
+*/
+describe("test", () => {
+    it("default", () => {
+        expect(true).toBe(true);
+    });
+});

package/api/resources/automations/types/AutomationStepAction.d.ts

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export declare type AutomationStepAction = "cancel" | "delay" | "invoke" | "send" | "send-list" | "update-profile";
-export declare const AutomationStepAction: {
-    readonly Cancel: "cancel";
-    readonly Delay: "delay";
-    readonly Invoke: "invoke";
-    readonly Send: "send";
-    readonly SendList: "send-list";
-    readonly UpdateProfile: "update-profile";
-};

package/api/resources/automations/types/AutomationStepAction.js

@@ -1,14 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AutomationStepAction = void 0;
-exports.AutomationStepAction = {
-    Cancel: "cancel",
-    Delay: "delay",
-    Invoke: "invoke",
-    Send: "send",
-    SendList: "send-list",
-    UpdateProfile: "update-profile",
-};

package/api/resources/lists/client/requests/GetListRequest.d.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface GetListRequest {
-    /**
-     * A unique identifier that allows for fetching the next page of lists.
-     */
-    cursor?: string;
-    /**
-     * "A pattern used to filter the list items returned. Pattern types supported: exact match on `list_id` or a pattern of one or more pattern parts. you may replace a part with either: `*` to match all parts in that position, or `**` to signify a wildcard `endsWith` pattern match."
-     */
-    pattern?: string;
-}

package/api/resources/lists/types/ListFindByRecipientIdResponse.d.ts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../..";
-export interface ListFindByRecipientIdResponse {
-    paging: Courier.Paging;
-    results: Courier.List[];
-}

package/api/resources/lists/types/ListGetAllParams.d.ts

@@ -1,7 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface ListGetAllParams {
-    cursor?: string;
-    pattern?: string;
-}

package/api/resources/lists/types/RecipientSubscriptionsResponse.d.ts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../..";
-export interface RecipientSubscriptionsResponse {
-    paging: Courier.Paging;
-    results: Courier.List[];
-}

package/dist/api/resources/automations/types/AutomationStepAction.d.ts

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export declare type AutomationStepAction = "cancel" | "delay" | "invoke" | "send" | "send-list" | "update-profile";
-export declare const AutomationStepAction: {
-    readonly Cancel: "cancel";
-    readonly Delay: "delay";
-    readonly Invoke: "invoke";
-    readonly Send: "send";
-    readonly SendList: "send-list";
-    readonly UpdateProfile: "update-profile";
-};

package/dist/api/resources/automations/types/AutomationStepAction.js

@@ -1,14 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AutomationStepAction = void 0;
-exports.AutomationStepAction = {
-    Cancel: "cancel",
-    Delay: "delay",
-    Invoke: "invoke",
-    Send: "send",
-    SendList: "send-list",
-    UpdateProfile: "update-profile",
-};

package/dist/api/resources/lists/client/requests/GetListRequest.d.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface GetListRequest {
-    /**
-     * A unique identifier that allows for fetching the next page of lists.
-     */
-    cursor?: string;
-    /**
-     * "A pattern used to filter the list items returned. Pattern types supported: exact match on `list_id` or a pattern of one or more pattern parts. you may replace a part with either: `*` to match all parts in that position, or `**` to signify a wildcard `endsWith` pattern match."
-     */
-    pattern?: string;
-}

package/dist/api/resources/lists/types/ListFindByRecipientIdResponse.d.ts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../..";
-export interface ListFindByRecipientIdResponse {
-    paging: Courier.Paging;
-    results: Courier.List[];
-}

package/dist/api/resources/lists/types/ListGetAllParams.d.ts

@@ -1,7 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface ListGetAllParams {
-    cursor?: string;
-    pattern?: string;
-}

package/dist/api/resources/lists/types/RecipientSubscriptionsResponse.d.ts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../..";
-export interface RecipientSubscriptionsResponse {
-    paging: Courier.Paging;
-    results: Courier.List[];
-}