@knocklabs/node 0.4.16 → 0.4.18

package/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.4.18
+
+* Introduce "Idempotency-Key" header for workflow triggers

package/dist/package.json

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

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

@@ -9,6 +9,9 @@ export interface PostAndPutOptions {
     query?: {
         [key: string]: any;
     };
+    headers?: {
+        [key: string]: any;
+    };
 }
 export interface UnprocessableEntityError {
     message: string;
@@ -28,11 +31,11 @@ declare type PageInfo = {
     after: string;
     page_size: number;
 };
-export interface PaginatedFeedResponse<T> {
+export interface PaginatedEntriesResponse<T> {
     entries: T[];
     page_info: PageInfo;
 }
-export interface PaginatedResponse<T> {
+export interface PaginatedItemsResponse<T> {
     items: T[];
     page_info: PageInfo;
 }
@@ -54,4 +57,7 @@ export interface SignUserTokenOptions {
     /** The expiration time of the token in seconds. Defaults to 1 hour. */
     expiresInSeconds?: number;
 }
+export interface MethodOptions {
+    idempotencyKey?: string;
+}
 export {};

package/dist/src/knock.d.ts

@@ -1,5 +1,5 @@
 import { AxiosResponse } from "axios";
-import { KnockOptions, PostAndPutOptions, SignUserTokenOptions } from "./common/interfaces";
+import { KnockOptions, PostAndPutOptions, SignUserTokenOptions, MethodOptions } from "./common/interfaces";
 import { Users } from "./resources/users";
 import { Preferences } from "./resources/preferences";
 import { Workflows } from "./resources/workflows";
@@ -21,7 +21,7 @@ declare class Knock {
     readonly messages: Messages;
     readonly tenants: Tenants;
     constructor(key?: string | undefined, options?: KnockOptions);
-    notify(workflowKey: string, properties: TriggerWorkflowProperties): Promise<import("./resources/workflows/interfaces").WorkflowRun>;
+    notify(workflowKey: string, properties: TriggerWorkflowProperties, options?: MethodOptions): Promise<import("./resources/workflows/interfaces").WorkflowRun>;
     /**
      * Generate JWT for authenticating client-side requests (e.g. in-app feeds)
      * For more information, visit https://docs.knock.app/in-app-ui/security-and-authentication#authentication-with-enhanced-security-enabled

package/dist/src/knock.js

@@ -53,9 +53,9 @@ class Knock {
         });
     }
     // Delegate the notify function to the workflows trigger
-    notify(workflowKey, properties) {
+    notify(workflowKey, properties, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.workflows.trigger(workflowKey, properties);
+            return this.workflows.trigger(workflowKey, properties, options);
         });
     }
     /**
@@ -86,6 +86,7 @@ class Knock {
             try {
                 return yield this.client.post(path, entity, {
                     params: options.query,
+                    headers: options.headers,
                 });
             }
             catch (error) {

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

@@ -1,15 +1,15 @@
-import { PaginatedResponse, PaginationOptions } from "../../common/interfaces";
+import { PaginatedItemsResponse, PaginationOptions } from "../../common/interfaces";
 import { Message, MessageContent, MessageEvent, ListMessageActivitiesOptions, 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<PaginatedResponse<Message>>;
+    list(filteringOptions?: ListMessagesOptions): Promise<PaginatedItemsResponse<Message>>;
     get(messageId: string): Promise<Message>;
     getContent(messageId: string): Promise<MessageContent>;
-    getEvents(messageId: string, paginationOptions?: PaginationOptions): Promise<PaginatedResponse<MessageEvent>>;
-    getActivities(messageId: string, filteringOptions?: ListMessageActivitiesOptions): Promise<PaginatedResponse<Activity>>;
+    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[]>;

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

@@ -1,4 +1,4 @@
-import { ChannelData, CommonMetadata, SetChannelDataProperties, PaginatedResponse, ChannelType } from "../../common/interfaces";
+import { ChannelData, CommonMetadata, SetChannelDataProperties, PaginatedEntriesResponse, ChannelType, PaginatedItemsResponse } from "../../common/interfaces";
 import { Knock } from "../../knock";
 import { AddObjectSubscriptionProperties, BulkSetObjectOption, DeleteObjectSubscriptionProperties, ListObjectOptions, ListObjectSubscriptionsOptions, Object, ObjectSubscription, SetObjectProperties } from "./interfaces";
 import { BulkOperation } from "../bulk_operations/interfaces";
@@ -9,14 +9,14 @@ export declare class Objects {
     constructor(knock: Knock);
     get<T = CommonMetadata>(collection: string, id: string): Promise<Object<T>>;
     set<T = CommonMetadata>(collection: string, id: string, properties: SetObjectProperties): Promise<Object<T>>;
-    list<T = CommonMetadata>(collection: string, filteringOptions?: ListObjectOptions): Promise<PaginatedResponse<Object<T>>>;
+    list<T = CommonMetadata>(collection: string, filteringOptions?: ListObjectOptions): Promise<PaginatedEntriesResponse<Object<T>>>;
     bulkSet(collection: string, objects: BulkSetObjectOption[]): Promise<BulkOperation>;
     delete(collection: string, id: string): Promise<null>;
     bulkDelete(collection: string, objectIds: string[]): Promise<BulkOperation>;
     getChannelData<T = CommonMetadata>(collection: string, id: string, channelId: string): Promise<ChannelData<T>>;
     setChannelData<T = CommonMetadata>(collection: string, id: string, channelId: string, channelData: SetChannelDataProperties): Promise<ChannelData<T>>;
     unsetChannelData(collection: string, id: string, channelId: string): Promise<any>;
-    getMessages(collection: string, objectId: string, filteringOptions?: ListMessagesOptions): Promise<PaginatedResponse<Message>>;
+    getMessages(collection: string, objectId: string, filteringOptions?: ListMessagesOptions): Promise<PaginatedItemsResponse<Message>>;
     getAllPreferences(collection: string, objectId: string): Promise<PreferenceSet[]>;
     /**
      * @deprecated Use `objects.getPreferences` instead
@@ -30,7 +30,7 @@ export declare class Objects {
     setWorkflowPreferences(collection: string, objectId: string, workflowKey: string, setting: WorkflowPreferenceSetting, options?: PreferenceOptions): Promise<PreferenceSet>;
     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<PaginatedResponse<ObjectSubscription>>;
+    listSubscriptions(collection: string, objectId: string, options?: ListObjectSubscriptionsOptions): Promise<PaginatedEntriesResponse<ObjectSubscription>>;
     addSubscriptions(collection: string, objectId: string, properties?: AddObjectSubscriptionProperties): Promise<ObjectSubscription[]>;
     deleteSubscriptions(collection: string, objectId: string, properties?: DeleteObjectSubscriptionProperties): Promise<ObjectSubscription[]>;
 }

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

@@ -1,10 +1,10 @@
-import { CommonMetadata, PaginatedResponse } from "../../common/interfaces";
+import { CommonMetadata, PaginatedEntriesResponse } from "../../common/interfaces";
 import { Knock } from "../../knock";
 import { Tenant, SetTenant, ListTenantsOptions } from "./interfaces";
 export declare class Tenants {
     readonly knock: Knock;
     constructor(knock: Knock);
-    list(filteringOptions?: ListTenantsOptions): Promise<PaginatedResponse<Tenant>>;
+    list(filteringOptions?: ListTenantsOptions): Promise<PaginatedEntriesResponse<Tenant>>;
     get<T = CommonMetadata>(id: string): Promise<Tenant<T>>;
     set<T = CommonMetadata>(id: string, tenantData: SetTenant): Promise<Tenant<T>>;
     delete(id: string): Promise<null>;

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

@@ -1,4 +1,4 @@
-import { ChannelData, ChannelType, CommonMetadata, PaginatedFeedResponse, PaginatedResponse } from "../../common/interfaces";
+import { ChannelData, ChannelType, CommonMetadata, PaginatedItemsResponse, PaginatedEntriesResponse } 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";
@@ -10,11 +10,11 @@ export declare class Users {
     identify(userId: string, properties?: IdentifyProperties): Promise<User>;
     bulkIdentify(users: BulkIdentifyUser[]): Promise<BulkOperation>;
     get(userId: string): Promise<User>;
-    list(filteringOptions?: ListUserOptions): Promise<PaginatedResponse<User>>;
+    list(filteringOptions?: ListUserOptions): Promise<PaginatedEntriesResponse<User>>;
     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<PaginatedFeedResponse<any>>;
+    getFeed(userId: string, channelId: string, feedOptions?: UserFeedOptions): Promise<PaginatedEntriesResponse<any>>;
     getAllPreferences(userId: string): Promise<any>;
     /**
      * @deprecated Use `users.getPreferences` instead
@@ -32,5 +32,5 @@ export declare class Users {
     getChannelData<T = CommonMetadata>(userId: string, channelId: string): Promise<ChannelData<T>>;
     setChannelData<T = CommonMetadata>(userId: string, channelId: string, channelData: Record<string, any>): Promise<ChannelData<T>>;
     unsetChannelData(userId: string, channelId: string): Promise<any>;
-    getMessages(userId: string, filteringOptions?: ListMessagesOptions): Promise<PaginatedResponse<Message>>;
+    getMessages(userId: string, filteringOptions?: ListMessagesOptions): Promise<PaginatedItemsResponse<Message>>;
 }

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

@@ -1,8 +1,9 @@
 import { Knock } from "../../knock";
+import { MethodOptions } from "../../common/interfaces";
 import { CancelWorkflowProperties, TriggerWorkflowProperties, WorkflowRun } from "./interfaces";
 export declare class Workflows {
     readonly knock: Knock;
     constructor(knock: Knock);
-    trigger(workflowKey: string, { actor, recipients, cancellationKey, tenant, data: notifyData, }: TriggerWorkflowProperties): Promise<WorkflowRun>;
+    trigger(workflowKey: string, { actor, recipients, cancellationKey, tenant, data: notifyData, }: TriggerWorkflowProperties, { idempotencyKey }?: MethodOptions): Promise<WorkflowRun>;
     cancel(workflowKey: string, cancellationKey: string, { recipients }?: CancelWorkflowProperties): Promise<any>;
 }

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

@@ -14,18 +14,19 @@ class Workflows {
     constructor(knock) {
         this.knock = knock;
     }
-    trigger(workflowKey, { actor, recipients, cancellationKey, tenant, data: notifyData, }) {
+    trigger(workflowKey, { actor, recipients, cancellationKey, tenant, data: notifyData, }, { idempotencyKey } = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!workflowKey && !recipients) {
                 throw new Error(`Incomplete arguments. At a minimum you need to specify 'workflowKey' and 'recipients'.`);
             }
+            const options = idempotencyKey ? { headers: { 'Idempotency-Key': idempotencyKey } } : {};
             const { data } = yield this.knock.post(`/v1/workflows/${workflowKey}/trigger`, {
                 actor,
                 recipients,
                 cancellation_key: cancellationKey,
                 tenant,
                 data: notifyData,
-            });
+            }, options);
             return data;
         });
     }

package/package.json

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