@knocklabs/node 0.4.4 → 0.4.7

package/dist/package.json

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

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

@@ -28,10 +28,14 @@ declare type PageInfo = {
     after: string;
     page_size: number;
 };
-export interface PaginatedResponse<T> {
+export interface PaginatedFeedResponse<T> {
     entries: T[];
     page_info: PageInfo;
 }
+export interface PaginatedResponse<T> {
+    items: T[];
+    page_info: PageInfo;
+}
 export interface PaginationOptions {
     page_size?: number;
     after?: string;

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

@@ -1,13 +1,16 @@
 import { PaginatedResponse, PaginationOptions } from "../../common/interfaces";
-import { Message, MessageContent, MessageEvent, ListMessagesOptions } from "./interfaces";
+import { Message, MessageContent, MessageEvent, ListMessagesOptions, MessageEngagementStatus } 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>;
+    list(filteringOptions?: ListMessagesOptions): Promise<PaginatedResponse<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>>;
+    setStatus(messageId: string, status: MessageEngagementStatus): Promise<Message>;
+    deleteStatus(messageId: string, status: MessageEngagementStatus): Promise<Message>;
+    batchSetStatus(messageIds: string[], status: MessageEngagementStatus | "unseen" | "unread" | "unarchived"): Promise<Message[]>;
 }

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

@@ -56,5 +56,31 @@ class Messages {
             return data;
         });
     }
+    setStatus(messageId, status) {
+        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.put(`/v1/messages/${messageId}/${status}`, {});
+            return data;
+        });
+    }
+    deleteStatus(messageId, status) {
+        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.delete(`/v1/messages/${messageId}/${status}`);
+            return data;
+        });
+    }
+    batchSetStatus(messageIds, status) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.knock.post(`/v1/messages/batch/${status}`, {
+                message_ids: messageIds,
+            });
+            return data;
+        });
+    }
 }
 exports.Messages = Messages;

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

@@ -40,4 +40,5 @@ declare type WorkflowSource = {
     key: string;
 };
 declare type MessageStatus = "queued" | "sent" | "delivered" | "undelivered" | "not_sent";
+export declare type MessageEngagementStatus = "seen" | "read" | "archived";
 export {};

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

@@ -17,7 +17,11 @@ export declare class Objects {
     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>;

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

@@ -90,7 +90,15 @@ 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}`);

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

@@ -1,4 +1,4 @@
-import { ChannelData, ChannelType, CommonMetadata, PaginatedResponse } from "../../common/interfaces";
+import { ChannelData, ChannelType, CommonMetadata, PaginatedFeedResponse, 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";
@@ -13,9 +13,13 @@ export declare class Users {
     delete(userId: string): Promise<null>;
     bulkDelete(userIds: string[]): Promise<BulkOperation>;
     merge(toUserId: string, fromUserId: string): Promise<User>;
-    getFeed(userId: string, channelId: string, feedOptions?: UserFeedOptions): Promise<any>;
+    getFeed(userId: string, channelId: string, feedOptions?: UserFeedOptions): Promise<PaginatedFeedResponse<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>;

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}`);

package/package.json

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