@knocklabs/node 0.4.2 → 0.4.5

package/dist/package.json

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

package/dist/src/common/interfaces.d.ts

@@ -23,3 +23,23 @@ export interface ChannelData<T = CommonMetadata> {
 }
 export interface SetChannelDataProperties {
 }
+declare type PageInfo = {
+    before: string;
+    after: string;
+    page_size: number;
+};
+export interface PaginatedResponse<T> {
+    entries: T[];
+    page_info: PageInfo;
+}
+export interface PaginationOptions {
+    page_size?: number;
+    after?: string;
+    before?: string;
+}
+export interface Condition {
+    argument: string;
+    variable: string;
+    operator: string;
+}
+export {};

package/dist/src/knock.d.ts

@@ -6,6 +6,7 @@ import { Workflows } from "./resources/workflows";
 import { TriggerWorkflowProperties } from "./resources/workflows/interfaces";
 import { BulkOperations } from "./resources/bulk_operations";
 import { Objects } from "./resources/objects";
+import { Messages } from "./resources/messages";
 declare class Knock {
     readonly key?: string | undefined;
     readonly options: KnockOptions;
@@ -16,6 +17,7 @@ declare class Knock {
     readonly workflows: Workflows;
     readonly bulkOperations: BulkOperations;
     readonly objects: Objects;
+    readonly messages: Messages;
     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>;

package/dist/src/knock.js

@@ -21,6 +21,7 @@ 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");
+const messages_1 = require("./resources/messages");
 const DEFAULT_HOSTNAME = "https://api.knock.app";
 class Knock {
     constructor(key, options = {}) {
@@ -32,6 +33,7 @@ class Knock {
         this.workflows = new workflows_1.Workflows(this);
         this.bulkOperations = new bulk_operations_1.BulkOperations(this);
         this.objects = new objects_1.Objects(this);
+        this.messages = new messages_1.Messages(this);
         if (!key) {
             this.key = process.env.KNOCK_API_KEY;
             if (!this.key) {

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

@@ -0,0 +1,11 @@
+import { User } from "../users/interfaces";
+import { Object } from "../objects/interfaces";
+export interface Activity {
+    id: string;
+    data: Record<string, any>;
+    actor: User | Object;
+    recipient: User | Object;
+    inserted_at: string;
+    updated_at: string;
+    __cursor?: string;
+}

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

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

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

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

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

@@ -0,0 +1,60 @@
+"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.Messages = void 0;
+class Messages {
+    constructor(knock) {
+        this.knock = knock;
+    }
+    list(filteringOptions = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.knock.get("/v1/messages", filteringOptions);
+            return data;
+        });
+    }
+    get(messageId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!messageId) {
+                throw new Error(`Incomplete arguments. You must provide a 'messageId'`);
+            }
+            const { data } = yield this.knock.get(`/v1/messages/${messageId}`);
+            return data;
+        });
+    }
+    getContent(messageId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!messageId) {
+                throw new Error(`Incomplete arguments. You must provide a 'messageId'`);
+            }
+            const { data } = yield this.knock.get(`/v1/messages/${messageId}/content`);
+            return data;
+        });
+    }
+    getEvents(messageId, paginationOptions = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!messageId) {
+                throw new Error(`Incomplete arguments. You must provide a 'messageId'`);
+            }
+            const { data } = yield this.knock.get(`/v1/messages/${messageId}/events`, paginationOptions);
+            return data;
+        });
+    }
+    getActivities(messageId, paginationOptions = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!messageId) {
+                throw new Error(`Incomplete arguments. You must provide a 'messageId'`);
+            }
+            const { data } = yield this.knock.get(`/v1/messages/${messageId}/activities`, paginationOptions);
+            return data;
+        });
+    }
+}
+exports.Messages = Messages;

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

@@ -0,0 +1,43 @@
+import { ObjectRef } from "../objects/interfaces";
+import { PaginationOptions } from "../../common/interfaces";
+export interface Message {
+    id: string;
+    channel_id: string;
+    recipient: string | ObjectRef;
+    tenant: string | null;
+    status: MessageStatus;
+    read_at: string | null;
+    seen_at: string | null;
+    archived_at: string | null;
+    inserted_at: string;
+    updated_at: string;
+    source: WorkflowSource;
+    data: any;
+    __cursor?: string;
+}
+export interface MessageEvent {
+    id: string;
+    environment_id: string;
+    recipient: string | ObjectRef;
+    data: Record<string, any>;
+    type: string;
+    inserted_at: string;
+    __cursor?: string;
+}
+export interface MessageContent {
+    id: string;
+    data: Record<string, any>;
+    inserted_at: string;
+}
+export interface ListMessagesOptions extends PaginationOptions {
+    source?: string;
+    tenant?: string;
+    status?: MessageStatus[];
+    channel_id?: string;
+}
+declare type WorkflowSource = {
+    version_id: string;
+    key: string;
+};
+declare type MessageStatus = "queued" | "sent" | "delivered" | "undelivered" | "not_sent";
+export {};

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

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

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

@@ -1,7 +1,9 @@
-import { ChannelData, CommonMetadata, SetChannelDataProperties } 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);
@@ -12,4 +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,5 +63,96 @@ 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
+    //
+    getMessages(collection, objectId, filteringOptions = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!collection || !objectId) {
+                throw new Error(`Incomplete arguments. You must provide a 'collection' and 'objectId'`);
+            }
+            const { data } = yield this.knock.get(`/v1/objects/${collection}/${objectId}/messages`, filteringOptions);
+            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/preferences/helpers.d.ts

@@ -1,5 +1,5 @@
 import { WorkflowPreferenceSetting } from "./interfaces";
-export declare function buildUpdateParam(param: WorkflowPreferenceSetting): {
+export declare function buildUpdateParam(param: WorkflowPreferenceSetting): import("./interfaces").ConditionalPreferenceSettings | {
     channel_types: import("./interfaces").ChannelTypePreferences;
 } | {
     subscribed: boolean;

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

@@ -1,10 +1,13 @@
-import { ChannelType } from "../../common/interfaces";
+import { ChannelType, Condition } from "../../common/interfaces";
+export declare type ConditionalPreferenceSettings = {
+    conditions: Condition[];
+};
 export declare type ChannelTypePreferences = {
-    [K in ChannelType]: boolean;
+    [K in ChannelType]?: boolean | ConditionalPreferenceSettings;
 };
 export declare type WorkflowPreferenceSetting = boolean | {
     channel_types: ChannelTypePreferences;
-};
+} | ConditionalPreferenceSettings;
 export interface WorkflowPreferences {
     [key: string]: WorkflowPreferenceSetting;
 }

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

@@ -1,6 +1,7 @@
-import { ChannelData, ChannelType, CommonMetadata } from "../../common/interfaces";
+import { ChannelData, ChannelType, CommonMetadata, PaginatedResponse } from "../../common/interfaces";
 import { BulkOperation } from "../bulk_operations/interfaces";
 import { ChannelTypePreferences, PreferenceOptions, PreferenceSet, SetPreferencesProperties, WorkflowPreferences, WorkflowPreferenceSetting } from "../preferences/interfaces";
+import { ListMessagesOptions, Message } from "../messages/interfaces";
 import { Knock } from "../../knock";
 import { BulkIdentifyUser, IdentifyProperties, User, UserFeedOptions } from "./interfaces";
 export declare class Users {
@@ -14,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>;
@@ -24,5 +29,7 @@ export declare class Users {
     setCategoriesPreferences(userId: string, categoryPreferences: WorkflowPreferences, options?: PreferenceOptions): Promise<PreferenceSet>;
     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, 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,5 +185,26 @@ 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
+    //
+    getMessages(userId, filteringOptions = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!userId) {
+                throw new Error(`Incomplete arguments. You must provide a 'userId'`);
+            }
+            const { data } = yield this.knock.get(`/v1/users/${userId}/messages`, filteringOptions);
+            return data;
+        });
+    }
 }
 exports.Users = Users;

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

@@ -1,3 +1,4 @@
+import { PaginationOptions } from "../../common/interfaces";
 export interface IdentifyProperties {
     name?: string;
     email?: string;
@@ -16,10 +17,7 @@ export interface User {
 export interface BulkIdentifyUser extends IdentifyProperties {
     id: string;
 }
-export interface UserFeedOptions {
-    page_size?: number;
-    after?: string;
-    before?: string;
+export interface UserFeedOptions extends PaginationOptions {
     source?: string;
     tenant?: string;
     status?: "unread" | "unseen" | "all";

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.2",
+  "version": "0.4.5",
   "description": "Library for interacting with the Knock API",
   "homepage": "https://github.com/knocklabs/knock-node",
   "author": "@knocklabs",