@knocklabs/node 0.6.8 → 0.6.11

package/README.md

@@ -42,7 +42,7 @@ const { Knock } = require("@knocklabs/node");
 const knockClient = new Knock("sk_12345");
 
 // The key of the workflow (from Knock dashboard)
-await knockClient.notify("dinosaurs-loose", {
+await knockClient.workflows.trigger("dinosaurs-loose", {
   // user id of who performed the action
   actor: "dnedry",
   // list of user ids for who should receive the notification

package/dist/package.json

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

package/dist/src/common/fetchClient.js

@@ -74,6 +74,9 @@ class FetchClient {
         }
         function appendParams(key, value, parentKey) {
             const fullKey = parentKey ? `${parentKey}[${key}]` : key;
+            // Skip undefined values
+            if (value === undefined)
+                return;
             if (typeof value === "object" &&
                 value !== null &&
                 !(value instanceof Date) &&

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

@@ -10,7 +10,7 @@ export declare class Messages {
     getContent(messageId: string): Promise<MessageContent>;
     getEvents(messageId: string, paginationOptions?: PaginationOptions): Promise<PaginatedItemsResponse<MessageEvent>>;
     getActivities(messageId: string, filteringOptions?: ListMessageActivitiesOptions): Promise<PaginatedItemsResponse<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[]>;
+    setStatus(messageId: string, status: Exclude<MessageEngagementStatus, "link_clicked">): Promise<Message>;
+    deleteStatus(messageId: string, status: Exclude<MessageEngagementStatus, "link_clicked">): Promise<Message>;
+    batchSetStatus(messageIds: string[], status: Exclude<MessageEngagementStatus, "link_clicked"> | "unseen" | "unread" | "unarchived"): Promise<Message[]>;
 }

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

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

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

@@ -27,8 +27,7 @@ export interface BulkAddSubscriptionsOption<T = CommonMetadata> {
     recipients: (IdentifyUserProperties | SetObjectProperties | string)[];
 }
 export interface ListObjectOptions extends PaginationOptions {
-    object_id?: string;
-    name?: string;
+    include?: Array<"preferences">;
 }
 export interface ListObjectSubscriptionsOptions extends PaginationOptions {
     recipients?: Recipient[];

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

@@ -27,9 +27,7 @@ export interface UserFeedOptions extends PaginationOptions {
     trigger_data?: Record<string, any>;
 }
 export interface ListUserOptions extends PaginationOptions {
-    name?: string;
-    email?: string;
-    user_id?: string;
+    include?: Array<"preferences">;
 }
 export interface ListSubscriptionsOptions extends PaginationOptions {
     objects?: ObjectRef[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/node",
-  "version": "0.6.8",
+  "version": "0.6.11",
   "description": "Library for interacting with the Knock API",
   "homepage": "https://github.com/knocklabs/knock-node",
   "author": "@knocklabs",
@@ -45,4 +45,4 @@
   "engines": {
     "node": ">=17.5.0"
   }
-}
+}