@trycourier/courier 4.2.0 → 4.4.0

package/README.md

@@ -25,7 +25,7 @@ v4 uses native fetch client to make requests or falls back to a polyfill if the
 ## Getting Started
 
 ```javascript
-import { CourierClient } from "@trycourier/courier";
+const { CourierClient } = require("@trycourier/courier");
 
 const courier = CourierClient({ authorizationToken: "<AUTH_TOKEN>" }); // get from the Courier UI
 
@@ -223,8 +223,7 @@ If you need to use a base url other than the default https://api.courier.com, yo
 ## Advanced Usage
 
 ```javascript
-import { CourierClient } from "@trycourier/courier";
-// const { CourierClient } = require("@trycourier/courier");
+const { CourierClient } = require("@trycourier/courier");
 
 const courier = CourierClient({ authorizationToken: "<AUTH_TOKEN>" });
 
@@ -691,7 +690,10 @@ All network related promise rejections are not handled in any way. All successfu
 
 ```javascript
 // Error handling example
-import { CourierClient, CourierHttpClientError } from "@trycourier/courier";
+const {
+  CourierClient,
+  CourierHttpClientError,
+} = require("@trycourier/courier");
 
 const courier = CourierClient();
 
@@ -715,7 +717,7 @@ try {
 For `POST` methods, you can supply an `idempotencyKey` in the config parameter to ensure the idempotency of the API Call. We recommend that you use a `V4 UUID` for the key. Keys are eligible to be removed from the system after they're at least 24 hours old, and a new request is generated if a key is reused after the original has been removed. For more info, see [Idempotent Requests](https://docs.courier.com/reference/idempotent-requests) in the Courier documentation.
 
 ```javascript
-import { CourierClient } from "@trycourier/courier";
+const { CourierClient } = require("@trycourier/courier");
 import uuid4 from "uuid4";
 
 const courier = CourierClient();
@@ -780,6 +782,47 @@ const { requestId } = await courier.send({
 });
 ```
 
+### Accounts
+
+The Accounts API is designed to enable multi-tenant notification workflows. This is useful for defining user to account level relationships, especially in the context of B2B applications.
+
+Use Cases:
+
+- Sending branded notifications on behalf of an organization
+- Creating slack-bots on behalf of an organization
+
+#### Creating an Account
+
+```ts
+const { accountId } = await courier.accounts.put({
+  id: "<ACCOUNT_ID>",
+  name: "Courier",
+  user_profile: {
+    slack: {
+      access_token: "<SLACK_ACCESS_TOKEN_SCOPED_TO_THE_ACCOUNT>",
+    },
+  },
+});
+```
+
+#### Retrieving an Account
+
+```ts
+const account = await courier.accounts.get("<ACCOUNT_ID>");
+```
+
+#### Deleting an Account
+
+```ts
+await courier.accounts.delete("<ACCOUNT_ID>");
+```
+
+#### Listing Accounts
+
+```ts
+const { items: accounts, has_more, next_page } = await courier.accounts.list();
+```
+
 ## License
 
 [MIT License](http://www.opensource.org/licenses/mit-license.php)

package/lib/accounts/index.d.ts

@@ -0,0 +1,8 @@
+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>;
+};

package/lib/accounts/index.js

@@ -0,0 +1,99 @@
+"use strict";
+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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+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 () {
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, options.httpClient.delete("/accounts/" + accountId)];
+            case 1:
+                _a.sent();
+                return [2 /*return*/];
+        }
+    });
+}); }; };
+var getAccount = function (options) {
+    return function (accountId) { 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 1:
+                    response = _a.sent();
+                    return [2 /*return*/, response.data];
+            }
+        });
+    }); };
+};
+var listAccounts = 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, {
+                        params: {
+                            cursor: (listOptions === null || listOptions === void 0 ? void 0 : listOptions.cursor) || "",
+                            limit: (listOptions === null || listOptions === void 0 ? void 0 : listOptions.limit) || "20",
+                        },
+                    })];
+                case 1:
+                    response = _a.sent();
+                    return [2 /*return*/, response.data];
+            }
+        });
+    }); };
+};
+var putAccount = function (options) {
+    return function (account) { 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 1:
+                    response = _a.sent();
+                    return [2 /*return*/, response.data];
+            }
+        });
+    }); };
+};
+exports.accounts = function (options) { return ({
+    delete: deleteAccount(options),
+    get: getAccount(options),
+    listAccounts: listAccounts(options),
+    put: putAccount(options),
+}); };

package/lib/accounts/types.d.ts

@@ -0,0 +1,27 @@
+export interface IAccount {
+    brand_id?: string;
+    id: string;
+    name: string;
+    parent_account_id?: string;
+    properties?: {
+        [key: string]: any;
+    };
+    user_profile?: Record<string, any>;
+    type: "account";
+}
+export interface IPaginatedResult<T> {
+    cursor?: string;
+    has_more: boolean;
+    items: T[];
+    type: "list";
+}
+export interface IAccountListOptions {
+    cursor?: string;
+    limit?: string;
+}
+export interface ICourierClientAccounts {
+    delete: (id: string) => Promise<void>;
+    get: (id: string) => Promise<IAccount>;
+    listAccounts: (options?: IAccountListOptions) => Promise<IPaginatedResult<IAccount>>;
+    put: (account: Omit<IAccount, "type">) => Promise<IAccount>;
+}

package/lib/accounts/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/client.js

@@ -37,6 +37,7 @@ 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");
@@ -101,8 +102,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();
@@ -113,6 +114,7 @@ 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),
@@ -137,6 +139,6 @@ exports.client = function (options) {
         replaceBrand: brands_1.replaceBrand(options),
         replaceProfile: profile_1.replaceProfile(options),
         send: send_1.send(options),
-        tokenManagement: token_management_1.tokenManagement(options)
+        tokenManagement: token_management_1.tokenManagement(options),
     };
 };

package/lib/send/types.d.ts

@@ -227,6 +227,7 @@ export interface AudienceRecipient {
     data?: MessageData;
 }
 export interface UserRecipient extends UserRecipientType {
+    account_id?: string;
     data?: MessageData;
     email?: string;
     locale?: string;

package/lib/types.d.ts

@@ -1,3 +1,4 @@
+import { ICourierClientAccounts } from "./accounts/types";
 import { ICourierClientAudiences } from "./audiences/types";
 import { auditEvents } from "./audit-events";
 import { ICourierClientAutomations } from "./automations/types";
@@ -299,6 +300,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;
     audiences: ICourierClientAudiences;
     auditEvents: ReturnType<typeof auditEvents>;
     automations: ICourierClientAutomations;

package/package.json

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