@knocklabs/node 0.6.19 → 1.1.0

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

@@ -1,232 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Users = void 0;
-const helpers_1 = require("../preferences/helpers");
-class Users {
-    constructor(knock) {
-        this.knock = knock;
-    }
-    //
-    // User management
-    //
-    identify(userId, properties = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!userId) {
-                throw new Error(`Incomplete arguments. At a minimum you need to specify 'userId'.`);
-            }
-            const { data } = yield this.knock.put(`/v1/users/${userId}`, properties);
-            return data;
-        });
-    }
-    bulkIdentify(users) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const attrs = { users };
-            const { data } = yield this.knock.post(`/v1/users/bulk/identify`, attrs);
-            return data;
-        });
-    }
-    get(userId) {
-        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}`);
-            return data;
-        });
-    }
-    list(filteringOptions = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.knock.get(`/v1/users`, filteringOptions);
-            return data;
-        });
-    }
-    delete(userId) {
-        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.delete(`/v1/users/${userId}`);
-            return data;
-        });
-    }
-    bulkDelete(userIds) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const attrs = { user_ids: userIds };
-            const { data } = yield this.knock.post(`/v1/users/bulk/delete`, attrs);
-            return data;
-        });
-    }
-    merge(toUserId, fromUserId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!toUserId || !fromUserId) {
-                throw new Error(`Incomplete arguments. You must provide both a 'toUserId' and a 'fromUserId'.`);
-            }
-            const { data } = yield this.knock.post(`/v1/users/${toUserId}/merge`, {
-                from_user_id: fromUserId,
-            });
-            return data;
-        });
-    }
-    //
-    // Feeds
-    //
-    getFeed(userId, channelId, feedOptions = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.knock.get(`/v1/users/${userId}/feeds/${channelId}`, feedOptions);
-            return data;
-        });
-    }
-    //
-    // Preferences
-    //
-    getAllPreferences(userId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.knock.get(`/v1/users/${userId}/preferences`);
-            return data;
-        });
-    }
-    getPreferences(userId, options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const preferenceSetId = options.preferenceSet || helpers_1.DEFAULT_PREFERENCE_SET_ID;
-            const { data, } = yield this.knock.get(`/v1/users/${userId}/preferences/${preferenceSetId}`, { tenant: options.tenant });
-            return data;
-        });
-    }
-    setPreferences(userId, preferenceSet, options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const preferenceSetId = options.preferenceSet || helpers_1.DEFAULT_PREFERENCE_SET_ID;
-            const { data } = yield this.knock.put(`/v1/users/${userId}/preferences/${preferenceSetId}`, preferenceSet);
-            return data;
-        });
-    }
-    bulkSetPreferences(userIds, preferenceSet, options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const preferenceSetId = options.preferenceSet || helpers_1.DEFAULT_PREFERENCE_SET_ID;
-            const attrs = {
-                user_ids: userIds,
-                preferences: Object.assign(Object.assign({}, preferenceSet), { id: preferenceSetId }),
-            };
-            const { data } = yield this.knock.post(`/v1/users/bulk/preferences`, attrs);
-            return data;
-        });
-    }
-    setChannelTypesPreferences(userId, channelTypePreferences, options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const preferenceSetId = options.preferenceSet || helpers_1.DEFAULT_PREFERENCE_SET_ID;
-            const { data } = yield this.knock.put(`/v1/users/${userId}/preferences/${preferenceSetId}/channel_types`, channelTypePreferences);
-            return data;
-        });
-    }
-    setChannelTypePreferences(userId, channelType, setting, options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const preferenceSetId = options.preferenceSet || helpers_1.DEFAULT_PREFERENCE_SET_ID;
-            const { data, } = yield this.knock.put(`/v1/users/${userId}/preferences/${preferenceSetId}/channel_types/${channelType}`, { subscribed: setting });
-            return data;
-        });
-    }
-    setWorkflowsPreferences(userId, workflowPreferences, options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const preferenceSetId = options.preferenceSet || helpers_1.DEFAULT_PREFERENCE_SET_ID;
-            const { data } = yield this.knock.put(`/v1/users/${userId}/preferences/${preferenceSetId}/workflows`, workflowPreferences);
-            return data;
-        });
-    }
-    setWorkflowPreferences(userId, workflowKey, setting, options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const preferenceSetId = options.preferenceSet || helpers_1.DEFAULT_PREFERENCE_SET_ID;
-            const { data } = yield this.knock.put(`/v1/users/${userId}/preferences/${preferenceSetId}/workflows/${workflowKey}`, (0, helpers_1.buildUpdateParam)(setting));
-            return data;
-        });
-    }
-    setCategoriesPreferences(userId, categoryPreferences, options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const preferenceSetId = options.preferenceSet || helpers_1.DEFAULT_PREFERENCE_SET_ID;
-            const { data } = yield this.knock.put(`/v1/users/${userId}/preferences/${preferenceSetId}/categories`, categoryPreferences);
-            return data;
-        });
-    }
-    setCategoryPreferences(userId, categoryKey, setting, options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const preferenceSetId = options.preferenceSet || helpers_1.DEFAULT_PREFERENCE_SET_ID;
-            const { data } = yield this.knock.put(`/v1/users/${userId}/preferences/${preferenceSetId}/categories/${categoryKey}`, (0, helpers_1.buildUpdateParam)(setting));
-            return data;
-        });
-    }
-    //
-    // Channel data
-    //
-    getChannelData(userId, channelId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!userId || !channelId) {
-                throw new Error(`Incomplete arguments. You must provide a 'userId' and a 'channelId'`);
-            }
-            const { data } = yield this.knock.get(`/v1/users/${userId}/channel_data/${channelId}`);
-            return data;
-        });
-    }
-    setChannelData(userId, channelId, channelData) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!userId || !channelId) {
-                throw new Error(`Incomplete arguments. You must provide a 'userId' and a 'channelId'`);
-            }
-            const args = { data: channelData };
-            const { data } = yield this.knock.put(`/v1/users/${userId}/channel_data/${channelId}`, args);
-            return data;
-        });
-    }
-    unsetChannelData(userId, channelId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!userId || !channelId) {
-                throw new Error(`Incomplete arguments. You must provide a 'userId' and a 'channelId'`);
-            }
-            const { data } = yield this.knock.delete(`/v1/users/${userId}/channel_data/${channelId}`);
-            return data;
-        });
-    }
-    //
-    // Messages
-    //
-    getMessages(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}/messages`, filteringOptions);
-            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;
-        });
-    }
-    //
-    // Subscriptions
-    //
-    getSubscriptions(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}/subscriptions`, filteringOptions);
-            return data;
-        });
-    }
-}
-exports.Users = Users;

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

@@ -1,34 +0,0 @@
-import { PaginationOptions } from "../../common/interfaces";
-import { ObjectRef } from "../objects/interfaces";
-export interface IdentifyProperties {
-    name?: string;
-    email?: string;
-    [key: string]: any;
-}
-export interface User {
-    id: string;
-    name: string;
-    email: string;
-    phone_number?: string;
-    avatar?: string;
-    created_at?: string;
-    updated_at?: string;
-    [key: string]: any;
-}
-export interface BulkIdentifyUser extends IdentifyProperties {
-    id: string;
-}
-export interface UserFeedOptions extends PaginationOptions {
-    source?: string;
-    tenant?: string;
-    has_tenant?: boolean;
-    archived?: "include" | "exclude" | "only";
-    status?: "unread" | "unseen" | "all";
-    trigger_data?: Record<string, any>;
-}
-export interface ListUserOptions extends PaginationOptions {
-    include?: Array<"preferences">;
-}
-export interface ListSubscriptionsOptions extends PaginationOptions {
-    objects?: ObjectRef[];
-}

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

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,13 +0,0 @@
-import { Knock } from "../../knock";
-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, { 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

@@ -1,72 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Workflows = void 0;
-class Workflows {
-    constructor(knock) {
-        this.knock = knock;
-    }
-    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;
-        });
-    }
-    cancel(workflowKey, cancellationKey, { recipients } = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!workflowKey && !cancellationKey) {
-                throw new Error(`Incomplete arguments. At a minimum you need to specify 'workflowKey' and 'cancellationKey'.`);
-            }
-            const { data } = yield this.knock.post(`/v1/workflows/${workflowKey}/cancel`, {
-                cancellation_key: cancellationKey,
-                recipients,
-            });
-            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,90 +0,0 @@
-import { ObjectRef, SetObjectProperties } from "../objects/interfaces";
-import { IdentifyProperties } from "../users/interfaces";
-import { PaginationOptions } from "../../common/interfaces";
-import { SetTenantProperties, TenantRef } from "../tenants/interfaces";
-export interface TriggerWorkflowProperties<T = {
-    [key: string]: any;
-}> {
-    actor?: Actor | ActorWithUpsert;
-    recipients?: (Recipient | RecipientWithUpsert)[];
-    cancellationKey?: string;
-    tenant?: Tenant | TenantWithUpsert;
-    data?: T;
-}
-export interface CancelWorkflowProperties {
-    recipients?: Recipient[];
-}
-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 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;
-    ending_at?: string;
-    repeats?: ScheduleRepeatProperties[];
-    tenant?: Tenant | TenantWithUpsert | null;
-    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;
-    };
-    last_occurrence_at: string | null;
-    next_occurrence_at: string | null;
-    inserted_at: string;
-    updated_at: string;
-    repeats: ScheduleRepeatProperties[];
-    ending_at?: string | null;
-    __cursor?: string;
-}
-export type Recipient = string | ObjectRef;
-export type Actor = Recipient;
-export type Tenant = string | TenantRef;
-export interface UserWithUpsert extends IdentifyProperties {
-    id: string;
-}
-export type ObjectWithUpsert = ObjectRef & SetObjectProperties;
-export type TenantWithUpsert = TenantRef & SetTenantProperties;
-export type RecipientWithUpsert = UserWithUpsert | ObjectWithUpsert;
-export type ActorWithUpsert = RecipientWithUpsert;

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

@@ -1,20 +0,0 @@
-"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 = DaysOfWeek = {}));
-var RepeatFrequency;
-(function (RepeatFrequency) {
-    RepeatFrequency["Monthly"] = "monthly";
-    RepeatFrequency["Weekly"] = "weekly";
-    RepeatFrequency["Daily"] = "daily";
-    RepeatFrequency["Hourly"] = "hourly";
-})(RepeatFrequency || (exports.RepeatFrequency = RepeatFrequency = {}));