@trycourier/courier 4.4.0 → 4.6.0

package/README.md

@@ -823,6 +823,25 @@ await courier.accounts.delete("<ACCOUNT_ID>");
 const { items: accounts, has_more, next_page } = await courier.accounts.list();
 ```
 
+### Users
+
+#### Updating user
+
+```ts
+await courier.users.put("<USER_ID>", {
+  accounts: [{ account_id: "ACCOUNT_ID", profile: { foo: "bar" } }],
+  profile: { name: "John Doe" },
+});
+```
+
+#### Updating user accounts
+
+```ts
+await courier.users.putAccounts("<USER_ID>", {
+  accounts: [{ account_id: "ACCOUNT_ID", profile: { foo: "bar" } }],
+});
+```
+
 ## License
 
 [MIT License](http://www.opensource.org/licenses/mit-license.php)

package/lib/accounts/index.js

@@ -68,8 +68,8 @@ var listAccounts = function (options) {
                 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",
-                        },
+                            limit: (listOptions === null || listOptions === void 0 ? void 0 : listOptions.limit) || "20"
+                        }
                     })];
                 case 1:
                     response = _a.sent();
@@ -95,5 +95,5 @@ exports.accounts = function (options) { return ({
     delete: deleteAccount(options),
     get: getAccount(options),
     listAccounts: listAccounts(options),
-    put: putAccount(options),
+    put: putAccount(options)
 }); };

package/lib/client.js

@@ -49,6 +49,20 @@ var preferences_1 = require("./preferences");
 var profile_1 = require("./profile");
 var send_1 = require("./send");
 var token_management_1 = require("./token-management");
+var users_1 = require("./users");
+var cancelMessage = function (options) {
+    return function (messageId) { return __awaiter(void 0, void 0, void 0, function () {
+        var res;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, options.httpClient.post("/messages/" + messageId + "/cancel")];
+                case 1:
+                    res = _a.sent();
+                    return [2 /*return*/, res.data];
+            }
+        });
+    }); };
+};
 var getMessage = function (options) {
     return function (messageId) { return __awaiter(void 0, void 0, void 0, function () {
         var res;
@@ -102,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();
@@ -120,6 +134,7 @@ exports.client = function (options) {
         auditEvents: audit_events_1.auditEvents(options),
         automations: automations_1.automations(options),
         bulk: bulk_1.bulk(options),
+        cancelMessage: cancelMessage(options),
         createBrand: brands_1.createBrand(options),
         deleteBrand: brands_1.deleteBrand(options),
         deleteProfile: profile_1.deleteProfile(options),
@@ -140,5 +155,6 @@ exports.client = function (options) {
         replaceProfile: profile_1.replaceProfile(options),
         send: send_1.send(options),
         tokenManagement: token_management_1.tokenManagement(options),
+        users: users_1.users(options)
     };
 };

package/lib/http-client.js

@@ -93,7 +93,7 @@ exports.initHttpClient = function (_a) {
                         case 0:
                             searchParams = String(new URLSearchParams(config === null || config === void 0 ? void 0 : config.params));
                             searchQueryString = searchParams && "?" + searchParams;
-                            fullUrl = encodeURI("" + (baseUrl !== null && baseUrl !== void 0 ? baseUrl : '') + url + searchQueryString);
+                            fullUrl = encodeURI("" + (baseUrl !== null && baseUrl !== void 0 ? baseUrl : "") + url + searchQueryString);
                             contentTypeHeader = body == null ? null : { "Content-Type": "application/json" };
                             idempotencyKeyHeader = (config === null || config === void 0 ? void 0 : config.idempotencyKey) ? { "Idempotency-Key": config.idempotencyKey }
                                 : null;

package/lib/types.d.ts

@@ -8,6 +8,7 @@ import { ICourierClientNotifications } from "./notifications/types";
 import { ICourierClientPreferences, IRecipientPreferences } from "./preferences/types";
 import { Message } from "./send/types";
 import { tokenManagement } from "./token-management";
+import { users } from "./users";
 export interface IInitHttpClientOptions {
     baseUrl: string;
     version: string;
@@ -124,6 +125,24 @@ export interface ICourierMessagesGetResponse {
         tags?: string[];
     }>;
 }
+export interface ICourierMessageCancelResponse {
+    canceledAt: number;
+    event: string;
+    id: string;
+    recipient: string;
+    status: string;
+    clicked?: number;
+    delivered?: number;
+    enqueued?: number;
+    error?: string;
+    jobId?: string;
+    listId?: string;
+    listMessageId?: string;
+    notification?: string;
+    opened?: number;
+    runId?: string;
+    sent?: number;
+}
 export interface ICourierMessageGetResponse {
     clicked?: number;
     delivered?: number;
@@ -305,6 +324,7 @@ export interface ICourierClient {
     auditEvents: ReturnType<typeof auditEvents>;
     automations: ICourierClientAutomations;
     bulk: ICourierClientBulk;
+    cancelMessage: (messageId: string) => Promise<ICourierMessageCancelResponse>;
     createBrand: (params: ICourierBrandParameters, config?: ICourierBrandPostConfig) => Promise<ICourierBrand>;
     deleteBrand: (brandId: string) => Promise<void>;
     getBrand: (brandId: string) => Promise<ICourierBrand>;
@@ -327,5 +347,6 @@ export interface ICourierClient {
     replaceProfile: (params: ICourierProfilePutParameters) => Promise<ICourierProfilePutResponse>;
     send: <T extends ICourierSendParameters | ICourierSendMessageParameters>(params: T, config?: ICourierSendConfig) => Promise<SendResponse<T>>;
     tokenManagement: ReturnType<typeof tokenManagement>;
+    users: ReturnType<typeof users>;
 }
 export {};

package/lib/users/index.d.ts

@@ -0,0 +1,6 @@
+import { ICourierClientConfiguration } from "../types";
+import { IUser, IUserAccount } from "./types";
+export declare const users: (options: ICourierClientConfiguration) => {
+    put: (id: string, user: IUser) => Promise<void>;
+    putAccounts: (id: string, accounts: IUserAccount[]) => Promise<void>;
+};

package/lib/users/index.js

@@ -0,0 +1,67 @@
+"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.users = void 0;
+var put = function (options) {
+    return function (id, user) { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, options.httpClient.put("/users/" + id, user)];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); };
+};
+var putAccounts = function (options) {
+    return function (id, accounts) { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, options.httpClient.put("/users/" + id + "/accounts", accounts)];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); };
+};
+exports.users = function (options) { return ({
+    put: put(options),
+    putAccounts: putAccounts(options),
+}); };

package/lib/users/types.d.ts

@@ -0,0 +1,12 @@
+export interface IUserAccount {
+    account_id: string;
+    profile: Record<string, any>;
+}
+export interface IUser {
+    accounts: IUserAccount[];
+    profile: Record<string, any>;
+}
+export interface ICourierClientUsers {
+    put: (id: string, user: IUser) => Promise<void>;
+    putAccounts: (id: string, accounts: IUserAccount[]) => Promise<void>;
+}

package/lib/users/types.js

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

package/package.json

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