@knocklabs/node 0.2.3 → 0.2.4

package/README.md

@@ -117,6 +117,21 @@ await knockClient.preferences.setWorkflow("jhammond", "dinosaurs-loose", {
 });
 ```
 
+### 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

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@knocklabs/node",
-    "version": "0.2.3",
+    "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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/node",
-  "version": "0.2.3",
+  "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 });