@knocklabs/node 0.4.5 → 0.4.8

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@knocklabs/node",
-    "version": "0.4.5",
+    "version": "0.4.8",
     "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

@@ -1,9 +1,9 @@
-import { ObjectRef } from "../objects/interfaces";
 import { PaginationOptions } from "../../common/interfaces";
+import { Recipient } from "../workflows/interfaces";
 export interface Message {
     id: string;
     channel_id: string;
-    recipient: string | ObjectRef;
+    recipient: Recipient;
     tenant: string | null;
     status: MessageStatus;
     read_at: string | null;
@@ -18,7 +18,7 @@ export interface Message {
 export interface MessageEvent {
     id: string;
     environment_id: string;
-    recipient: string | ObjectRef;
+    recipient: Recipient;
     data: Record<string, any>;
     type: string;
     inserted_at: string;
@@ -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/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,7 +13,7 @@ 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

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

@@ -1,18 +1,25 @@
-import { ObjectRef } from "../objects/interfaces";
+import { ObjectRef, SetObjectProperties } from "../objects/interfaces";
+import { IdentifyProperties } from "../users/interfaces";
 export interface TriggerWorkflowProperties<T = {
     [key: string]: any;
 }> {
-    actor?: Actor;
-    recipients?: Recipient[];
+    actor?: Actor | ActorWithUpsert;
+    recipients?: Array<Recipient | RecipientWithUpsert>;
     cancellationKey?: string;
     tenant?: string;
     data?: T;
 }
 export interface CancelWorkflowProperties {
-    recipients?: string[] | ObjectRef;
+    recipients?: Recipient[];
 }
 export interface WorkflowRun {
     workflow_run_id: string;
 }
 export declare type Recipient = string | ObjectRef;
 export declare type Actor = Recipient;
+export interface UserWithUpsert extends IdentifyProperties {
+    id: string;
+}
+export declare type ObjectWithUpsert = ObjectRef & SetObjectProperties;
+export declare type RecipientWithUpsert = UserWithUpsert | ObjectWithUpsert;
+export declare type ActorWithUpsert = RecipientWithUpsert;

package/package.json

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