@knocklabs/node 0.6.17 → 0.6.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/package.json
CHANGED
|
@@ -10,7 +10,7 @@ export declare class Messages {
|
|
|
10
10
|
getContent(messageId: string): Promise<MessageContent>;
|
|
11
11
|
getEvents(messageId: string, paginationOptions?: PaginationOptions): Promise<PaginatedItemsResponse<MessageEvent>>;
|
|
12
12
|
getActivities(messageId: string, filteringOptions?: ListMessageActivitiesOptions): Promise<PaginatedItemsResponse<Activity>>;
|
|
13
|
-
setStatus(messageId: string, status: Exclude<MessageEngagementStatus, "link_clicked">): Promise<Message>;
|
|
13
|
+
setStatus(messageId: string, status: Exclude<MessageEngagementStatus, "link_clicked">, metadata?: Record<string, any>): Promise<Message>;
|
|
14
14
|
deleteStatus(messageId: string, status: Exclude<MessageEngagementStatus, "link_clicked">): Promise<Message>;
|
|
15
|
-
batchSetStatus(messageIds: string[], status: Exclude<MessageEngagementStatus, "link_clicked"> | "unseen" | "unread" | "unarchived"): Promise<Message[]>;
|
|
15
|
+
batchSetStatus(messageIds: string[], status: Exclude<MessageEngagementStatus, "link_clicked"> | "unseen" | "unread" | "unarchived", metadata?: Record<string, any>): Promise<Message[]>;
|
|
16
16
|
}
|
|
@@ -56,12 +56,15 @@ class Messages {
|
|
|
56
56
|
return data;
|
|
57
57
|
});
|
|
58
58
|
}
|
|
59
|
-
setStatus(messageId, status) {
|
|
59
|
+
setStatus(messageId, status, metadata) {
|
|
60
60
|
return __awaiter(this, void 0, void 0, function* () {
|
|
61
61
|
if (!messageId) {
|
|
62
62
|
throw new Error(`Incomplete arguments. You must provide a 'messageId'`);
|
|
63
63
|
}
|
|
64
|
-
|
|
64
|
+
if (status !== "interacted" && metadata) {
|
|
65
|
+
throw new Error(`Metadata is only supported for 'interacted' status.`);
|
|
66
|
+
}
|
|
67
|
+
const { data } = yield this.knock.put(`/v1/messages/${messageId}/${status}`, { metadata });
|
|
65
68
|
return data;
|
|
66
69
|
});
|
|
67
70
|
}
|
|
@@ -74,10 +77,14 @@ class Messages {
|
|
|
74
77
|
return data;
|
|
75
78
|
});
|
|
76
79
|
}
|
|
77
|
-
batchSetStatus(messageIds, status) {
|
|
80
|
+
batchSetStatus(messageIds, status, metadata) {
|
|
78
81
|
return __awaiter(this, void 0, void 0, function* () {
|
|
82
|
+
if (status !== "interacted" && metadata) {
|
|
83
|
+
throw new Error(`Metadata is only supported for 'interacted' status.`);
|
|
84
|
+
}
|
|
79
85
|
const { data } = yield this.knock.post(`/v1/messages/batch/${status}`, {
|
|
80
86
|
message_ids: messageIds,
|
|
87
|
+
metadata,
|
|
81
88
|
});
|
|
82
89
|
return data;
|
|
83
90
|
});
|
|
@@ -42,6 +42,8 @@ export interface ListMessagesOptions extends PaginationOptions {
|
|
|
42
42
|
"inserted_at.gte"?: string;
|
|
43
43
|
"inserted_at.lt"?: string;
|
|
44
44
|
"inserted_at.lte"?: string;
|
|
45
|
+
workflow_run_id?: string;
|
|
46
|
+
workflow_recipient_run_id?: string;
|
|
45
47
|
}
|
|
46
48
|
export interface ListMessageActivitiesOptions extends PaginationOptions {
|
|
47
49
|
trigger_data?: Record<string, any>;
|