@knocklabs/node 0.6.19 → 1.1.0

package/dist/src/index.js

@@ -1,26 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Knock = void 0;
-__exportStar(require("./resources/workflows/interfaces"), exports);
-__exportStar(require("./resources/users/interfaces"), exports);
-__exportStar(require("./resources/preferences/interfaces"), exports);
-__exportStar(require("./resources/slack/interfaces"), exports);
-__exportStar(require("./common/interfaces"), exports);
-__exportStar(require("./common/userTokens"), exports);
-__exportStar(require("./common/exceptions"), exports);
-var knock_1 = require("./knock");
-Object.defineProperty(exports, "Knock", { enumerable: true, get: function () { return knock_1.Knock; } });

package/dist/src/knock.d.ts

@@ -1,57 +0,0 @@
-import { KnockOptions, PostAndPutOptions, SignUserTokenOptions, MethodOptions } from "./common/interfaces";
-import { Users } from "./resources/users";
-import { Workflows } from "./resources/workflows";
-import { TriggerWorkflowProperties } from "./resources/workflows/interfaces";
-import { BulkOperations } from "./resources/bulk_operations";
-import { Objects } from "./resources/objects";
-import { Messages } from "./resources/messages";
-import { Tenants } from "./resources/tenants";
-import { FetchResponse } from "./common/fetchClient";
-import { TokenEntity, TokenGrant, TokenGrantOptions } from "./common/userTokens";
-import { Slack } from "./resources/slack";
-declare class Knock {
-    readonly key?: string | undefined;
-    readonly options: KnockOptions;
-    readonly host: string;
-    private readonly client;
-    readonly users: Users;
-    readonly workflows: Workflows;
-    readonly bulkOperations: BulkOperations;
-    readonly objects: Objects;
-    readonly messages: Messages;
-    readonly tenants: Tenants;
-    readonly slack: Slack;
-    constructor(key?: string | undefined, options?: KnockOptions);
-    /**
-     * Delegate the notify function to the workflows trigger
-     *
-     * @deprecated use workflows.trigger instead.
-     */
-    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
-     *
-     * @param userId {string} The ID of the user that needs a token, e.g. the user viewing an in-app feed.
-     * @param options Optionally specify the signing key to use (in PEM or base-64 encoded format), and how long the token should be valid for in seconds
-     * @returns {Promise<string>} A JWT token that can be used to authenticate requests to the Knock API (e.g. by passing into the <KnockFeedProvider /> component)
-     */
-    static signUserToken(userId: string, options?: SignUserTokenOptions): Promise<string>;
-    /**
-     * Helper function to build user token grants to pass to the `signUserToken` method.
-     *
-     * @param entity {TokenEntity} The type of entity to build a grant for
-     * @param grants {TokenGrantOptions} A list of grants to give to the entity for the user
-     *
-     * @returns {TokenGrant} A single token grant that can be passed to the signUserToken function
-     */
-    static buildUserTokenGrant(entity: TokenEntity, grants: TokenGrantOptions): TokenGrant;
-    post(path: string, entity: any, options?: PostAndPutOptions): Promise<FetchResponse>;
-    put(path: string, entity: any, options?: PostAndPutOptions): Promise<FetchResponse>;
-    delete(path: string, entity?: any): Promise<FetchResponse>;
-    get(path: string, query?: any): Promise<FetchResponse>;
-    handleErrorResponse(path: string, error: any): void;
-    emitWarning(warning: string): void;
-}
-export declare function maybePrepareUserTokenGrants(grants: TokenGrant[] | undefined): Record<string, TokenGrant["grants"]> | undefined;
-export { Knock };

package/dist/src/knock.js

@@ -1,241 +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());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Knock = exports.maybePrepareUserTokenGrants = void 0;
-const jose_1 = require("jose");
-const package_json_1 = require("../package.json");
-const exceptions_1 = require("./common/exceptions");
-const users_1 = require("./resources/users");
-const workflows_1 = require("./resources/workflows");
-const bulk_operations_1 = require("./resources/bulk_operations");
-const objects_1 = require("./resources/objects");
-const messages_1 = require("./resources/messages");
-const tenants_1 = require("./resources/tenants");
-const fetchClient_1 = __importDefault(require("./common/fetchClient"));
-const slack_1 = require("./resources/slack");
-const DEFAULT_HOSTNAME = "https://api.knock.app";
-class Knock {
-    constructor(key, options = {}) {
-        this.key = key;
-        this.options = options;
-        // Service accessors
-        this.users = new users_1.Users(this);
-        this.workflows = new workflows_1.Workflows(this);
-        this.bulkOperations = new bulk_operations_1.BulkOperations(this);
-        this.objects = new objects_1.Objects(this);
-        this.messages = new messages_1.Messages(this);
-        this.tenants = new tenants_1.Tenants(this);
-        this.slack = new slack_1.Slack(this);
-        if (!key) {
-            this.key = process.env.KNOCK_API_KEY;
-            if (!this.key) {
-                throw new exceptions_1.NoApiKeyProvidedException();
-            }
-        }
-        this.host = options.host || DEFAULT_HOSTNAME;
-        this.client = new fetchClient_1.default({
-            baseURL: this.host,
-            headers: {
-                Authorization: `Bearer ${this.key}`,
-                "User-Agent": `knocklabs/node@${package_json_1.version}`,
-                "Content-Type": "application/json",
-                Accept: "application/json",
-            },
-        });
-    }
-    /**
-     * Delegate the notify function to the workflows trigger
-     *
-     * @deprecated use workflows.trigger instead.
-     */
-    notify(workflowKey, properties, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.workflows.trigger(workflowKey, properties, options);
-        });
-    }
-    /**
-     * 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
-     *
-     * @param userId {string} The ID of the user that needs a token, e.g. the user viewing an in-app feed.
-     * @param options Optionally specify the signing key to use (in PEM or base-64 encoded format), and how long the token should be valid for in seconds
-     * @returns {Promise<string>} A JWT token that can be used to authenticate requests to the Knock API (e.g. by passing into the <KnockFeedProvider /> component)
-     */
-    static signUserToken(userId, options) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            const signingKey = prepareSigningKey(options === null || options === void 0 ? void 0 : options.signingKey);
-            // JWT NumericDates specified in seconds:
-            const currentTime = Math.floor(Date.now() / 1000);
-            // Default to 1 hour from now
-            const expireInSeconds = (_a = options === null || options === void 0 ? void 0 : options.expiresInSeconds) !== null && _a !== void 0 ? _a : 60 * 60;
-            // Convert string key to a Crypto-API compatible KeyLike
-            const keyLike = yield (0, jose_1.importPKCS8)(signingKey, "RS256");
-            return yield new jose_1.SignJWT({
-                sub: userId,
-                grants: maybePrepareUserTokenGrants(options === null || options === void 0 ? void 0 : options.grants),
-                iat: currentTime,
-                exp: currentTime + expireInSeconds,
-            })
-                .setProtectedHeader({ alg: "RS256", typ: "JWT" })
-                .sign(keyLike);
-        });
-    }
-    /**
-     * Helper function to build user token grants to pass to the `signUserToken` method.
-     *
-     * @param entity {TokenEntity} The type of entity to build a grant for
-     * @param grants {TokenGrantOptions} A list of grants to give to the entity for the user
-     *
-     * @returns {TokenGrant} A single token grant that can be passed to the signUserToken function
-     */
-    static buildUserTokenGrant(entity, grants) {
-        return {
-            entity: prepareTokenEntityUri(entity),
-            grants: grants.reduce((acc, grant) => (Object.assign(Object.assign({}, acc), { [grant]: [] })), {}),
-        };
-    }
-    post(path, entity, options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                return yield this.client.post(path, {
-                    params: options.query,
-                    headers: Object.assign({}, options.headers),
-                    body: entity,
-                });
-            }
-            catch (error) {
-                this.handleErrorResponse(path, error);
-                throw error;
-            }
-        });
-    }
-    put(path, entity, options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                return yield this.client.put(path, {
-                    params: options.query,
-                    headers: Object.assign({}, options.headers),
-                    body: entity,
-                });
-            }
-            catch (error) {
-                this.handleErrorResponse(path, error);
-                throw error;
-            }
-        });
-    }
-    delete(path, entity = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                return yield this.client.delete(path, {
-                    body: entity,
-                });
-            }
-            catch (error) {
-                this.handleErrorResponse(path, error);
-                throw error;
-            }
-        });
-    }
-    get(path, query) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                return yield this.client.get(path, {
-                    params: query,
-                });
-            }
-            catch (error) {
-                this.handleErrorResponse(path, error);
-                throw error;
-            }
-        });
-    }
-    handleErrorResponse(path, error) {
-        if (error.response) {
-            const { status, data, headers } = error.response;
-            const requestID = headers.get("X-Request-ID");
-            switch (status) {
-                case 401: {
-                    const { message, code } = data;
-                    throw new exceptions_1.UnauthorizedException(code, message, requestID);
-                }
-                case 400: {
-                    const { message, code } = data;
-                    throw new exceptions_1.BadRequestException(code, message, requestID);
-                }
-                case 422: {
-                    // Format errors as an array before passing to exception constructor
-                    const errors = !data.errors
-                        ? []
-                        : Array.isArray(data.errors)
-                            ? data.errors
-                            : [data.errors];
-                    throw new exceptions_1.UnprocessableEntityException(errors, requestID);
-                }
-                case 404: {
-                    throw new exceptions_1.NotFoundException(path, requestID);
-                }
-                default: {
-                    throw new exceptions_1.GenericServerException(status, data.message, requestID);
-                }
-            }
-        }
-    }
-    emitWarning(warning) {
-        if (typeof process.emitWarning !== "function") {
-            //  tslint:disable:no-console
-            return console.warn(`Knock: ${warning}`);
-        }
-        return process.emitWarning(warning, "Knock");
-    }
-}
-exports.Knock = Knock;
-function prepareSigningKey(key) {
-    const maybeSigningKey = key !== null && key !== void 0 ? key : process.env.KNOCK_SIGNING_KEY;
-    if (!maybeSigningKey)
-        throw new exceptions_1.NoSigningKeyProvidedException();
-    if (maybeSigningKey.startsWith("-----BEGIN"))
-        return maybeSigningKey;
-    // LS0tLS1CRUdJTi is the base64 encoded version of "-----BEGIN"
-    if (maybeSigningKey.startsWith("LS0tLS1CRUdJTi"))
-        return Buffer.from(maybeSigningKey, "base64").toString("utf-8");
-    throw new exceptions_1.NoSigningKeyProvidedException();
-}
-function prepareTokenEntityUri(entity) {
-    switch (entity.type) {
-        case "user":
-            return `${DEFAULT_HOSTNAME}/v1/users/${entity.id}`;
-        case "tenant":
-            return `${DEFAULT_HOSTNAME}/v1/objects/$tenants/${entity.id}`;
-        case "object":
-            return `${DEFAULT_HOSTNAME}/v1/objects/${entity.collection}/${entity.id}`;
-    }
-}
-function maybePrepareUserTokenGrants(grants) {
-    if (!grants)
-        return undefined;
-    // Given a list of token grants, flattens them into a single object
-    // like: { "entity": { "slack/channels_read": [] } }
-    return grants.reduce((acc, grant) => {
-        if (acc[grant.entity]) {
-            const currentGrants = acc[grant.entity];
-            return Object.assign(Object.assign({}, acc), { [grant.entity]: Object.assign(Object.assign({}, currentGrants), grant.grants) });
-        }
-        else {
-            return Object.assign(Object.assign({}, acc), { [grant.entity]: grant.grants });
-        }
-    }, {});
-}
-exports.maybePrepareUserTokenGrants = maybePrepareUserTokenGrants;

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

@@ -1,11 +0,0 @@
-import { User } from "../users/interfaces";
-import { Object } from "../objects/interfaces";
-export interface Activity {
-    id: string;
-    data: Record<string, any>;
-    actor: User | Object;
-    recipient: User | Object;
-    inserted_at: string;
-    updated_at: string;
-    __cursor?: string;
-}

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

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

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

@@ -1,7 +0,0 @@
-import { Knock } from "../../knock";
-import { BulkOperation } from "../bulk_operations/interfaces";
-export declare class BulkOperations {
-    readonly knock: Knock;
-    constructor(knock: Knock);
-    get(id: string): Promise<BulkOperation>;
-}

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

@@ -1,24 +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.BulkOperations = void 0;
-class BulkOperations {
-    constructor(knock) {
-        this.knock = knock;
-    }
-    get(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.knock.get(`/v1/bulk_operations/${id}`);
-            return data;
-        });
-    }
-}
-exports.BulkOperations = BulkOperations;

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

@@ -1,12 +0,0 @@
-export interface BulkOperation {
-    id: string;
-    name: string;
-    status: "queued" | "processing" | "completed" | "failed";
-    processed_rows: number;
-    estimated_total_rows: number;
-    started_at?: string;
-    completed_at?: string;
-    failed_at?: string;
-    inserted_at: string;
-    updated_at: string;
-}

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

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

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

@@ -1,16 +0,0 @@
-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<PaginatedItemsResponse<Message>>;
-    get(messageId: string): Promise<Message>;
-    getContent(messageId: string): Promise<MessageContent>;
-    getEvents(messageId: string, paginationOptions?: PaginationOptions): Promise<PaginatedItemsResponse<MessageEvent>>;
-    getActivities(messageId: string, filteringOptions?: ListMessageActivitiesOptions): Promise<PaginatedItemsResponse<Activity>>;
-    setStatus(messageId: string, status: Exclude<MessageEngagementStatus, "link_clicked">, metadata?: Record<string, any>): Promise<Message>;
-    deleteStatus(messageId: string, status: Exclude<MessageEngagementStatus, "link_clicked">): Promise<Message>;
-    batchSetStatus(messageIds: string[], status: Exclude<MessageEngagementStatus, "link_clicked"> | "unseen" | "unread" | "unarchived", metadata?: Record<string, any>): Promise<Message[]>;
-}

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

@@ -1,93 +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.Messages = void 0;
-class Messages {
-    constructor(knock) {
-        this.knock = knock;
-    }
-    list(filteringOptions = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.knock.get("/v1/messages", filteringOptions);
-            return data;
-        });
-    }
-    get(messageId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!messageId) {
-                throw new Error(`Incomplete arguments. You must provide a 'messageId'`);
-            }
-            const { data } = yield this.knock.get(`/v1/messages/${messageId}`);
-            return data;
-        });
-    }
-    getContent(messageId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!messageId) {
-                throw new Error(`Incomplete arguments. You must provide a 'messageId'`);
-            }
-            const { data } = yield this.knock.get(`/v1/messages/${messageId}/content`);
-            return data;
-        });
-    }
-    getEvents(messageId, paginationOptions = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!messageId) {
-                throw new Error(`Incomplete arguments. You must provide a 'messageId'`);
-            }
-            const { data } = yield this.knock.get(`/v1/messages/${messageId}/events`, paginationOptions);
-            return data;
-        });
-    }
-    getActivities(messageId, filteringOptions = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!messageId) {
-                throw new Error(`Incomplete arguments. You must provide a 'messageId'`);
-            }
-            const { data } = yield this.knock.get(`/v1/messages/${messageId}/activities`, filteringOptions);
-            return data;
-        });
-    }
-    setStatus(messageId, status, metadata) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!messageId) {
-                throw new Error(`Incomplete arguments. You must provide a 'messageId'`);
-            }
-            if (status !== "interacted" && metadata) {
-                throw new Error(`Metadata is only supported for 'interacted' status.`);
-            }
-            const { data } = yield this.knock.put(`/v1/messages/${messageId}/${status}`, { metadata });
-            return data;
-        });
-    }
-    deleteStatus(messageId, status) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!messageId) {
-                throw new Error(`Incomplete arguments. You must provide a 'messageId'`);
-            }
-            const { data } = yield this.knock.delete(`/v1/messages/${messageId}/${status}`);
-            return data;
-        });
-    }
-    batchSetStatus(messageIds, status, metadata) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (status !== "interacted" && metadata) {
-                throw new Error(`Metadata is only supported for 'interacted' status.`);
-            }
-            const { data } = yield this.knock.post(`/v1/messages/batch/${status}`, {
-                message_ids: messageIds,
-                metadata,
-            });
-            return data;
-        });
-    }
-}
-exports.Messages = Messages;

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

@@ -1,58 +0,0 @@
-import { PaginationOptions } from "../../common/interfaces";
-import { Recipient } from "../workflows/interfaces";
-export interface Message {
-    id: string;
-    channel_id: string;
-    recipient: Recipient;
-    tenant: string | null;
-    status: MessageStatus;
-    read_at: string | null;
-    seen_at: string | null;
-    archived_at: string | null;
-    inserted_at: string;
-    updated_at: string;
-    source: WorkflowSource;
-    data: any;
-    __cursor?: string;
-}
-export interface MessageEvent {
-    id: string;
-    environment_id: string;
-    recipient: Recipient;
-    data: Record<string, any>;
-    type: string;
-    inserted_at: string;
-    __cursor?: string;
-}
-export interface MessageContent {
-    id: string;
-    data: Record<string, any>;
-    inserted_at: string;
-}
-export interface ListMessagesOptions extends PaginationOptions {
-    source?: string;
-    tenant?: string;
-    status?: MessageStatus[];
-    engagement_status?: MessageEngagementStatusFilter[];
-    channel_id?: string;
-    message_ids?: string[];
-    trigger_data?: Record<string, any>;
-    workflow_categories?: String[];
-    "inserted_at.gt"?: string;
-    "inserted_at.gte"?: string;
-    "inserted_at.lt"?: string;
-    "inserted_at.lte"?: string;
-    workflow_run_id?: string;
-    workflow_recipient_run_id?: string;
-}
-export interface ListMessageActivitiesOptions extends PaginationOptions {
-    trigger_data?: Record<string, any>;
-}
-type WorkflowSource = {
-    version_id: string;
-    key: string;
-};
-type MessageStatus = "queued" | "sent" | "delivered" | "undelivered" | "not_sent" | "delivery_attempted" | "bounced";
-export type MessageEngagementStatus = "seen" | "read" | "archived" | "interacted" | "link_clicked";
-type MessageEngagementStatusFilter = MessageEngagementStatus | "unseen" | "unread" | "unarchived";
-export {};

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

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

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

@@ -1,36 +0,0 @@
-import { ChannelData, CommonMetadata, SetChannelDataProperties, PaginatedEntriesResponse, ChannelType, PaginatedItemsResponse } from "../../common/interfaces";
-import { Knock } from "../../knock";
-import { AddObjectSubscriptionProperties, BulkAddSubscriptionsOption, BulkSetObjectOption, DeleteObjectSubscriptionProperties, GetObjectSubscriptionsOptions, 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, GetPreferencesOptions, PreferenceOptions, PreferenceSet, SetPreferencesProperties, WorkflowPreferences, WorkflowPreferenceSetting } from "../preferences/interfaces";
-export declare class Objects {
-    readonly knock: Knock;
-    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<PaginatedEntriesResponse<Object<T>>>;
-    bulkSet(collection: string, objects: BulkSetObjectOption[]): Promise<BulkOperation>;
-    delete(collection: string, id: string): Promise<null>;
-    bulkDelete(collection: string, objectIds: string[]): Promise<BulkOperation>;
-    bulkAddSubscriptions<T = CommonMetadata>(collection: string, subscriptions: BulkAddSubscriptionsOption<T>[]): 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<PaginatedItemsResponse<Message>>;
-    getAllPreferences(collection: string, objectId: string): Promise<PreferenceSet[]>;
-    getPreferences(collection: string, objectId: string, options?: GetPreferencesOptions): Promise<PreferenceSet>;
-    setPreferences(collection: string, objectId: string, preferenceSet: SetPreferencesProperties, options?: PreferenceOptions): Promise<PreferenceSet>;
-    setChannelTypesPreferences(collection: string, objectId: string, channelTypePreferences: ChannelTypePreferences, options?: PreferenceOptions): Promise<PreferenceSet>;
-    setChannelTypePreferences(collection: string, objectId: string, channelType: ChannelType, setting: boolean, options?: PreferenceOptions): Promise<PreferenceSet>;
-    setWorkflowsPreferences(collection: string, objectId: string, workflowPreferences: WorkflowPreferences, options?: PreferenceOptions): Promise<PreferenceSet>;
-    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<PaginatedEntriesResponse<ObjectSubscription>>;
-    getSubscriptions(collection: string, objectId: string, options?: GetObjectSubscriptionsOptions): 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>>;
-}