@knocklabs/node 0.6.7 → 0.6.10

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

package/dist/src/common/fetchClient.js

@@ -69,6 +69,9 @@ class FetchClient {
     }
     buildUrl(path, params) {
         const url = new URL(this.config.baseURL + path);
+        function containsObject(array) {
+            return array.some((item) => typeof item === "object" && item !== null);
+        }
         function appendParams(key, value, parentKey) {
             const fullKey = parentKey ? `${parentKey}[${key}]` : key;
             if (typeof value === "object" &&
@@ -80,6 +83,22 @@ class FetchClient {
                     appendParams(nestedKey, nestedValue, fullKey);
                 });
             }
+            else if (Array.isArray(value) && containsObject(value)) {
+                // Send array values as individual values with identifier
+                // e.g. key[0]=user1&key[1]=userid2&key[3][field1Key]=field1Value&key[3][field2Key]=field2Value
+                value.forEach((item, index) => {
+                    const indexKey = index.toString();
+                    if (typeof item === "string") {
+                        url.searchParams.append(`${fullKey}[${indexKey}]`, item);
+                    }
+                    else if (typeof item === "object" && item !== null) {
+                        Object.entries(item).forEach(([key, val]) => {
+                            const strVal = val;
+                            url.searchParams.append(`${fullKey}[${indexKey}][${key}]`, strVal);
+                        });
+                    }
+                });
+            }
             else if (Array.isArray(value)) {
                 // Send array values as individual values instead of a comma separated list
                 // e.g. key[]=1&key[]=2&key[]=3 instead of key=1,2,3

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/index.d.ts

@@ -1,6 +1,6 @@
 import { ChannelData, CommonMetadata, SetChannelDataProperties, PaginatedEntriesResponse, ChannelType, PaginatedItemsResponse } from "../../common/interfaces";
 import { Knock } from "../../knock";
-import { AddObjectSubscriptionProperties, BulkAddSubscriptionsOption, BulkSetObjectOption, DeleteObjectSubscriptionProperties, ListObjectOptions, ListObjectSubscriptionsOptions, Object, ObjectSubscription, SetObjectProperties } from "./interfaces";
+import { AddObjectSubscriptionProperties, BulkAddSubscriptionsOption, BulkSetObjectOption, DeleteObjectSubscriptionProperties, GetObjectSubscriptionsOptions, ListObjectOptions, ListObjectSubscriptionsOptions, Object, ObjectSubscription, SetObjectProperties } from "./interfaces";
 import { BulkOperation } from "../bulk_operations/interfaces";
 import { ListMessagesOptions, Message } from "../messages/interfaces";
 import { ListSchedulesProps, Schedule } from "../workflows/interfaces";
@@ -29,7 +29,7 @@ export declare class Objects {
     setCategoriesPreferences(collection: string, objectId: string, categoryPreferences: WorkflowPreferences, options?: PreferenceOptions): Promise<PreferenceSet>;
     setCategoryPreferences(collection: string, objectId: string, categoryKey: string, setting: WorkflowPreferenceSetting, options?: PreferenceOptions): Promise<PreferenceSet>;
     listSubscriptions(collection: string, objectId: string, options?: ListObjectSubscriptionsOptions): Promise<PaginatedEntriesResponse<ObjectSubscription>>;
-    getSubscriptions(collection: string, objectId: string, options?: ListObjectSubscriptionsOptions): Promise<PaginatedEntriesResponse<ObjectSubscription>>;
+    getSubscriptions(collection: string, objectId: string, options?: GetObjectSubscriptionsOptions): Promise<PaginatedEntriesResponse<ObjectSubscription>>;
     addSubscriptions(collection: string, objectId: string, properties?: AddObjectSubscriptionProperties): Promise<ObjectSubscription[]>;
     deleteSubscriptions(collection: string, objectId: string, properties?: DeleteObjectSubscriptionProperties): Promise<ObjectSubscription[]>;
     getSchedules(collection: string, objectId: string, filteringOptions?: ListSchedulesProps): Promise<PaginatedEntriesResponse<Schedule>>;

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

@@ -27,10 +27,13 @@ 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[];
+}
+export interface GetObjectSubscriptionsOptions extends PaginationOptions {
+    objects?: ObjectRef[];
 }
 export interface ObjectSubscription<T = CommonMetadata> {
     recipient: User | Object;

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

@@ -1,4 +1,5 @@
 import { PaginationOptions } from "../../common/interfaces";
+import { ObjectRef } from "../objects/interfaces";
 export interface IdentifyProperties {
     name?: string;
     email?: string;
@@ -26,9 +27,8 @@ 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.7",
+  "version": "0.6.10",
   "description": "Library for interacting with the Knock API",
   "homepage": "https://github.com/knocklabs/knock-node",
   "author": "@knocklabs",