@trycourier/courier 4.9.0 → 5.1.0

package/lib/client.js

@@ -37,7 +37,6 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.client = void 0;
-var accounts_1 = require("./accounts");
 var audiences_1 = require("./audiences");
 var audit_events_1 = require("./audit-events");
 var automations_1 = require("./automations");
@@ -48,6 +47,7 @@ var notifications_1 = require("./notifications");
 var preferences_1 = require("./preferences");
 var profile_1 = require("./profile");
 var send_1 = require("./send");
+var tenants_1 = require("./tenants");
 var token_management_1 = require("./token-management");
 var users_1 = require("./users");
 var cancelMessage = function (options) {
@@ -116,8 +116,8 @@ var getMessages = function (options) {
                             notification: params === null || params === void 0 ? void 0 : params.notificationId,
                             recipient: params === null || params === void 0 ? void 0 : params.recipientId,
                             status: params === null || params === void 0 ? void 0 : params.status,
-                            tags: params === null || params === void 0 ? void 0 : params.tags
-                        }
+                            tags: params === null || params === void 0 ? void 0 : params.tags,
+                        },
                     })];
                 case 1:
                     res = _a.sent();
@@ -128,7 +128,6 @@ var getMessages = function (options) {
 };
 exports.client = function (options) {
     return {
-        accounts: accounts_1.accounts(options),
         addRecipientToLists: profile_1.addRecipientToLists(options),
         audiences: audiences_1.audiences(options),
         auditEvents: audit_events_1.auditEvents(options),
@@ -154,7 +153,8 @@ exports.client = function (options) {
         replaceBrand: brands_1.replaceBrand(options),
         replaceProfile: profile_1.replaceProfile(options),
         send: send_1.send(options),
+        tenants: tenants_1.tenants(options),
         tokenManagement: token_management_1.tokenManagement(options),
-        users: users_1.users(options)
+        users: users_1.users(options),
     };
 };

package/lib/send/types.d.ts

@@ -164,6 +164,9 @@ interface ElementalBaseNode {
     if?: string;
     loop?: string;
 }
+export interface MessageContext {
+    tenant_id?: string;
+}
 export interface MessageData extends Record<string, any> {
 }
 export declare type RuleType = "snooze" | "channel_preferences" | "status";
@@ -240,12 +243,14 @@ export interface AudienceRecipient {
 }
 export interface UserRecipient extends UserRecipientType {
     account_id?: string;
+    context?: MessageContext;
     data?: MessageData;
     email?: string;
     locale?: string;
     user_id?: string;
     phone_number?: string;
     preferences?: IProfilePreferences;
+    tenant_id?: string;
 }
 export declare type Recipient = AudienceRecipient | ListRecipient | ListPatternRecipient | UserRecipient;
 export declare type MessageRecipient = Recipient | Recipient[];
@@ -268,6 +273,7 @@ export declare type Content = ElementalContentSugar | ElementalContent;
 export interface BaseMessage {
     brand_id?: string;
     channels?: MessageChannels;
+    context?: MessageContext;
     data?: MessageData;
     metadata?: MessageMetadata;
     providers?: MessageProviders;

package/lib/tenants/index.d.ts

@@ -0,0 +1,8 @@
+import { ICourierClientConfiguration } from "../types";
+import * as TenantTypes from "./types";
+export declare const tenants: (options: ICourierClientConfiguration) => {
+    delete: (tenantId: string) => Promise<void>;
+    get: (tenantId: string) => Promise<TenantTypes.ITenant>;
+    listTenants: (listOptions?: TenantTypes.ITenantListOptions | undefined) => Promise<TenantTypes.IPaginatedResult<TenantTypes.ITenant>>;
+    put: (tenant: Omit<TenantTypes.ITenant, "type">) => Promise<TenantTypes.ITenant>;
+};

package/lib/{accounts → tenants}/index.js

@@ -36,23 +36,23 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.accounts = void 0;
-var deleteAccount = function (options) { return function (accountId) { return __awaiter(void 0, void 0, void 0, function () {
+exports.tenants = void 0;
+var deleteTenant = function (options) { return function (tenantId) { return __awaiter(void 0, void 0, void 0, function () {
     return __generator(this, function (_a) {
         switch (_a.label) {
-            case 0: return [4 /*yield*/, options.httpClient.delete("/accounts/" + accountId)];
+            case 0: return [4 /*yield*/, options.httpClient.delete("/tenants/" + tenantId)];
             case 1:
                 _a.sent();
                 return [2 /*return*/];
         }
     });
 }); }; };
-var getAccount = function (options) {
-    return function (accountId) { return __awaiter(void 0, void 0, void 0, function () {
+var getTenant = function (options) {
+    return function (tenantId) { return __awaiter(void 0, void 0, void 0, function () {
         var response;
         return __generator(this, function (_a) {
             switch (_a.label) {
-                case 0: return [4 /*yield*/, options.httpClient.get("/accounts/" + accountId)];
+                case 0: return [4 /*yield*/, options.httpClient.get("/tenants/" + tenantId)];
                 case 1:
                     response = _a.sent();
                     return [2 /*return*/, response.data];
@@ -60,16 +60,16 @@ var getAccount = function (options) {
         });
     }); };
 };
-var listAccounts = function (options) {
+var listTenants = function (options) {
     return function (listOptions) { return __awaiter(void 0, void 0, void 0, function () {
         var response;
         return __generator(this, function (_a) {
             switch (_a.label) {
-                case 0: return [4 /*yield*/, options.httpClient.get("/accounts", undefined, {
+                case 0: return [4 /*yield*/, options.httpClient.get("/tenants", undefined, {
                         params: {
                             cursor: (listOptions === null || listOptions === void 0 ? void 0 : listOptions.cursor) || "",
-                            limit: (listOptions === null || listOptions === void 0 ? void 0 : listOptions.limit) || "20"
-                        }
+                            limit: (listOptions === null || listOptions === void 0 ? void 0 : listOptions.limit) || "20",
+                        },
                     })];
                 case 1:
                     response = _a.sent();
@@ -78,12 +78,12 @@ var listAccounts = function (options) {
         });
     }); };
 };
-var putAccount = function (options) {
-    return function (account) { return __awaiter(void 0, void 0, void 0, function () {
+var putTenant = function (options) {
+    return function (tenant) { return __awaiter(void 0, void 0, void 0, function () {
         var response;
         return __generator(this, function (_a) {
             switch (_a.label) {
-                case 0: return [4 /*yield*/, options.httpClient.put("/accounts/" + account.id, account)];
+                case 0: return [4 /*yield*/, options.httpClient.put("/tenants/" + tenant.id, tenant)];
                 case 1:
                     response = _a.sent();
                     return [2 /*return*/, response.data];
@@ -91,9 +91,9 @@ var putAccount = function (options) {
         });
     }); };
 };
-exports.accounts = function (options) { return ({
-    delete: deleteAccount(options),
-    get: getAccount(options),
-    listAccounts: listAccounts(options),
-    put: putAccount(options)
+exports.tenants = function (options) { return ({
+    delete: deleteTenant(options),
+    get: getTenant(options),
+    listTenants: listTenants(options),
+    put: putTenant(options),
 }); };

package/lib/{accounts → tenants}/types.d.ts

@@ -1,8 +1,8 @@
-export interface IAccount {
+export interface ITenant {
     brand_id?: string;
     id: string;
     name: string;
-    parent_account_id?: string;
+    parent_tenant_id?: string;
     default_preferences?: {
         items: Array<{
             id: string;
@@ -14,7 +14,7 @@ export interface IAccount {
         [key: string]: any;
     };
     user_profile?: Record<string, any>;
-    type: "account";
+    type: "tenant";
 }
 export interface IPaginatedResult<T> {
     cursor?: string;
@@ -24,13 +24,13 @@ export interface IPaginatedResult<T> {
     type: "list";
     url: string;
 }
-export interface IAccountListOptions {
+export interface ITenantListOptions {
     cursor?: string;
     limit?: string;
 }
-export interface ICourierClientAccounts {
+export interface ICourierClientTenants {
     delete: (id: string) => Promise<void>;
-    get: (id: string) => Promise<IAccount>;
-    listAccounts: (options?: IAccountListOptions) => Promise<IPaginatedResult<IAccount>>;
-    put: (account: Omit<IAccount, "type">) => Promise<IAccount>;
+    get: (id: string) => Promise<ITenant>;
+    listTenants: (options?: ITenantListOptions) => Promise<IPaginatedResult<ITenant>>;
+    put: (tenant: Omit<ITenant, "type">) => Promise<ITenant>;
 }

package/lib/types.d.ts

@@ -1,4 +1,3 @@
-import { ICourierClientAccounts } from "./accounts/types";
 import { ICourierClientAudiences } from "./audiences/types";
 import { auditEvents } from "./audit-events";
 import { ICourierClientAutomations } from "./automations/types";
@@ -7,6 +6,7 @@ import { ICourierClientLists, ICourierList, ICourierRecipientSubscriptionsRespon
 import { ICourierClientNotifications } from "./notifications/types";
 import { ICourierClientPreferences, IRecipientPreferences } from "./preferences/types";
 import { Message } from "./send/types";
+import { ICourierClientTenants } from "./tenants/types";
 import { tokenManagement } from "./token-management";
 import { users } from "./users";
 export interface IInitHttpClientOptions {
@@ -319,7 +319,7 @@ export interface ICourierBrandGetAllResponse {
 export declare type SendResponse<T extends ICourierSendParameters | ICourierSendMessageParameters> = T extends ICourierSendParameters ? ICourierSendResponse : ICourierSendMessageResponse;
 export interface ICourierClient {
     addRecipientToLists: (params: ICourierProfileListsPostParameters) => Promise<ICourierProfilePostResponse>;
-    accounts: ICourierClientAccounts;
+    tenants: ICourierClientTenants;
     audiences: ICourierClientAudiences;
     auditEvents: ReturnType<typeof auditEvents>;
     automations: ICourierClientAutomations;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trycourier/courier",
-  "version": "4.9.0",
+  "version": "5.1.0",
   "description": "A node.js module for communicating with the Courier REST API.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package/lib/accounts/index.d.ts

@@ -1,8 +0,0 @@
-import { ICourierClientConfiguration } from "../types";
-import * as AccountTypes from "./types";
-export declare const accounts: (options: ICourierClientConfiguration) => {
-    delete: (accountId: string) => Promise<void>;
-    get: (accountId: string) => Promise<AccountTypes.IAccount>;
-    listAccounts: (listOptions?: AccountTypes.IAccountListOptions | undefined) => Promise<AccountTypes.IPaginatedResult<AccountTypes.IAccount>>;
-    put: (account: Omit<AccountTypes.IAccount, "type">) => Promise<AccountTypes.IAccount>;
-};