@trycourier/courier 5.3.0 → 5.4.0

package/README.md

@@ -434,22 +434,6 @@ async function run() {
   );
   console.log(items);
 
-  // Example: Notification Preferences
-  await courier.preferences.put(recipientId, {
-    notifications: {
-      "<NOTIFICATION_ID>": { status: "<OPT_IN_STATUS>" },
-    },
-  });
-  // Where OPT_IN_STATUS = "OPTED_IN" | "OPTED_OUT"
-
-  // Example: Get a list of existing notifications and categories
-  const prefs = await courier.preferences.list();
-  console.log(prefs);
-
-  // Example: Get the preferences stored under a specified recipient ID.
-  const profilePrefs = await courier.preferences.get(recipientId);
-  console.log(profilePrefs);
-
   // Example: Automation Ad-Hoc Invoke
   const { runId } = await courier.automations.invokeAdHocAutomation({
     automation: {
@@ -782,45 +766,45 @@ const { requestId } = await courier.send({
 });
 ```
 
-### Accounts
+### Tenants
 
-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.
+The Tenants API is designed to enable multi-tenant notification workflows. This is useful for defining user to tenant 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
+#### Creating a Tenant
 
 ```ts
-const { accountId } = await courier.accounts.put({
-  id: "<ACCOUNT_ID>",
+const { tenantId } = await courier.tenants.put({
+  id: "<TENANT_ID>",
   name: "Courier",
   user_profile: {
     slack: {
-      access_token: "<SLACK_ACCESS_TOKEN_SCOPED_TO_THE_ACCOUNT>",
+      access_token: "<SLACK_ACCESS_TOKEN_SCOPED_TO_THE_TENANT>",
     },
   },
 });
 ```
 
-#### Retrieving an Account
+#### Retrieving a Tenant
 
 ```ts
-const account = await courier.accounts.get("<ACCOUNT_ID>");
+const account = await courier.tenants.get("<TENANT_ID>");
 ```
 
-#### Deleting an Account
+#### Deleting a Tenant
 
 ```ts
-await courier.accounts.delete("<ACCOUNT_ID>");
+await courier.tenants.delete("<TENANT_ID>");
 ```
 
-#### Listing Accounts
+#### Listing Tenants
 
 ```ts
-const { items: accounts, has_more, next_page } = await courier.accounts.list();
+const { items: tenants, has_more, next_page } = await courier.tenants.list();
 ```
 
 ### Users
@@ -842,6 +826,36 @@ await courier.users.putAccounts("<USER_ID>", {
 });
 ```
 
+#### Updating user preferences
+
+Courier currently does not allow creating new topics via the API. You must create topics via the Courier UI. Once a topic is created, you can update a user's preferences for that topic via the API.
+
+```ts
+await courier.users.putUserPreferenceByTopic(mockUserId, "<VALID_TOPIC_ID>", {
+  default_status: "OPTED_IN",
+  status: "OPTED_OUT",
+});
+```
+
+#### Getting user preferences
+
+- Get all topic level preferences for a user
+
+```ts
+const { items: userPreferences } = await courier.users.getUserPreferences(
+  "<USER_ID>"
+);
+```
+
+- Get a specific topic level preference for a user
+
+```ts
+const userPreference = await courier.users.getUserPreferenceByTopic(
+  "<USER_ID>",
+  "<VALID_TOPIC_ID>"
+);
+```
+
 ## License
 
 [MIT License](http://www.opensource.org/licenses/mit-license.php)

package/lib/users/index.d.ts

@@ -1,6 +1,9 @@
 import { ICourierClientConfiguration } from "../types";
-import { IUser, IUserAccount } from "./types";
+import { ITopicPreference, IUser, IUserAccount } from "./types";
 export declare const users: (options: ICourierClientConfiguration) => {
+    getUserPreferenceByTopic: (userId: string, topicId: string) => Promise<ITopicPreference>;
+    getUserPreferenceByTopics: (userId: string) => Promise<object>;
     put: (id: string, user: IUser) => Promise<void>;
     putAccounts: (id: string, accounts: IUserAccount[]) => Promise<void>;
+    putUserPreferenceByTopic: (userId: string, topicId: string, topic: Omit<ITopicPreference, "topic_id" | "topic_name">) => Promise<void>;
 };

package/lib/users/index.js

@@ -61,7 +61,51 @@ var putAccounts = function (options) {
         });
     }); };
 };
+var putUserPreferenceByTopic = function (options) {
+    return function (userId, topicId, topic) { 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/" + userId + "/preferences/" + topicId, {
+                        topic: topic,
+                    })];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); };
+};
+var getUserPreferenceByTopic = function (options) {
+    return function (userId, topicId) { return __awaiter(void 0, void 0, void 0, function () {
+        var res;
+        var _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, options.httpClient.get("/users/" + userId + "/preferences/" + topicId)];
+                case 1:
+                    res = _b.sent();
+                    return [2 /*return*/, (_a = res.data) === null || _a === void 0 ? void 0 : _a.topic];
+            }
+        });
+    }); };
+};
+var getUserPreferenceByTopics = function (options) {
+    return function (userId) { 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.get("/users/" + userId + "/preferences")];
+                case 1:
+                    res = _a.sent();
+                    return [2 /*return*/, res.data];
+            }
+        });
+    }); };
+};
 exports.users = function (options) { return ({
+    getUserPreferenceByTopic: getUserPreferenceByTopic(options),
+    getUserPreferenceByTopics: getUserPreferenceByTopics(options),
     put: put(options),
-    putAccounts: putAccounts(options)
+    putAccounts: putAccounts(options),
+    putUserPreferenceByTopic: putUserPreferenceByTopic(options),
 }); };

package/lib/users/types.d.ts

@@ -6,7 +6,34 @@ export interface IUser {
     accounts: IUserAccount[];
     profile: Record<string, any>;
 }
+export declare type ChannelClassification = "direct_message" | "email" | "push" | "sms" | "webhook" | "inbox";
+export interface ITopicPreference {
+    /**
+     * Should contain unique items.
+     */
+    custom_routing?: ChannelClassification[];
+    default_status: "OPTED_IN" | "OPTED_OUT";
+    has_custom_routing?: boolean;
+    status: "OPTED_IN" | "OPTED_OUT";
+    topic_id: string;
+    topic_name: string;
+}
+interface IPagingInfo {
+    cursor: string;
+    more: boolean;
+}
+export interface IGetTopicPreferencesResponse {
+    topic: ITopicPreference;
+}
+export interface IGetTopicsResponse {
+    paging: IPagingInfo;
+    items: ITopicPreference[];
+}
 export interface ICourierClientUsers {
+    getUserPreferenceByTopic: (userId: string, topicId: string) => Promise<IGetTopicPreferencesResponse>;
+    getUserPreferenceByTopics: (userId: string) => Promise<IGetTopicsResponse>;
     put: (id: string, user: IUser) => Promise<void>;
     putAccounts: (id: string, accounts: IUserAccount[]) => Promise<void>;
+    putUserPreferenceByTopic: (userId: string, topicId: string, topic: Omit<ITopicPreference, "topic_id" | "topic_name">) => Promise<void>;
 }
+export {};

package/package.json

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