@knocklabs/node 0.4.17 → 0.4.19

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.17",
+    "version": "0.4.19",
     "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;
@@ -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/objects/index.d.ts

@@ -3,6 +3,7 @@ import { Knock } from "../../knock";
 import { AddObjectSubscriptionProperties, BulkSetObjectOption, DeleteObjectSubscriptionProperties, 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";
 import { ChannelTypePreferences, PreferenceOptions, PreferenceSet, SetPreferencesProperties, WorkflowPreferences, WorkflowPreferenceSetting } from "../preferences/interfaces";
 export declare class Objects {
     readonly knock: Knock;
@@ -33,4 +34,5 @@ export declare class Objects {
     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[]>;
+    getSchedules(collection: string, objectId: string, filteringOptions?: ListSchedulesProps): Promise<PaginatedEntriesResponse<Schedule>>;
 }

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

@@ -181,5 +181,17 @@ class Objects {
             return data;
         });
     }
+    //
+    // Schedules
+    //
+    getSchedules(collection, objectId, filteringOptions = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!collection || !objectId) {
+                throw new Error(`Incomplete arguments. You must provide a 'collection' and 'objectId'`);
+            }
+            const { data } = yield this.knock.get(`/v1/objects/${collection}/${objectId}/schedules`, filteringOptions);
+            return data;
+        });
+    }
 }
 exports.Objects = Objects;

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

@@ -2,6 +2,7 @@ import { ChannelData, ChannelType, CommonMetadata, PaginatedItemsResponse, Pagin
 import { BulkOperation } from "../bulk_operations/interfaces";
 import { ChannelTypePreferences, PreferenceOptions, PreferenceSet, SetPreferencesProperties, WorkflowPreferences, WorkflowPreferenceSetting } from "../preferences/interfaces";
 import { ListMessagesOptions, Message } from "../messages/interfaces";
+import { ListSchedulesProps, Schedule } from "../workflows/interfaces";
 import { Knock } from "../../knock";
 import { BulkIdentifyUser, IdentifyProperties, ListUserOptions, User, UserFeedOptions } from "./interfaces";
 export declare class Users {
@@ -33,4 +34,5 @@ export declare class Users {
     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<PaginatedItemsResponse<Message>>;
+    getSchedules(userId: string, filteringOptions?: ListSchedulesProps): Promise<PaginatedEntriesResponse<Schedule>>;
 }

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

@@ -212,5 +212,17 @@ class Users {
             return data;
         });
     }
+    //
+    // Schedules
+    //
+    getSchedules(userId, filteringOptions = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!userId) {
+                throw new Error(`Incomplete arguments. You must provide a 'userId'`);
+            }
+            const { data } = yield this.knock.get(`/v1/users/${userId}/schedules`, filteringOptions);
+            return data;
+        });
+    }
 }
 exports.Users = Users;

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

@@ -1,8 +1,13 @@
 import { Knock } from "../../knock";
-import { CancelWorkflowProperties, TriggerWorkflowProperties, WorkflowRun } from "./interfaces";
+import { MethodOptions, PaginatedEntriesResponse } from "../../common/interfaces";
+import { CancelWorkflowProperties, TriggerWorkflowProperties, CreateSchedulesProps, UpdateSchedulesProps, ListSchedulesProps, DeleteSchedulesProps, Schedule, 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>;
+    createSchedules(workflowKey: string, params: CreateSchedulesProps): Promise<Schedule[]>;
+    updateSchedules(params: UpdateSchedulesProps): Promise<Schedule[]>;
+    listSchedules(workflowKey: string, params?: ListSchedulesProps): Promise<PaginatedEntriesResponse<Schedule>>;
+    deleteSchedules(params: DeleteSchedulesProps): Promise<Schedule[]>;
 }

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;
         });
     }
@@ -41,5 +42,29 @@ class Workflows {
             return data;
         });
     }
+    createSchedules(workflowKey, params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.knock.post("/v1/schedules", Object.assign(Object.assign({}, params), { workflow: workflowKey }));
+            return data;
+        });
+    }
+    updateSchedules(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.knock.put("/v1/schedules", params);
+            return data;
+        });
+    }
+    listSchedules(workflowKey, params = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.knock.get("/v1/schedules", Object.assign(Object.assign({}, params), { workflow: workflowKey }));
+            return data;
+        });
+    }
+    deleteSchedules(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.knock.delete("/v1/schedules", params);
+            return data;
+        });
+    }
 }
 exports.Workflows = Workflows;

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

@@ -1,5 +1,6 @@
 import { ObjectRef, SetObjectProperties } from "../objects/interfaces";
 import { IdentifyProperties } from "../users/interfaces";
+import { PaginationOptions } from "../../common/interfaces";
 export interface TriggerWorkflowProperties<T = {
     [key: string]: any;
 }> {
@@ -15,6 +16,64 @@ export interface CancelWorkflowProperties {
 export interface WorkflowRun {
     workflow_run_id: string;
 }
+export declare enum DaysOfWeek {
+    Mon = "mon",
+    Tue = "tue",
+    Wed = "wed",
+    Thu = "thu",
+    Fri = "fri",
+    Sat = "sat",
+    Sun = "sun"
+}
+export declare enum RepeatFrequency {
+    Monthly = "monthly",
+    Weekly = "weekly",
+    Daily = "daily",
+    Hourly = "hourly"
+}
+export declare type ScheduleRepeatProperties = {
+    frequency: RepeatFrequency;
+    interval?: number;
+    day_of_month?: number;
+    days?: DaysOfWeek[] | "weekdays" | "weekends";
+    hours?: number;
+    minutes?: number;
+};
+export interface CreateSchedulesProps {
+    recipients: (Recipient | RecipientWithUpsert)[];
+    actor?: Recipient | RecipientWithUpsert | null;
+    scheduled_at?: string;
+    repeats: ScheduleRepeatProperties[];
+    tenant?: string;
+    data?: {
+        [key: string]: any;
+    };
+}
+export interface UpdateSchedulesProps extends Omit<CreateSchedulesProps, "recipients"> {
+    schedule_ids: string[];
+}
+export interface ListSchedulesProps extends PaginationOptions {
+    recipients?: Recipient[];
+    tenant?: string;
+}
+export interface DeleteSchedulesProps {
+    schedule_ids: string[];
+}
+export interface Schedule {
+    id: string;
+    recipient: Recipient;
+    actor: Recipient | null;
+    tenant: string | null;
+    workflow: string;
+    data: {
+        [key: string]: any;
+    };
+    next_occurrence_at: string;
+    inserted_at: string;
+    updated_at: string;
+    repeats: ScheduleRepeatProperties[];
+    __cursor?: string;
+}
 export declare type Recipient = string | ObjectRef;
 export declare type Actor = Recipient;
 export interface UserWithUpsert extends IdentifyProperties {

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

@@ -1,2 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.RepeatFrequency = exports.DaysOfWeek = void 0;
+var DaysOfWeek;
+(function (DaysOfWeek) {
+    DaysOfWeek["Mon"] = "mon";
+    DaysOfWeek["Tue"] = "tue";
+    DaysOfWeek["Wed"] = "wed";
+    DaysOfWeek["Thu"] = "thu";
+    DaysOfWeek["Fri"] = "fri";
+    DaysOfWeek["Sat"] = "sat";
+    DaysOfWeek["Sun"] = "sun";
+})(DaysOfWeek = exports.DaysOfWeek || (exports.DaysOfWeek = {}));
+var RepeatFrequency;
+(function (RepeatFrequency) {
+    RepeatFrequency["Monthly"] = "monthly";
+    RepeatFrequency["Weekly"] = "weekly";
+    RepeatFrequency["Daily"] = "daily";
+    RepeatFrequency["Hourly"] = "hourly";
+})(RepeatFrequency = exports.RepeatFrequency || (exports.RepeatFrequency = {}));

package/package.json

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