@knocklabs/node 0.6.19 → 1.0.0

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

@@ -1,203 +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.Objects = void 0;
-const helpers_1 = require("../preferences/helpers");
-class Objects {
-    constructor(knock) {
-        this.knock = knock;
-    }
-    get(collection, id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.knock.get(`/v1/objects/${collection}/${id}`);
-            return data;
-        });
-    }
-    set(collection, id, properties) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.knock.put(`/v1/objects/${collection}/${id}`, properties);
-            return data;
-        });
-    }
-    list(collection, filteringOptions = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.knock.get(`/v1/objects/${collection}`, filteringOptions);
-            return data;
-        });
-    }
-    // Bulk ops
-    bulkSet(collection, objects) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const attrs = { objects };
-            const { data } = yield this.knock.post(`/v1/objects/${collection}/bulk/set`, attrs);
-            return data;
-        });
-    }
-    delete(collection, id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.knock.delete(`/v1/objects/${collection}/${id}`);
-            return data;
-        });
-    }
-    bulkDelete(collection, objectIds) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const attrs = {
-                object_ids: objectIds,
-            };
-            const { data } = yield this.knock.post(`/v1/objects/${collection}/bulk/delete`, attrs);
-            return data;
-        });
-    }
-    bulkAddSubscriptions(collection, subscriptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const attrs = { subscriptions };
-            const { data } = yield this.knock.post(`/v1/objects/${collection}/bulk/subscriptions/add`, attrs);
-            return data;
-        });
-    }
-    // Channel data
-    getChannelData(collection, id, channelId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.knock.get(`/v1/objects/${collection}/${id}/channel_data/${channelId}`);
-            return data;
-        });
-    }
-    setChannelData(collection, id, channelId, channelData) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const attrs = { data: channelData };
-            const { data } = yield this.knock.put(`/v1/objects/${collection}/${id}/channel_data/${channelId}`, attrs);
-            return data;
-        });
-    }
-    unsetChannelData(collection, id, channelId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.knock.delete(`/v1/objects/${collection}/${id}/channel_data/${channelId}`);
-            return data;
-        });
-    }
-    //
-    // Messages
-    //
-    getMessages(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}/messages`, filteringOptions);
-            return data;
-        });
-    }
-    //
-    // Preferences
-    //
-    getAllPreferences(collection, objectId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.knock.get(`/v1/objects/${collection}/${objectId}/preferences`);
-            return data;
-        });
-    }
-    getPreferences(collection, objectId, 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/objects/${collection}/${objectId}/preferences/${preferenceSetId}`, { tenant: options.tenant });
-            return data;
-        });
-    }
-    setPreferences(collection, objectId, 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/objects/${collection}/${objectId}/preferences/${preferenceSetId}`, preferenceSet);
-            return data;
-        });
-    }
-    setChannelTypesPreferences(collection, objectId, 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/objects/${collection}/${objectId}/preferences/${preferenceSetId}/channel_types`, channelTypePreferences);
-            return data;
-        });
-    }
-    setChannelTypePreferences(collection, objectId, 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/objects/${collection}/${objectId}/preferences/${preferenceSetId}/channel_types/${channelType}`, { subscribed: setting });
-            return data;
-        });
-    }
-    setWorkflowsPreferences(collection, objectId, 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/objects/${collection}/${objectId}/preferences/${preferenceSetId}/workflows`, workflowPreferences);
-            return data;
-        });
-    }
-    setWorkflowPreferences(collection, objectId, 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/objects/${collection}/${objectId}/preferences/${preferenceSetId}/workflows/${workflowKey}`, (0, helpers_1.buildUpdateParam)(setting));
-            return data;
-        });
-    }
-    setCategoriesPreferences(collection, objectId, 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/objects/${collection}/${objectId}/preferences/${preferenceSetId}/categories`, categoryPreferences);
-            return data;
-        });
-    }
-    setCategoryPreferences(collection, objectId, 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/objects/${collection}/${objectId}/preferences/${preferenceSetId}/categories/${categoryKey}`, (0, helpers_1.buildUpdateParam)(setting));
-            return data;
-        });
-    }
-    //
-    // Subscriptions
-    //
-    listSubscriptions(collection, objectId, options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.knock.get(`/v1/objects/${collection}/${objectId}/subscriptions`, options);
-            return data;
-        });
-    }
-    getSubscriptions(collection, objectId, options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data, } = yield this.knock.get(`/v1/objects/${collection}/${objectId}/subscriptions`, Object.assign(Object.assign({}, options), { mode: "recipient" }));
-            return data;
-        });
-    }
-    addSubscriptions(collection, objectId, properties = { recipients: [] }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.knock.post(`/v1/objects/${collection}/${objectId}/subscriptions`, properties);
-            return data;
-        });
-    }
-    deleteSubscriptions(collection, objectId, properties = { recipients: [] }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.knock.delete(`/v1/objects/${collection}/${objectId}/subscriptions`, properties);
-            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/objects/interfaces.d.ts

@@ -1,51 +0,0 @@
-import { CommonMetadata, PaginationOptions } from "../../common/interfaces";
-import { User, IdentifyProperties as IdentifyUserProperties } from "../users/interfaces";
-import { Recipient, RecipientWithUpsert } from "../workflows/interfaces";
-export interface ObjectRef {
-    collection: string;
-    id: string;
-}
-export interface Object<T = CommonMetadata> {
-    id: string;
-    collection: string;
-    properties: T;
-    created_at?: string;
-    updated_at: string;
-}
-export interface SetObjectProperties {
-    name?: string;
-    [key: string]: any;
-}
-export interface BulkSetObjectOption {
-    id: string;
-    name?: string;
-    [key: string]: any;
-}
-export interface BulkAddSubscriptionsOption<T = CommonMetadata> {
-    id: string;
-    properties?: T;
-    recipients: (IdentifyUserProperties | SetObjectProperties | string)[];
-}
-export interface ListObjectOptions extends PaginationOptions {
-    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;
-    object: Object;
-    properties: T;
-    inserted_at: string;
-    updated_at: string;
-}
-export interface AddObjectSubscriptionProperties {
-    recipients: (Recipient | RecipientWithUpsert)[];
-    properties?: CommonMetadata;
-}
-export interface DeleteObjectSubscriptionProperties {
-    recipients: Recipient[];
-}

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

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

package/dist/src/resources/preferences/helpers.d.ts

@@ -1,7 +0,0 @@
-import { WorkflowPreferenceSetting } from "./interfaces";
-export declare function buildUpdateParam(param: WorkflowPreferenceSetting): import("./interfaces").ConditionalPreferenceSettings | {
-    channel_types: import("./interfaces").ChannelTypePreferences;
-} | {
-    subscribed: boolean;
-};
-export declare const DEFAULT_PREFERENCE_SET_ID = "default";

package/dist/src/resources/preferences/helpers.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_PREFERENCE_SET_ID = exports.buildUpdateParam = void 0;
-function buildUpdateParam(param) {
-    if (typeof param === "object") {
-        return param;
-    }
-    return { subscribed: param };
-}
-exports.buildUpdateParam = buildUpdateParam;
-exports.DEFAULT_PREFERENCE_SET_ID = "default";

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

@@ -1,30 +0,0 @@
-import { ChannelType, Condition } from "../../common/interfaces";
-export type ConditionalPreferenceSettings = {
-    conditions: Condition[];
-};
-export type ChannelTypePreferences = {
-    [K in ChannelType]?: boolean | ConditionalPreferenceSettings;
-};
-export type WorkflowPreferenceSetting = boolean | {
-    channel_types: ChannelTypePreferences;
-} | ConditionalPreferenceSettings;
-export interface WorkflowPreferences {
-    [key: string]: WorkflowPreferenceSetting;
-}
-export interface SetPreferencesProperties {
-    workflows?: WorkflowPreferences;
-    categories?: WorkflowPreferences;
-    channel_types?: ChannelTypePreferences;
-}
-export interface PreferenceSet {
-    id: string;
-    categories: WorkflowPreferences | null;
-    workflows: WorkflowPreferences | null;
-    channel_types: ChannelTypePreferences | null;
-}
-export interface PreferenceOptions {
-    preferenceSet?: string;
-}
-export interface GetPreferencesOptions extends PreferenceOptions {
-    tenant?: string;
-}

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

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

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

@@ -1,9 +0,0 @@
-import { Knock } from "../../knock";
-import { AuthCheckInput, GetSlackChannelsInput, PaginatedSlackChannelResponse, RevokeAccessTokenInput } from "./interfaces";
-export declare class Slack {
-    readonly knock: Knock;
-    constructor(knock: Knock);
-    getChannels(input: GetSlackChannelsInput): Promise<PaginatedSlackChannelResponse>;
-    authCheck({ tenant, knockChannelId }: AuthCheckInput): Promise<any>;
-    revokeAccessToken({ tenant, knockChannelId }: RevokeAccessTokenInput): Promise<any>;
-}

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

@@ -1,75 +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.Slack = void 0;
-const TENANT_COLLECTION = "$tenants";
-function removeNullKeys(obj) {
-    Object.keys(obj).forEach((key) => {
-        if (obj[key] === null) {
-            delete obj[key];
-        }
-    });
-    return obj;
-}
-class Slack {
-    constructor(knock) {
-        this.knock = knock;
-    }
-    getChannels(input) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { knockChannelId, tenant } = input;
-            const queryOptions = input.queryOptions || {};
-            const params = {
-                access_token_object: {
-                    object_id: tenant,
-                    collection: TENANT_COLLECTION,
-                },
-                channel_id: knockChannelId,
-                query_options: removeNullKeys({
-                    cursor: queryOptions.cursor || null,
-                    limit: queryOptions.limit || null,
-                    exclude_archived: queryOptions.excludeArchived || null,
-                    team_id: queryOptions.teamId || null,
-                    types: queryOptions.types || null,
-                }),
-            };
-            const { data } = yield this.knock.get(`/v1/providers/slack/${knockChannelId}/channels`, params);
-            return data;
-        });
-    }
-    authCheck({ tenant, knockChannelId }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const params = {
-                access_token_object: {
-                    object_id: tenant,
-                    collection: TENANT_COLLECTION,
-                },
-                channel_id: knockChannelId,
-            };
-            const { data } = yield this.knock.get(`/v1/providers/slack/${knockChannelId}/auth_check`, params);
-            return data;
-        });
-    }
-    revokeAccessToken({ tenant, knockChannelId }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const params = {
-                access_token_object: {
-                    object_id: tenant,
-                    collection: TENANT_COLLECTION,
-                },
-                channel_id: knockChannelId,
-            };
-            const { data } = yield this.knock.get(`/v1/providers/slack/${knockChannelId}/revoke_access`, params);
-            return data;
-        });
-    }
-}
-exports.Slack = Slack;

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

@@ -1,30 +0,0 @@
-export type GetSlackChannelsInput = {
-    tenant: string;
-    knockChannelId: string;
-    queryOptions?: {
-        limit?: number;
-        cursor?: string;
-        excludeArchived?: boolean;
-        teamId?: string;
-        types?: string;
-    };
-};
-export type SlackChannel = {
-    name: string;
-    id: string;
-    is_private: boolean;
-    is_im: boolean;
-    context_team_id: boolean;
-};
-export type PaginatedSlackChannelResponse = {
-    slack_channels: SlackChannel[];
-    next_cursor: string;
-};
-export type AuthCheckInput = {
-    tenant: string;
-    knockChannelId: string;
-};
-export type RevokeAccessTokenInput = {
-    tenant: string;
-    knockChannelId: string;
-};

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

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

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

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

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

@@ -1,42 +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.Tenants = void 0;
-class Tenants {
-    constructor(knock) {
-        this.knock = knock;
-    }
-    list(filteringOptions = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.knock.get("/v1/tenants", filteringOptions);
-            return data;
-        });
-    }
-    get(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.knock.get(`/v1/tenants/${id}`);
-            return data;
-        });
-    }
-    set(id, tenantData) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.knock.put(`/v1/tenants/${id}`, tenantData);
-            return data;
-        });
-    }
-    delete(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.knock.delete(`/v1/tenants/${id}`);
-            return data;
-        });
-    }
-}
-exports.Tenants = Tenants;

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

@@ -1,32 +0,0 @@
-import { CommonMetadata, PaginationOptions, SetChannelDataProperties } from "../../common/interfaces";
-import { SetPreferencesProperties } from "../preferences/interfaces";
-export interface TenantRef {
-    id: string;
-}
-export interface TenantBrandingSettings {
-    primary_color?: string;
-    primary_color_contrast?: string;
-    logo_url?: string;
-    icon_url?: string;
-}
-export interface TenantSettings {
-    branding?: TenantBrandingSettings;
-    preference_set?: SetPreferencesProperties;
-}
-export interface Tenant<T = CommonMetadata> {
-    id: string;
-    properties: T;
-    settings?: TenantSettings;
-    created_at?: string;
-    updated_at: string;
-}
-export interface SetTenantProperties {
-    name?: string;
-    channelData?: SetChannelDataProperties;
-    settings?: TenantSettings;
-    [key: string]: any;
-}
-export interface ListTenantsOptions extends PaginationOptions {
-    tenant_id?: string;
-    name?: string;
-}

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

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

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

@@ -1,36 +0,0 @@
-import { ChannelData, ChannelType, CommonMetadata, PaginatedItemsResponse, PaginatedEntriesResponse } from "../../common/interfaces";
-import { BulkOperation } from "../bulk_operations/interfaces";
-import { ChannelTypePreferences, PreferenceOptions, PreferenceSet, GetPreferencesOptions, 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, ListSubscriptionsOptions, ListUserOptions, User, UserFeedOptions } from "./interfaces";
-import { ObjectSubscription } from "../objects/interfaces";
-export declare class Users {
-    readonly knock: Knock;
-    constructor(knock: Knock);
-    identify(userId: string, properties?: IdentifyProperties): Promise<User>;
-    bulkIdentify(users: BulkIdentifyUser[]): Promise<BulkOperation>;
-    get(userId: string): Promise<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<PaginatedEntriesResponse<any>>;
-    getAllPreferences(userId: string): Promise<any>;
-    getPreferences(userId: string, options?: GetPreferencesOptions): Promise<PreferenceSet>;
-    setPreferences(userId: string, preferenceSet: SetPreferencesProperties, options?: PreferenceOptions): Promise<PreferenceSet>;
-    bulkSetPreferences(userIds: string[], preferenceSet: SetPreferencesProperties, options?: PreferenceOptions): Promise<BulkOperation>;
-    setChannelTypesPreferences(userId: string, channelTypePreferences: ChannelTypePreferences, options?: PreferenceOptions): Promise<PreferenceSet>;
-    setChannelTypePreferences(userId: string, channelType: ChannelType, setting: boolean, options?: PreferenceOptions): Promise<PreferenceSet>;
-    setWorkflowsPreferences(userId: string, workflowPreferences: WorkflowPreferences, options?: PreferenceOptions): Promise<PreferenceSet>;
-    setWorkflowPreferences(userId: string, workflowKey: string, setting: WorkflowPreferenceSetting, options?: PreferenceOptions): Promise<PreferenceSet>;
-    setCategoriesPreferences(userId: string, categoryPreferences: WorkflowPreferences, options?: PreferenceOptions): Promise<PreferenceSet>;
-    setCategoryPreferences(userId: string, categoryKey: string, setting: WorkflowPreferenceSetting, options?: PreferenceOptions): Promise<PreferenceSet>;
-    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<PaginatedItemsResponse<Message>>;
-    getSchedules(userId: string, filteringOptions?: ListSchedulesProps): Promise<PaginatedEntriesResponse<Schedule>>;
-    getSubscriptions(userId: string, filteringOptions?: ListSubscriptionsOptions): Promise<PaginatedEntriesResponse<ObjectSubscription>>;
-}