@knocklabs/node 0.4.26 → 0.5.1

package/dist/package.json

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

package/dist/src/knock.d.ts

@@ -1,7 +1,6 @@
 import { AxiosResponse } from "axios";
 import { KnockOptions, PostAndPutOptions, SignUserTokenOptions, MethodOptions } from "./common/interfaces";
 import { Users } from "./resources/users";
-import { Preferences } from "./resources/preferences";
 import { Workflows } from "./resources/workflows";
 import { TriggerWorkflowProperties } from "./resources/workflows/interfaces";
 import { BulkOperations } from "./resources/bulk_operations";
@@ -14,7 +13,6 @@ declare class Knock {
     readonly host: string;
     private readonly client;
     readonly users: Users;
-    readonly preferences: Preferences;
     readonly workflows: Workflows;
     readonly bulkOperations: BulkOperations;
     readonly objects: Objects;
@@ -30,7 +28,7 @@ declare class Knock {
      * @param options Optionally specify the signing key to use (in PEM or base-64 encoded format), and how long the token should be valid for in seconds
      * @returns {string} A JWT token that can be used to authenticate requests to the Knock API (e.g. by passing into the <KnockFeedProvider /> component)
      */
-    static signUserToken(userId: string, options: SignUserTokenOptions): string;
+    static signUserToken(userId: string, options?: SignUserTokenOptions): string;
     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

@@ -18,7 +18,6 @@ const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
 const package_json_1 = require("../package.json");
 const exceptions_1 = require("./common/exceptions");
 const users_1 = require("./resources/users");
-const preferences_1 = require("./resources/preferences");
 const workflows_1 = require("./resources/workflows");
 const bulk_operations_1 = require("./resources/bulk_operations");
 const objects_1 = require("./resources/objects");
@@ -31,7 +30,6 @@ class Knock {
         this.options = options;
         // Service accessors
         this.users = new users_1.Users(this);
-        this.preferences = new preferences_1.Preferences(this);
         this.workflows = new workflows_1.Workflows(this);
         this.bulkOperations = new bulk_operations_1.BulkOperations(this);
         this.objects = new objects_1.Objects(this);
@@ -68,11 +66,11 @@ class Knock {
      */
     static signUserToken(userId, options) {
         var _a;
-        const signingKey = prepareSigningKey(options.signingKey);
+        const signingKey = prepareSigningKey(options === null || options === void 0 ? void 0 : options.signingKey);
         // JWT NumericDates specified in seconds:
         const currentTime = Math.floor(Date.now() / 1000);
         // Default to 1 hour from now
-        const expireInSeconds = (_a = options.expiresInSeconds) !== null && _a !== void 0 ? _a : 60 * 60;
+        const expireInSeconds = (_a = options === null || options === void 0 ? void 0 : options.expiresInSeconds) !== null && _a !== void 0 ? _a : 60 * 60;
         return jsonwebtoken_1.default.sign({
             sub: userId,
             iat: currentTime,

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

@@ -4,7 +4,7 @@ import { AddObjectSubscriptionProperties, BulkAddSubscriptionsOption, BulkSetObj
 import { BulkOperation } from "../bulk_operations/interfaces";
 import { ListMessagesOptions, Message } from "../messages/interfaces";
 import { ListSchedulesProps, Schedule } from "../workflows/interfaces";
-import { ChannelTypePreferences, PreferenceOptions, PreferenceSet, SetPreferencesProperties, WorkflowPreferences, WorkflowPreferenceSetting } from "../preferences/interfaces";
+import { ChannelTypePreferences, GetPreferencesOptions, PreferenceOptions, PreferenceSet, SetPreferencesProperties, WorkflowPreferences, WorkflowPreferenceSetting } from "../preferences/interfaces";
 export declare class Objects {
     readonly knock: Knock;
     constructor(knock: Knock);
@@ -20,11 +20,7 @@ export declare class Objects {
     unsetChannelData(collection: string, id: string, channelId: string): Promise<any>;
     getMessages(collection: string, objectId: string, filteringOptions?: ListMessagesOptions): Promise<PaginatedItemsResponse<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>;
+    getPreferences(collection: string, objectId: string, options?: GetPreferencesOptions): 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>;

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

@@ -104,18 +104,10 @@ class Objects {
             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}`);
+            const { data, } = yield this.knock.get(`/v1/objects/${collection}/${objectId}/preferences/${preferenceSetId}`, { tenant: options.tenant });
             return data;
         });
     }

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

@@ -25,3 +25,6 @@ export interface PreferenceSet {
 export interface PreferenceOptions {
     preferenceSet?: string;
 }
+export interface GetPreferencesOptions extends PreferenceOptions {
+    tenant?: string;
+}

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

@@ -1,6 +1,6 @@
 import { ChannelData, ChannelType, CommonMetadata, PaginatedItemsResponse, PaginatedEntriesResponse } from "../../common/interfaces";
 import { BulkOperation } from "../bulk_operations/interfaces";
-import { ChannelTypePreferences, PreferenceOptions, PreferenceSet, SetPreferencesProperties, WorkflowPreferences, WorkflowPreferenceSetting } from "../preferences/interfaces";
+import { ChannelTypePreferences, PreferenceOptions, PreferenceSet, GetPreferencesOptions, SetPreferencesProperties, WorkflowPreferences, WorkflowPreferenceSetting } from "../preferences/interfaces";
 import { ListMessagesOptions, Message } from "../messages/interfaces";
 import { ListSchedulesProps, Schedule } from "../workflows/interfaces";
 import { Knock } from "../../knock";
@@ -18,11 +18,7 @@ export declare class Users {
     merge(toUserId: string, fromUserId: string): Promise<User>;
     getFeed(userId: string, channelId: string, feedOptions?: UserFeedOptions): Promise<PaginatedEntriesResponse<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>;
+    getPreferences(userId: string, options?: GetPreferencesOptions): 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>;

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

@@ -94,18 +94,10 @@ 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}`);
+            const { data, } = yield this.knock.get(`/v1/users/${userId}/preferences/${preferenceSetId}`, { tenant: options.tenant });
             return data;
         });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/node",
-  "version": "0.4.26",
+  "version": "0.5.1",
   "description": "Library for interacting with the Knock API",
   "homepage": "https://github.com/knocklabs/knock-node",
   "author": "@knocklabs",
@@ -47,4 +47,4 @@
     "axios": "1.6",
     "jsonwebtoken": "^9.0.0"
   }
-}
+}

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

@@ -1,43 +0,0 @@
-import { ChannelType } from "../../common/interfaces";
-import { Knock } from "../../knock";
-import { ChannelTypePreferences, WorkflowPreferenceSetting, WorkflowPreferences, PreferenceOptions, SetPreferencesProperties, PreferenceSet } from "./interfaces";
-export declare class Preferences {
-    readonly knock: Knock;
-    constructor(knock: Knock);
-    /**
-     * @deprecated Use `users.getAllPreferences` instead
-     */
-    getAll(userId: string): Promise<PreferenceSet[]>;
-    /**
-     * @deprecated Use `users.getPreferences` instead
-     */
-    get(userId: string, options?: PreferenceOptions): Promise<PreferenceSet>;
-    /**
-     * @deprecated Use `users.setPreferences` instead
-     */
-    set(userId: string, preferenceSet: SetPreferencesProperties, options?: PreferenceOptions): Promise<PreferenceSet>;
-    /**
-     * @deprecated Use `users.setChannelTypesPreferences` instead
-     */
-    setChannelTypes(userId: string, channelTypePreferences: ChannelTypePreferences, options?: PreferenceOptions): Promise<PreferenceSet>;
-    /**
-     * @deprecated Use `users.setChannelTypePreferences` instead
-     */
-    setChannelType(userId: string, channelType: ChannelType, setting: boolean, options?: PreferenceOptions): Promise<PreferenceSet>;
-    /**
-     * @deprecated Use `users.setWorkflowsPreferences` instead
-     */
-    setWorkflows(userId: string, workflowPreferences: WorkflowPreferences, options?: PreferenceOptions): Promise<PreferenceSet>;
-    /**
-     * @deprecated Use `users.setWorkflowPreferences` instead
-     */
-    setWorkflow(userId: string, workflowKey: string, setting: WorkflowPreferenceSetting, options?: PreferenceOptions): Promise<PreferenceSet>;
-    /**
-     * @deprecated Use `users.setCategoriesPreferences` instead
-     */
-    setCategories(userId: string, categoryPreferences: WorkflowPreferences, options?: PreferenceOptions): Promise<PreferenceSet>;
-    /**
-     * @deprecated Use `users.setCategoryPreferences` instead
-     */
-    setCategory(userId: string, categoryKey: string, setting: WorkflowPreferenceSetting, options?: PreferenceOptions): Promise<PreferenceSet>;
-}

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

@@ -1,91 +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.Preferences = void 0;
-// Deprecated all of the methods in this to be removed in `0.5.0`
-class Preferences {
-    constructor(knock) {
-        this.knock = knock;
-    }
-    /**
-     * @deprecated Use `users.getAllPreferences` instead
-     */
-    getAll(userId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.knock.users.getAllPreferences(userId);
-        });
-    }
-    /**
-     * @deprecated Use `users.getPreferences` instead
-     */
-    get(userId, options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.knock.users.getPrefences(userId, options);
-        });
-    }
-    /**
-     * @deprecated Use `users.setPreferences` instead
-     */
-    set(userId, preferenceSet, options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.knock.users.setPreferences(userId, preferenceSet, options);
-        });
-    }
-    /**
-     * @deprecated Use `users.setChannelTypesPreferences` instead
-     */
-    setChannelTypes(userId, channelTypePreferences, options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.knock.users.setChannelTypesPreferences(userId, channelTypePreferences, options);
-        });
-    }
-    /**
-     * @deprecated Use `users.setChannelTypePreferences` instead
-     */
-    setChannelType(userId, channelType, setting, options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.knock.users.setChannelTypePreferences(userId, channelType, setting, options);
-        });
-    }
-    /**
-     * @deprecated Use `users.setWorkflowsPreferences` instead
-     */
-    setWorkflows(userId, workflowPreferences, options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.knock.users.setWorkflowsPreferences(userId, workflowPreferences, options);
-        });
-    }
-    /**
-     * @deprecated Use `users.setWorkflowPreferences` instead
-     */
-    setWorkflow(userId, workflowKey, setting, options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.knock.users.setWorkflowPreferences(userId, workflowKey, setting, options);
-        });
-    }
-    /**
-     * @deprecated Use `users.setCategoriesPreferences` instead
-     */
-    setCategories(userId, categoryPreferences, options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.knock.users.setCategoriesPreferences(userId, categoryPreferences, options);
-        });
-    }
-    /**
-     * @deprecated Use `users.setCategoryPreferences` instead
-     */
-    setCategory(userId, categoryKey, setting, options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.knock.users.setCategoryPreferences(userId, categoryKey, setting, options);
-        });
-    }
-}
-exports.Preferences = Preferences;