@knocklabs/node 0.4.3 → 0.4.6

package/dist/package.json

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

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

@@ -5,7 +5,7 @@ import { Knock } from "../../knock";
 export declare class Messages {
     readonly knock: Knock;
     constructor(knock: Knock);
-    list(filteringOptions?: ListMessagesOptions): Promise<Message>;
+    list(filteringOptions?: ListMessagesOptions): Promise<PaginatedResponse<Message>>;
     get(messageId: string): Promise<Message>;
     getContent(messageId: string): Promise<MessageContent>;
     getEvents(messageId: string, paginationOptions?: PaginationOptions): Promise<PaginatedResponse<MessageEvent>>;

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

@@ -1,8 +1,9 @@
-import { ChannelData, CommonMetadata, SetChannelDataProperties, PaginatedResponse } from "../../common/interfaces";
+import { ChannelData, CommonMetadata, SetChannelDataProperties, PaginatedResponse, ChannelType } from "../../common/interfaces";
 import { Knock } from "../../knock";
 import { BulkSetObjectOption, Object, SetObjectProperties } from "./interfaces";
 import { BulkOperation } from "../bulk_operations/interfaces";
 import { ListMessagesOptions, Message } from "../messages/interfaces";
+import { ChannelTypePreferences, PreferenceOptions, PreferenceSet, SetPreferencesProperties, WorkflowPreferences, WorkflowPreferenceSetting } from "../preferences/interfaces";
 export declare class Objects {
     readonly knock: Knock;
     constructor(knock: Knock);
@@ -13,5 +14,19 @@ export declare class Objects {
     bulkDelete(collection: string, objectIds: string[]): Promise<BulkOperation>;
     getChannelData<T = CommonMetadata>(collection: string, id: string, channelId: string): Promise<ChannelData<T>>;
     setChannelData<T = CommonMetadata>(collection: string, id: string, channelId: string, channelData: SetChannelDataProperties): Promise<ChannelData<T>>;
+    unsetChannelData(collection: string, id: string, channelId: string): Promise<any>;
     getMessages(collection: string, objectId: string, filteringOptions?: ListMessagesOptions): Promise<PaginatedResponse<Message>>;
+    getAllPreferences(collection: string, objectId: string): Promise<PreferenceSet[]>;
+    /**
+     * @deprecated Use `objects.getPreferences` instead
+     */
+    getPrefences(collection: string, objectId: string, options?: PreferenceOptions): Promise<PreferenceSet>;
+    getPreferences(collection: string, objectId: string, options?: PreferenceOptions): Promise<PreferenceSet>;
+    setPreferences(collection: string, objectId: string, preferenceSet: SetPreferencesProperties, options?: PreferenceOptions): Promise<PreferenceSet>;
+    setChannelTypesPreferences(collection: string, objectId: string, channelTypePreferences: ChannelTypePreferences, options?: PreferenceOptions): Promise<PreferenceSet>;
+    setChannelTypePreferences(collection: string, objectId: string, channelType: ChannelType, setting: boolean, options?: PreferenceOptions): Promise<PreferenceSet>;
+    setWorkflowsPreferences(collection: string, objectId: string, workflowPreferences: WorkflowPreferences, options?: PreferenceOptions): Promise<PreferenceSet>;
+    setWorkflowPreferences(collection: string, objectId: string, workflowKey: string, setting: WorkflowPreferenceSetting, options?: PreferenceOptions): Promise<PreferenceSet>;
+    setCategoriesPreferences(collection: string, objectId: string, categoryPreferences: WorkflowPreferences, options?: PreferenceOptions): Promise<PreferenceSet>;
+    setCategoryPreferences(collection: string, objectId: string, categoryKey: string, setting: WorkflowPreferenceSetting, options?: PreferenceOptions): Promise<PreferenceSet>;
 }

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

@@ -10,6 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Objects = void 0;
+const helpers_1 = require("../preferences/helpers");
 class Objects {
     constructor(knock) {
         this.knock = knock;
@@ -62,6 +63,12 @@ class Objects {
             return data;
         });
     }
+    unsetChannelData(collection, id, channelId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.knock.delete(`/v1/objects/${collection}/${id}/channel_data/${channelId}`);
+            return data;
+        });
+    }
     //
     // Messages
     //
@@ -74,5 +81,78 @@ class Objects {
             return data;
         });
     }
+    //
+    // Preferences
+    //
+    getAllPreferences(collection, objectId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.knock.get(`/v1/objects/${collection}/${objectId}/preferences`);
+            return data;
+        });
+    }
+    /**
+     * @deprecated Use `objects.getPreferences` instead
+     */
+    getPrefences(collection, objectId, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.getPreferences(collection, objectId, options);
+        });
+    }
+    getPreferences(collection, objectId, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const preferenceSetId = options.preferenceSet || helpers_1.DEFAULT_PREFERENCE_SET_ID;
+            const { data } = yield this.knock.get(`/v1/objects/${collection}/${objectId}/preferences/${preferenceSetId}`);
+            return data;
+        });
+    }
+    setPreferences(collection, objectId, preferenceSet, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const preferenceSetId = options.preferenceSet || helpers_1.DEFAULT_PREFERENCE_SET_ID;
+            const { data } = yield this.knock.put(`/v1/objects/${collection}/${objectId}/preferences/${preferenceSetId}`, preferenceSet);
+            return data;
+        });
+    }
+    setChannelTypesPreferences(collection, objectId, channelTypePreferences, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const preferenceSetId = options.preferenceSet || helpers_1.DEFAULT_PREFERENCE_SET_ID;
+            const { data } = yield this.knock.put(`/v1/objects/${collection}/${objectId}/preferences/${preferenceSetId}/channel_types`, channelTypePreferences);
+            return data;
+        });
+    }
+    setChannelTypePreferences(collection, objectId, channelType, setting, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const preferenceSetId = options.preferenceSet || helpers_1.DEFAULT_PREFERENCE_SET_ID;
+            const { data, } = yield this.knock.put(`/v1/objects/${collection}/${objectId}/preferences/${preferenceSetId}/channel_types/${channelType}`, { subscribed: setting });
+            return data;
+        });
+    }
+    setWorkflowsPreferences(collection, objectId, workflowPreferences, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const preferenceSetId = options.preferenceSet || helpers_1.DEFAULT_PREFERENCE_SET_ID;
+            const { data } = yield this.knock.put(`/v1/objects/${collection}/${objectId}/preferences/${preferenceSetId}/workflows`, workflowPreferences);
+            return data;
+        });
+    }
+    setWorkflowPreferences(collection, objectId, workflowKey, setting, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const preferenceSetId = options.preferenceSet || helpers_1.DEFAULT_PREFERENCE_SET_ID;
+            const { data } = yield this.knock.put(`/v1/objects/${collection}/${objectId}/preferences/${preferenceSetId}/workflows/${workflowKey}`, helpers_1.buildUpdateParam(setting));
+            return data;
+        });
+    }
+    setCategoriesPreferences(collection, objectId, categoryPreferences, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const preferenceSetId = options.preferenceSet || helpers_1.DEFAULT_PREFERENCE_SET_ID;
+            const { data } = yield this.knock.put(`/v1/objects/${collection}/${objectId}/preferences/${preferenceSetId}/categories`, categoryPreferences);
+            return data;
+        });
+    }
+    setCategoryPreferences(collection, objectId, categoryKey, setting, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const preferenceSetId = options.preferenceSet || helpers_1.DEFAULT_PREFERENCE_SET_ID;
+            const { data } = yield this.knock.put(`/v1/objects/${collection}/${objectId}/preferences/${preferenceSetId}/categories/${categoryKey}`, helpers_1.buildUpdateParam(setting));
+            return data;
+        });
+    }
 }
 exports.Objects = Objects;

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

@@ -15,7 +15,11 @@ export declare class Users {
     merge(toUserId: string, fromUserId: string): Promise<User>;
     getFeed(userId: string, channelId: string, feedOptions?: UserFeedOptions): Promise<any>;
     getAllPreferences(userId: string): Promise<any>;
+    /**
+     * @deprecated Use `users.getPreferences` instead
+     */
     getPrefences(userId: string, options?: PreferenceOptions): Promise<PreferenceSet>;
+    getPreferences(userId: string, options?: PreferenceOptions): Promise<PreferenceSet>;
     setPreferences(userId: string, preferenceSet: SetPreferencesProperties, options?: PreferenceOptions): Promise<PreferenceSet>;
     bulkSetPreferences(userIds: string[], preferenceSet: SetPreferencesProperties, options?: PreferenceOptions): Promise<BulkOperation>;
     setChannelTypesPreferences(userId: string, channelTypePreferences: ChannelTypePreferences, options?: PreferenceOptions): Promise<PreferenceSet>;
@@ -26,5 +30,6 @@ export declare class Users {
     setCategoryPreferences(userId: string, categoryKey: string, setting: WorkflowPreferenceSetting, options?: PreferenceOptions): Promise<PreferenceSet>;
     getChannelData<T = CommonMetadata>(userId: string, channelId: string): Promise<ChannelData<T>>;
     setChannelData<T = CommonMetadata>(userId: string, channelId: string, channelData: Record<string, any>): Promise<ChannelData<T>>;
+    unsetChannelData(userId: string, channelId: string): Promise<any>;
     getMessages(userId: string, filteringOptions?: ListMessagesOptions): Promise<PaginatedResponse<Message>>;
 }

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

@@ -88,7 +88,15 @@ class Users {
             return data;
         });
     }
+    /**
+     * @deprecated Use `users.getPreferences` instead
+     */
     getPrefences(userId, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.getPreferences(userId, options);
+        });
+    }
+    getPreferences(userId, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const preferenceSetId = options.preferenceSet || helpers_1.DEFAULT_PREFERENCE_SET_ID;
             const { data } = yield this.knock.get(`/v1/users/${userId}/preferences/${preferenceSetId}`);
@@ -177,6 +185,15 @@ class Users {
             return data;
         });
     }
+    unsetChannelData(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.delete(`/v1/users/${userId}/channel_data/${channelId}`);
+            return data;
+        });
+    }
     //
     // Messages
     //

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

@@ -2,8 +2,8 @@ import { ObjectRef } from "../objects/interfaces";
 export interface TriggerWorkflowProperties<T = {
     [key: string]: any;
 }> {
-    actor?: string | ObjectRef;
-    recipients?: string[] | ObjectRef[];
+    actor?: Actor;
+    recipients?: Recipient[];
     cancellationKey?: string;
     tenant?: string;
     data?: T;
@@ -14,3 +14,5 @@ export interface CancelWorkflowProperties {
 export interface WorkflowRun {
     workflow_run_id: string;
 }
+export declare type Recipient = string | ObjectRef;
+export declare type Actor = Recipient;

package/package.json

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