@knocklabs/node 0.6.19 → 1.1.0

package/resources/objects/bulk.d.ts

@@ -0,0 +1,108 @@
+import { APIResource } from "../../core/resource.js";
+import * as BulkOperationsAPI from "../bulk-operations.js";
+import * as ObjectsAPI from "./objects.js";
+import * as RecipientsAPI from "../recipients/recipients.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Bulk extends APIResource {
+    /**
+     * Bulk deletes objects from the specified collection.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation = await client.objects.bulk.delete(
+     *   'collection',
+     *   { object_ids: ['obj_123', 'obj_456', 'obj_789'] },
+     * );
+     * ```
+     */
+    delete(collection: string, body: BulkDeleteParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
+    /**
+     * Add subscriptions for all objects in a single collection. If a subscription for
+     * an object in the collection already exists, it will be updated. This endpoint
+     * also handles
+     * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
+     * for the `recipient` field.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation =
+     *   await client.objects.bulk.addSubscriptions('projects', {
+     *     subscriptions: [
+     *       {
+     *         id: 'project-1',
+     *         properties: null,
+     *         recipients: [{ id: 'user_1' }],
+     *       },
+     *     ],
+     *   });
+     * ```
+     */
+    addSubscriptions(collection: string, body: BulkAddSubscriptionsParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
+    /**
+     * Bulk sets up to 1,000 objects at a time in the specified collection.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation = await client.objects.bulk.set(
+     *   'collection',
+     *   {
+     *     objects: [
+     *       {
+     *         collection: 'projects',
+     *         id: 'project_1',
+     *         name: {
+     *           '0': 'M',
+     *           '1': 'y',
+     *           '2': ' ',
+     *           '3': 'p',
+     *           '4': 'r',
+     *           '5': 'o',
+     *           '6': 'j',
+     *           '7': 'e',
+     *           '8': 'c',
+     *           '9': 't',
+     *         },
+     *       },
+     *     ],
+     *   },
+     * );
+     * ```
+     */
+    set(collection: string, body: BulkSetParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
+}
+export interface BulkDeleteParams {
+    /**
+     * List of object IDs to delete.
+     */
+    object_ids: Array<string>;
+}
+export interface BulkAddSubscriptionsParams {
+    /**
+     * A list of subscriptions.
+     */
+    subscriptions: Array<BulkAddSubscriptionsParams.Subscription>;
+}
+export declare namespace BulkAddSubscriptionsParams {
+    interface Subscription {
+        /**
+         * The recipients of the subscription. You can subscribe up to 100 recipients to an
+         * object at a time.
+         */
+        recipients: Array<RecipientsAPI.RecipientRequest>;
+        /**
+         * The custom properties associated with the subscription relationship.
+         */
+        properties?: Record<string, unknown> | null;
+    }
+}
+export interface BulkSetParams {
+    /**
+     * A list of objects.
+     */
+    objects: Array<ObjectsAPI.InlineObjectRequest>;
+}
+export declare namespace Bulk {
+    export { type BulkDeleteParams as BulkDeleteParams, type BulkAddSubscriptionsParams as BulkAddSubscriptionsParams, type BulkSetParams as BulkSetParams, };
+}
+//# sourceMappingURL=bulk.d.ts.map

package/resources/objects/bulk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulk.d.ts","sourceRoot":"","sources":["../../src/resources/objects/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,UAAU;OACf,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;OAUG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,gBAAgB,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAI9C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,gBAAgB,CACd,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAI9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,GAAG,CACD,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,aAAa,EACnB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAG/C;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,0BAA0B,CAAC,YAAY,CAAC,CAAC;CAC/D;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,YAAY;QAC3B;;;WAGG;QACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;QAElD;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;KAC7C;CACF;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;CAChD;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;CACH"}

package/resources/objects/bulk.js

@@ -0,0 +1,81 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Bulk = void 0;
+const resource_1 = require("../../core/resource.js");
+const path_1 = require("../../internal/utils/path.js");
+class Bulk extends resource_1.APIResource {
+    /**
+     * Bulk deletes objects from the specified collection.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation = await client.objects.bulk.delete(
+     *   'collection',
+     *   { object_ids: ['obj_123', 'obj_456', 'obj_789'] },
+     * );
+     * ```
+     */
+    delete(collection, body, options) {
+        return this._client.post((0, path_1.path) `/v1/objects/${collection}/bulk/delete`, { body, ...options });
+    }
+    /**
+     * Add subscriptions for all objects in a single collection. If a subscription for
+     * an object in the collection already exists, it will be updated. This endpoint
+     * also handles
+     * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
+     * for the `recipient` field.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation =
+     *   await client.objects.bulk.addSubscriptions('projects', {
+     *     subscriptions: [
+     *       {
+     *         id: 'project-1',
+     *         properties: null,
+     *         recipients: [{ id: 'user_1' }],
+     *       },
+     *     ],
+     *   });
+     * ```
+     */
+    addSubscriptions(collection, body, options) {
+        return this._client.post((0, path_1.path) `/v1/objects/${collection}/bulk/subscriptions/add`, { body, ...options });
+    }
+    /**
+     * Bulk sets up to 1,000 objects at a time in the specified collection.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation = await client.objects.bulk.set(
+     *   'collection',
+     *   {
+     *     objects: [
+     *       {
+     *         collection: 'projects',
+     *         id: 'project_1',
+     *         name: {
+     *           '0': 'M',
+     *           '1': 'y',
+     *           '2': ' ',
+     *           '3': 'p',
+     *           '4': 'r',
+     *           '5': 'o',
+     *           '6': 'j',
+     *           '7': 'e',
+     *           '8': 'c',
+     *           '9': 't',
+     *         },
+     *       },
+     *     ],
+     *   },
+     * );
+     * ```
+     */
+    set(collection, body, options) {
+        return this._client.post((0, path_1.path) `/v1/objects/${collection}/bulk/set`, { body, ...options });
+    }
+}
+exports.Bulk = Bulk;
+//# sourceMappingURL=bulk.js.map

package/resources/objects/bulk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulk.js","sourceRoot":"","sources":["../../src/resources/objects/bulk.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAMlD,uDAAiD;AAEjD,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;;;;;OAUG;IACH,MAAM,CACJ,UAAkB,EAClB,IAAsB,EACtB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,eAAe,UAAU,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,gBAAgB,CACd,UAAkB,EAClB,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,eAAe,UAAU,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,GAAG,CACD,UAAkB,EAClB,IAAmB,EACnB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,eAAe,UAAU,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;CACF;AAtFD,oBAsFC"}

package/resources/objects/bulk.mjs

@@ -0,0 +1,77 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export class Bulk extends APIResource {
+    /**
+     * Bulk deletes objects from the specified collection.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation = await client.objects.bulk.delete(
+     *   'collection',
+     *   { object_ids: ['obj_123', 'obj_456', 'obj_789'] },
+     * );
+     * ```
+     */
+    delete(collection, body, options) {
+        return this._client.post(path `/v1/objects/${collection}/bulk/delete`, { body, ...options });
+    }
+    /**
+     * Add subscriptions for all objects in a single collection. If a subscription for
+     * an object in the collection already exists, it will be updated. This endpoint
+     * also handles
+     * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
+     * for the `recipient` field.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation =
+     *   await client.objects.bulk.addSubscriptions('projects', {
+     *     subscriptions: [
+     *       {
+     *         id: 'project-1',
+     *         properties: null,
+     *         recipients: [{ id: 'user_1' }],
+     *       },
+     *     ],
+     *   });
+     * ```
+     */
+    addSubscriptions(collection, body, options) {
+        return this._client.post(path `/v1/objects/${collection}/bulk/subscriptions/add`, { body, ...options });
+    }
+    /**
+     * Bulk sets up to 1,000 objects at a time in the specified collection.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation = await client.objects.bulk.set(
+     *   'collection',
+     *   {
+     *     objects: [
+     *       {
+     *         collection: 'projects',
+     *         id: 'project_1',
+     *         name: {
+     *           '0': 'M',
+     *           '1': 'y',
+     *           '2': ' ',
+     *           '3': 'p',
+     *           '4': 'r',
+     *           '5': 'o',
+     *           '6': 'j',
+     *           '7': 'e',
+     *           '8': 'c',
+     *           '9': 't',
+     *         },
+     *       },
+     *     ],
+     *   },
+     * );
+     * ```
+     */
+    set(collection, body, options) {
+        return this._client.post(path `/v1/objects/${collection}/bulk/set`, { body, ...options });
+    }
+}
+//# sourceMappingURL=bulk.mjs.map

package/resources/objects/bulk.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulk.mjs","sourceRoot":"","sources":["../../src/resources/objects/bulk.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAMf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;OAUG;IACH,MAAM,CACJ,UAAkB,EAClB,IAAsB,EACtB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,eAAe,UAAU,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,gBAAgB,CACd,UAAkB,EAClB,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,eAAe,UAAU,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,GAAG,CACD,UAAkB,EAClB,IAAmB,EACnB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,eAAe,UAAU,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;CACF"}

package/resources/objects/index.d.mts

@@ -0,0 +1,3 @@
+export { Bulk, type BulkDeleteParams, type BulkAddSubscriptionsParams, type BulkSetParams } from "./bulk.mjs";
+export { Objects, type InlineObjectRequest, type Object, type ObjectDeleteResponse, type ObjectAddSubscriptionsResponse, type ObjectDeleteSubscriptionsResponse, type ObjectListPreferencesResponse, type ObjectUnsetChannelDataResponse, type ObjectListParams, type ObjectAddSubscriptionsParams, type ObjectDeleteSubscriptionsParams, type ObjectListMessagesParams, type ObjectListSchedulesParams, type ObjectListSubscriptionsParams, type ObjectSetParams, type ObjectSetChannelDataParams, type ObjectSetPreferencesParams, type ObjectsEntriesCursor, } from "./objects.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/objects/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/objects/index.ts"],"names":[],"mappings":"OAEO,EAAE,IAAI,EAAE,KAAK,gBAAgB,EAAE,KAAK,0BAA0B,EAAE,KAAK,aAAa,EAAE;OACpF,EACL,OAAO,EACP,KAAK,mBAAmB,EACxB,KAAK,MAAM,EACX,KAAK,oBAAoB,EACzB,KAAK,8BAA8B,EACnC,KAAK,iCAAiC,EACtC,KAAK,6BAA6B,EAClC,KAAK,8BAA8B,EACnC,KAAK,gBAAgB,EACrB,KAAK,4BAA4B,EACjC,KAAK,+BAA+B,EACpC,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,KAAK,6BAA6B,EAClC,KAAK,eAAe,EACpB,KAAK,0BAA0B,EAC/B,KAAK,0BAA0B,EAC/B,KAAK,oBAAoB,GAC1B"}

package/resources/objects/index.d.ts

@@ -0,0 +1,3 @@
+export { Bulk, type BulkDeleteParams, type BulkAddSubscriptionsParams, type BulkSetParams } from "./bulk.js";
+export { Objects, type InlineObjectRequest, type Object, type ObjectDeleteResponse, type ObjectAddSubscriptionsResponse, type ObjectDeleteSubscriptionsResponse, type ObjectListPreferencesResponse, type ObjectUnsetChannelDataResponse, type ObjectListParams, type ObjectAddSubscriptionsParams, type ObjectDeleteSubscriptionsParams, type ObjectListMessagesParams, type ObjectListSchedulesParams, type ObjectListSubscriptionsParams, type ObjectSetParams, type ObjectSetChannelDataParams, type ObjectSetPreferencesParams, type ObjectsEntriesCursor, } from "./objects.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/objects/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/objects/index.ts"],"names":[],"mappings":"OAEO,EAAE,IAAI,EAAE,KAAK,gBAAgB,EAAE,KAAK,0BAA0B,EAAE,KAAK,aAAa,EAAE;OACpF,EACL,OAAO,EACP,KAAK,mBAAmB,EACxB,KAAK,MAAM,EACX,KAAK,oBAAoB,EACzB,KAAK,8BAA8B,EACnC,KAAK,iCAAiC,EACtC,KAAK,6BAA6B,EAClC,KAAK,8BAA8B,EACnC,KAAK,gBAAgB,EACrB,KAAK,4BAA4B,EACjC,KAAK,+BAA+B,EACpC,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,KAAK,6BAA6B,EAClC,KAAK,eAAe,EACpB,KAAK,0BAA0B,EAC/B,KAAK,0BAA0B,EAC/B,KAAK,oBAAoB,GAC1B"}

package/resources/objects/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Objects = exports.Bulk = void 0;
+var bulk_1 = require("./bulk.js");
+Object.defineProperty(exports, "Bulk", { enumerable: true, get: function () { return bulk_1.Bulk; } });
+var objects_1 = require("./objects.js");
+Object.defineProperty(exports, "Objects", { enumerable: true, get: function () { return objects_1.Objects; } });
+//# sourceMappingURL=index.js.map

package/resources/objects/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/objects/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kCAA0G;AAAjG,4FAAA,IAAI,OAAA;AACb,wCAmBmB;AAlBjB,kGAAA,OAAO,OAAA"}

package/resources/objects/index.mjs

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Bulk } from "./bulk.mjs";
+export { Objects, } from "./objects.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/objects/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/objects/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,IAAI,EAA8E;OACpF,EACL,OAAO,GAkBR"}