@knocklabs/node 0.2.0 → 0.2.4

package/README.md

@@ -61,6 +61,8 @@ await knockClient.notify("dinosaurs-loose", {
     type: "trex",
     priority: 1,
   },
+  // an optional identifier for the tenant that the notifications belong to
+  tenant: "jurassic-park",
   // an optional key to provide to cancel a notify
   cancellationKey: triggerAlert.id,
 });
@@ -115,7 +117,22 @@ await knockClient.preferences.setWorkflow("jhammond", "dinosaurs-loose", {
 });
 ```
 
-### Cancelling workflows
+### Getting and setting channel data
+
+```javascript
+const { Knock } = require("@knocklabs/node");
+const knockClient = new Knock("sk_12345");
+
+// Setting channel data for an APNS
+await knockClient.users.setChannelData("jhammond", KNOCK_APNS_CHANNEL_ID, {
+  tokens: [apnsToken],
+});
+
+// Getting channel data for the APNS channel
+await knockClient.users.getChannelData("jhammond", KNOCK_APNS_CHANNEL_ID);
+```
+
+### Canceling workflows
 
 ```javascript
 const { Knock } = require("@knocklabs/node");
@@ -133,7 +150,7 @@ You can use the `jsonwebtoken` package to [sign JWTs easily](https://www.npmjs.c
 You will need to generate an environment specific signing key, which you can find in the Knock dashboard.
 
 If you're using a signing token you will need to pass this to your client to perform authentication.
-You can read more about [clientside authentication here](https://docs.knock.app/client-integration/authenticating-users).
+You can read more about [client-side authentication here](https://docs.knock.app/client-integration/authenticating-users).
 
 ```javascript
 const jwt = require("jsonwebtoken");

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@knocklabs/node",
-    "version": "0.2.0",
+    "version": "0.2.4",
     "description": "Library for interacting with the Knock API",
     "homepage": "https://github.com/knocklabs/knock-node",
     "author": "@knocklabs",

package/dist/src/knock.d.ts

@@ -3,16 +3,17 @@ import { KnockOptions, PostAndPutOptions } from "./common/interfaces";
 import { Users } from "./resources/users";
 import { Preferences } from "./resources/preferences";
 import { Workflows } from "./resources/workflows";
+import { TriggerWorkflowProperties } from "./resources/workflows/interfaces";
 declare class Knock {
     readonly key?: string | undefined;
     readonly options: KnockOptions;
     readonly host: string;
     private readonly client;
-    readonly notify: (workflowKey: string, { actor, recipients, cancellationKey, data: notifyData, }: import(".").TriggerWorkflowProperties) => Promise<import(".").WorkflowRun>;
     readonly users: Users;
     readonly preferences: Preferences;
     readonly workflows: Workflows;
     constructor(key?: string | undefined, options?: KnockOptions);
+    notify(workflowKey: string, properties: TriggerWorkflowProperties): Promise<import("./resources/workflows/interfaces").WorkflowRun>;
     post(path: string, entity: any, options?: PostAndPutOptions): Promise<AxiosResponse>;
     put(path: string, entity: any, options?: PostAndPutOptions): Promise<AxiosResponse>;
     delete(path: string, entity?: any): Promise<AxiosResponse>;

package/dist/src/knock.js

@@ -16,7 +16,6 @@ exports.Knock = void 0;
 const axios_1 = __importDefault(require("axios"));
 const package_json_1 = require("../package.json");
 const exceptions_1 = require("./common/exceptions");
-const notify_1 = require("./resources/notify");
 const users_1 = require("./resources/users");
 const preferences_1 = require("./resources/preferences");
 const workflows_1 = require("./resources/workflows");
@@ -25,7 +24,6 @@ class Knock {
     constructor(key, options = {}) {
         this.key = key;
         this.options = options;
-        this.notify = notify_1.notify(this);
         this.users = new users_1.Users(this);
         this.preferences = new preferences_1.Preferences(this);
         this.workflows = new workflows_1.Workflows(this);
@@ -44,6 +42,12 @@ class Knock {
             },
         });
     }
+    // Delegate the notify function to the workflows trigger
+    notify(workflowKey, properties) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.workflows.trigger(workflowKey, properties);
+        });
+    }
     post(path, entity, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {

package/dist/src/resources/preferences/index.js

@@ -11,6 +11,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Preferences = void 0;
 const DEFAULT_PREFERENCE_SET_ID = "default";
+function buildUpdateParam(param) {
+    if (typeof param === "object") {
+        return param;
+    }
+    return { subscribed: param };
+}
 class Preferences {
     constructor(knock) {
         this.knock = knock;
@@ -59,7 +65,7 @@ class Preferences {
     setWorkflow(userId, workflowKey, setting, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const preferenceSetId = options.preferenceSet || DEFAULT_PREFERENCE_SET_ID;
-            const { data, } = yield this.knock.put(`/v1/users/${userId}/preferences/${preferenceSetId}/workflows/${workflowKey}`, { subscribed: setting });
+            const { data } = yield this.knock.put(`/v1/users/${userId}/preferences/${preferenceSetId}/workflows/${workflowKey}`, buildUpdateParam(setting));
             return data;
         });
     }
@@ -73,7 +79,7 @@ class Preferences {
     setCategory(userId, categoryKey, setting, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const preferenceSetId = options.preferenceSet || DEFAULT_PREFERENCE_SET_ID;
-            const { data, } = yield this.knock.put(`/v1/users/${userId}/preferences/${preferenceSetId}/categories/${categoryKey}`, { subscribed: setting });
+            const { data } = yield this.knock.put(`/v1/users/${userId}/preferences/${preferenceSetId}/categories/${categoryKey}`, buildUpdateParam(setting));
             return data;
         });
     }

package/dist/src/resources/preferences/interfaces.d.ts

@@ -1,7 +1,6 @@
-export declare type ChannelType = "email" | "in_app_feed";
+export declare type ChannelType = "email" | "in_app_feed" | "sms" | "push";
 export declare type ChannelTypePreferences = {
-    email: boolean;
-    in_app_feed: boolean;
+    [K in ChannelType]: boolean;
 };
 export declare type WorkflowPreferenceSetting = boolean | {
     channel_types: ChannelTypePreferences;

package/dist/src/resources/users/index.d.ts

@@ -6,4 +6,6 @@ export declare class Users {
     identify(userId: string, properties?: IdentifyProperties): Promise<any>;
     get(userId: string): Promise<any>;
     delete(userId: string): Promise<any>;
+    getChannelData(userId: string, channelId: string): Promise<any>;
+    setChannelData(userId: string, channelId: string, channelData: Record<string, string>): Promise<any>;
 }

package/dist/src/resources/users/index.js

@@ -41,5 +41,24 @@ class Users {
             return data;
         });
     }
+    getChannelData(userId, channelId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!userId || !channelId) {
+                throw new Error(`Incomplete arguments. You must provide a 'userId' and a 'channelId'`);
+            }
+            const { data } = yield this.knock.get(`/v1/users/${userId}/channel_data/${channelId}`);
+            return data;
+        });
+    }
+    setChannelData(userId, channelId, channelData) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!userId || !channelId) {
+                throw new Error(`Incomplete arguments. You must provide a 'userId' and a 'channelId'`);
+            }
+            const args = { data: channelData };
+            const { data } = yield this.knock.put(`/v1/users/${userId}/channel_data/${channelId}`, args);
+            return data;
+        });
+    }
 }
 exports.Users = Users;

package/dist/src/resources/workflows/index.d.ts

@@ -3,6 +3,6 @@ import { CancelWorkflowProperties, TriggerWorkflowProperties, WorkflowRun } from
 export declare class Workflows {
     readonly knock: Knock;
     constructor(knock: Knock);
-    trigger(workflowKey: string, { actor, recipients, cancellationKey, data: notifyData, }: TriggerWorkflowProperties): Promise<WorkflowRun>;
+    trigger(workflowKey: string, { actor, recipients, cancellationKey, tenant, data: notifyData, }: TriggerWorkflowProperties): Promise<WorkflowRun>;
     cancel(workflowKey: string, cancellationKey: string, { recipients }?: CancelWorkflowProperties): Promise<any>;
 }

package/dist/src/resources/workflows/index.js

@@ -14,7 +14,7 @@ class Workflows {
     constructor(knock) {
         this.knock = knock;
     }
-    trigger(workflowKey, { actor, recipients, cancellationKey, data: notifyData, }) {
+    trigger(workflowKey, { actor, recipients, cancellationKey, tenant, data: notifyData, }) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!workflowKey && !actor && !recipients) {
                 throw new Error(`Incomplete arguments. At a minimum you need to specify 'workflowKey', 'actor', and 'recipients'.`);
@@ -23,6 +23,7 @@ class Workflows {
                 actor,
                 recipients,
                 cancellation_key: cancellationKey,
+                tenant,
                 data: notifyData,
             });
             return data;

package/dist/src/resources/workflows/interfaces.d.ts

@@ -2,6 +2,7 @@ export interface TriggerWorkflowProperties {
     actor: string;
     recipients?: string[];
     cancellationKey?: string;
+    tenant?: string;
     data?: {
         [key: string]: any;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/node",
-  "version": "0.2.0",
+  "version": "0.2.4",
   "description": "Library for interacting with the Knock API",
   "homepage": "https://github.com/knocklabs/knock-node",
   "author": "@knocklabs",

package/dist/src/resources/identify/index.d.ts

@@ -1,3 +0,0 @@
-import { Knock } from "../../knock";
-import { IdentifyProperties } from "./interfaces";
-export declare function identify(knock: Knock): (userId: string, properties?: IdentifyProperties) => Promise<any>;

package/dist/src/resources/identify/index.js

@@ -1,22 +0,0 @@
-"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());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.identify = void 0;
-function identify(knock) {
-    return (userId, properties = {}) => __awaiter(this, void 0, void 0, function* () {
-        if (!userId) {
-            throw new Error(`Incomplete arguments. At a minimum you need to specify 'userId'.`);
-        }
-        const { data } = yield knock.put(`/v1/users/${userId}`, properties);
-        return data;
-    });
-}
-exports.identify = identify;

package/dist/src/resources/identify/interfaces.d.ts

@@ -1,5 +0,0 @@
-export interface IdentifyProperties {
-    name?: string;
-    email?: string;
-    [key: string]: any;
-}

package/dist/src/resources/identify/interfaces.js

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

package/dist/src/resources/notify/index.d.ts

@@ -1,2 +0,0 @@
-import { Knock } from "../../knock";
-export declare function notify(knock: Knock): (workflowKey: string, { actor, recipients, cancellationKey, data: notifyData, }: import("../..").TriggerWorkflowProperties) => Promise<import("../..").WorkflowRun>;

package/dist/src/resources/notify/index.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.notify = void 0;
-function notify(knock) {
-    // This is just an alias to triggering the workflow
-    return knock.workflows.trigger;
-}
-exports.notify = notify;

package/dist/src/resources/notify/interfaces.d.ts

@@ -1,11 +0,0 @@
-export interface NotifyProperties {
-    actor: string;
-    recipients?: string[];
-    cancelationKey?: string;
-    data?: {
-        [key: string]: any;
-    };
-}
-export interface CancelNotifyProperties {
-    recipients?: string[];
-}

package/dist/src/resources/notify/interfaces.js

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