@knocklabs/node 0.6.19 → 1.1.0

package/resources/objects/objects.js

@@ -0,0 +1,312 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Objects = void 0;
+const tslib_1 = require("../../internal/tslib.js");
+const resource_1 = require("../../core/resource.js");
+const BulkAPI = tslib_1.__importStar(require("./bulk.js"));
+const bulk_1 = require("./bulk.js");
+const pagination_1 = require("../../core/pagination.js");
+const path_1 = require("../../internal/utils/path.js");
+class Objects extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.bulk = new BulkAPI.Bulk(this._client);
+    }
+    /**
+     * Returns a paginated list of objects from the specified collection. Optionally
+     * includes preference data for the objects.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const object of client.objects.list(
+     *   'collection',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(collection, query = {}, options) {
+        return this._client.getAPIList((0, path_1.path) `/v1/objects/${collection}`, (pagination_1.EntriesCursor), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Permanently removes an object from the specified collection. This operation
+     * cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const object = await client.objects.delete(
+     *   'collection',
+     *   'id',
+     * );
+     * ```
+     */
+    delete(collection, id, options) {
+        return this._client.delete((0, path_1.path) `/v1/objects/${collection}/${id}`, options);
+    }
+    /**
+     * Add subscriptions for an object. If a subscription already exists, it will be
+     * updated. This endpoint also handles
+     * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
+     * for the `recipient`.
+     *
+     * @example
+     * ```ts
+     * const subscriptions = await client.objects.addSubscriptions(
+     *   'collection',
+     *   'object_id',
+     *   {
+     *     recipients: ['user_1', 'user_2'],
+     *     properties: { key: 'value' },
+     *   },
+     * );
+     * ```
+     */
+    addSubscriptions(collection, objectID, body, options) {
+        return this._client.post((0, path_1.path) `/v1/objects/${collection}/${objectID}/subscriptions`, { body, ...options });
+    }
+    /**
+     * Delete subscriptions for the specified recipients from an object. Returns the
+     * list of deleted subscriptions.
+     *
+     * @example
+     * ```ts
+     * const subscriptions =
+     *   await client.objects.deleteSubscriptions(
+     *     'collection',
+     *     'object_id',
+     *     { recipients: ['user_123'] },
+     *   );
+     * ```
+     */
+    deleteSubscriptions(collection, objectID, body, options) {
+        return this._client.delete((0, path_1.path) `/v1/objects/${collection}/${objectID}/subscriptions`, {
+            body,
+            ...options,
+        });
+    }
+    /**
+     * Retrieves a specific object by its ID from the specified collection. Returns the
+     * object with all its properties.
+     *
+     * @example
+     * ```ts
+     * const object = await client.objects.get('collection', 'id');
+     * ```
+     */
+    get(collection, id, options) {
+        return this._client.get((0, path_1.path) `/v1/objects/${collection}/${id}`, options);
+    }
+    /**
+     * Returns the channel data for the specified object and channel.
+     *
+     * @example
+     * ```ts
+     * const channelData = await client.objects.getChannelData(
+     *   'collection',
+     *   'object_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
+     */
+    getChannelData(collection, objectID, channelID, options) {
+        return this._client.get((0, path_1.path) `/v1/objects/${collection}/${objectID}/channel_data/${channelID}`, options);
+    }
+    /**
+     * Returns the preference set for the specified object and preference set `id`.
+     *
+     * @example
+     * ```ts
+     * const preferenceSet = await client.objects.getPreferences(
+     *   'collection',
+     *   'object_id',
+     *   'default',
+     * );
+     * ```
+     */
+    getPreferences(collection, objectID, id, options) {
+        return this._client.get((0, path_1.path) `/v1/objects/${collection}/${objectID}/preferences/${id}`, options);
+    }
+    /**
+     * Returns a paginated list of messages for a specific object in the given
+     * collection. Allows filtering by message status and provides various sorting
+     * options.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const message of client.objects.listMessages(
+     *   'projects',
+     *   'project-123',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    listMessages(collection, id, query = {}, options) {
+        return this._client.getAPIList((0, path_1.path) `/v1/objects/${collection}/${id}/messages`, (pagination_1.EntriesCursor), { query, ...options });
+    }
+    /**
+     * Returns a paginated list of preference sets for the specified object.
+     *
+     * @example
+     * ```ts
+     * const preferenceSets = await client.objects.listPreferences(
+     *   'collection',
+     *   'object_id',
+     * );
+     * ```
+     */
+    listPreferences(collection, objectID, options) {
+        return this._client.get((0, path_1.path) `/v1/objects/${collection}/${objectID}/preferences`, options);
+    }
+    /**
+     * Returns a paginated list of schedules for an object.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const schedule of client.objects.listSchedules(
+     *   'collection',
+     *   'id',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    listSchedules(collection, id, query = {}, options) {
+        return this._client.getAPIList((0, path_1.path) `/v1/objects/${collection}/${id}/schedules`, (pagination_1.EntriesCursor), { query, ...options });
+    }
+    /**
+     * List subscriptions for an object. Either list the recipients that subscribe to
+     * the provided object, or list the objects that the provided object is subscribed
+     * to. Determined by the `mode` query parameter.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const subscription of client.objects.listSubscriptions(
+     *   'collection',
+     *   'object_id',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    listSubscriptions(collection, objectID, query = {}, options) {
+        return this._client.getAPIList((0, path_1.path) `/v1/objects/${collection}/${objectID}/subscriptions`, (pagination_1.EntriesCursor), { query, ...options });
+    }
+    /**
+     * Creates a new object or updates an existing one in the specified collection.
+     * This operation is used to identify objects with their properties, as well as
+     * optional preferences and channel data.
+     *
+     * @example
+     * ```ts
+     * const object = await client.objects.set(
+     *   'collection',
+     *   'id',
+     *   {
+     *     channel_data: {
+     *       '97c5837d-c65c-4d54-aa39-080eeb81c69d': {
+     *         data: { tokens: ['push_token_123'] },
+     *       },
+     *     },
+     *     locale: 'en-US',
+     *     preferences: {
+     *       default: {
+     *         channel_types: { email: true },
+     *         workflows: {
+     *           'dinosaurs-loose': {
+     *             channel_types: { email: true },
+     *           },
+     *         },
+     *       },
+     *     },
+     *     timezone: 'America/New_York',
+     *   },
+     * );
+     * ```
+     */
+    set(collection, id, body, options) {
+        return this._client.put((0, path_1.path) `/v1/objects/${collection}/${id}`, { body, ...options });
+    }
+    /**
+     * Sets the channel data for the specified object and channel. If no object exists
+     * in the current environment for the given `collection` and `object_id`, Knock
+     * will create the object as part of this request.
+     *
+     * @example
+     * ```ts
+     * const channelData = await client.objects.setChannelData(
+     *   'collection',
+     *   'object_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { data: { tokens: ['push_token_1'] } },
+     * );
+     * ```
+     */
+    setChannelData(collection, objectID, channelID, body, options) {
+        return this._client.put((0, path_1.path) `/v1/objects/${collection}/${objectID}/channel_data/${channelID}`, {
+            body,
+            ...options,
+        });
+    }
+    /**
+     * Sets preferences within the given preference set. This is a destructive
+     * operation and will replace any existing preferences with the preferences given.
+     * If no object exists in the current environment for the given `:collection` and
+     * `:object_id`, Knock will create the object as part of this request. The
+     * preference set `:id` can be either `default` or a `tenant.id`. Learn more about
+     * [per-tenant preferences](/preferences/tenant-preferences).
+     *
+     * @example
+     * ```ts
+     * const preferenceSet = await client.objects.setPreferences(
+     *   'collection',
+     *   'object_id',
+     *   'default',
+     *   {
+     *     categories: {
+     *       marketing: false,
+     *       transactional: { channel_types: { email: false } },
+     *     },
+     *     channel_types: { email: true },
+     *     workflows: {
+     *       'dinosaurs-loose': {
+     *         channel_types: { email: false },
+     *       },
+     *     },
+     *   },
+     * );
+     * ```
+     */
+    setPreferences(collection, objectID, id, body, options) {
+        return this._client.put((0, path_1.path) `/v1/objects/${collection}/${objectID}/preferences/${id}`, {
+            body,
+            ...options,
+        });
+    }
+    /**
+     * Unsets the channel data for the specified object and channel.
+     *
+     * @example
+     * ```ts
+     * const response = await client.objects.unsetChannelData(
+     *   'collection',
+     *   'object_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
+     */
+    unsetChannelData(collection, objectID, channelID, options) {
+        return this._client.delete((0, path_1.path) `/v1/objects/${collection}/${objectID}/channel_data/${channelID}`, options);
+    }
+}
+exports.Objects = Objects;
+Objects.Bulk = bulk_1.Bulk;
+//# sourceMappingURL=objects.js.map

package/resources/objects/objects.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.js","sourceRoot":"","sources":["../../src/resources/objects/objects.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAIlD,2DAAkC;AAClC,oCAA2F;AAS3F,yDAA6F;AAE7F,uDAAiD;AAEjD,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAgYtD,CAAC;IA9XC;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,UAAkB,EAClB,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,eAAe,UAAU,EAAE,EAAE,CAAA,0BAAqB,CAAA,EAAE;YACrF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,UAAkB,EAAE,EAAU,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,eAAe,UAAU,IAAI,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,gBAAgB,CACd,UAAkB,EAClB,QAAgB,EAChB,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,eAAe,UAAU,IAAI,QAAQ,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CACjB,UAAkB,EAClB,QAAgB,EAChB,IAAqC,EACrC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,eAAe,UAAU,IAAI,QAAQ,gBAAgB,EAAE;YACpF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,GAAG,CAAC,UAAkB,EAAE,EAAU,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,UAAU,IAAI,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,UAAkB,EAClB,QAAgB,EAChB,SAAiB,EACjB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,UAAU,IAAI,QAAQ,iBAAiB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1G,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,UAAkB,EAClB,QAAgB,EAChB,EAAU,EACV,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,UAAU,IAAI,QAAQ,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CACV,UAAkB,EAClB,EAAU,EACV,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,eAAe,UAAU,IAAI,EAAE,WAAW,EAC9C,CAAA,0BAAkC,CAAA,EAClC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,eAAe,CACb,UAAkB,EAClB,QAAgB,EAChB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,UAAU,IAAI,QAAQ,cAAc,EAAE,OAAO,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,UAAkB,EAClB,EAAU,EACV,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,eAAe,UAAU,IAAI,EAAE,YAAY,EAC/C,CAAA,0BAAoC,CAAA,EACpC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,CACf,UAAkB,EAClB,QAAgB,EAChB,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,eAAe,UAAU,IAAI,QAAQ,gBAAgB,EACzD,CAAA,0BAA4C,CAAA,EAC5C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,GAAG,CAAC,UAAkB,EAAE,EAAU,EAAE,IAAqB,EAAE,OAAwB;QACjF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,UAAU,IAAI,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,cAAc,CACZ,UAAkB,EAClB,QAAgB,EAChB,SAAiB,EACjB,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,UAAU,IAAI,QAAQ,iBAAiB,SAAS,EAAE,EAAE;YAC7F,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,cAAc,CACZ,UAAkB,EAClB,QAAgB,EAChB,EAAU,EACV,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,UAAU,IAAI,QAAQ,gBAAgB,EAAE,EAAE,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,gBAAgB,CACd,UAAkB,EAClB,QAAgB,EAChB,SAAiB,EACjB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CACxB,IAAA,WAAI,EAAA,eAAe,UAAU,IAAI,QAAQ,iBAAiB,SAAS,EAAE,EACrE,OAAO,CACR,CAAC;IACJ,CAAC;CACF;AAjYD,0BAiYC;AAqWD,OAAO,CAAC,IAAI,GAAG,WAAI,CAAC"}

package/resources/objects/objects.mjs

@@ -0,0 +1,307 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import * as BulkAPI from "./bulk.mjs";
+import { Bulk } from "./bulk.mjs";
+import { EntriesCursor } from "../../core/pagination.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export class Objects extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.bulk = new BulkAPI.Bulk(this._client);
+    }
+    /**
+     * Returns a paginated list of objects from the specified collection. Optionally
+     * includes preference data for the objects.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const object of client.objects.list(
+     *   'collection',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(collection, query = {}, options) {
+        return this._client.getAPIList(path `/v1/objects/${collection}`, (EntriesCursor), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Permanently removes an object from the specified collection. This operation
+     * cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const object = await client.objects.delete(
+     *   'collection',
+     *   'id',
+     * );
+     * ```
+     */
+    delete(collection, id, options) {
+        return this._client.delete(path `/v1/objects/${collection}/${id}`, options);
+    }
+    /**
+     * Add subscriptions for an object. If a subscription already exists, it will be
+     * updated. This endpoint also handles
+     * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
+     * for the `recipient`.
+     *
+     * @example
+     * ```ts
+     * const subscriptions = await client.objects.addSubscriptions(
+     *   'collection',
+     *   'object_id',
+     *   {
+     *     recipients: ['user_1', 'user_2'],
+     *     properties: { key: 'value' },
+     *   },
+     * );
+     * ```
+     */
+    addSubscriptions(collection, objectID, body, options) {
+        return this._client.post(path `/v1/objects/${collection}/${objectID}/subscriptions`, { body, ...options });
+    }
+    /**
+     * Delete subscriptions for the specified recipients from an object. Returns the
+     * list of deleted subscriptions.
+     *
+     * @example
+     * ```ts
+     * const subscriptions =
+     *   await client.objects.deleteSubscriptions(
+     *     'collection',
+     *     'object_id',
+     *     { recipients: ['user_123'] },
+     *   );
+     * ```
+     */
+    deleteSubscriptions(collection, objectID, body, options) {
+        return this._client.delete(path `/v1/objects/${collection}/${objectID}/subscriptions`, {
+            body,
+            ...options,
+        });
+    }
+    /**
+     * Retrieves a specific object by its ID from the specified collection. Returns the
+     * object with all its properties.
+     *
+     * @example
+     * ```ts
+     * const object = await client.objects.get('collection', 'id');
+     * ```
+     */
+    get(collection, id, options) {
+        return this._client.get(path `/v1/objects/${collection}/${id}`, options);
+    }
+    /**
+     * Returns the channel data for the specified object and channel.
+     *
+     * @example
+     * ```ts
+     * const channelData = await client.objects.getChannelData(
+     *   'collection',
+     *   'object_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
+     */
+    getChannelData(collection, objectID, channelID, options) {
+        return this._client.get(path `/v1/objects/${collection}/${objectID}/channel_data/${channelID}`, options);
+    }
+    /**
+     * Returns the preference set for the specified object and preference set `id`.
+     *
+     * @example
+     * ```ts
+     * const preferenceSet = await client.objects.getPreferences(
+     *   'collection',
+     *   'object_id',
+     *   'default',
+     * );
+     * ```
+     */
+    getPreferences(collection, objectID, id, options) {
+        return this._client.get(path `/v1/objects/${collection}/${objectID}/preferences/${id}`, options);
+    }
+    /**
+     * Returns a paginated list of messages for a specific object in the given
+     * collection. Allows filtering by message status and provides various sorting
+     * options.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const message of client.objects.listMessages(
+     *   'projects',
+     *   'project-123',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    listMessages(collection, id, query = {}, options) {
+        return this._client.getAPIList(path `/v1/objects/${collection}/${id}/messages`, (EntriesCursor), { query, ...options });
+    }
+    /**
+     * Returns a paginated list of preference sets for the specified object.
+     *
+     * @example
+     * ```ts
+     * const preferenceSets = await client.objects.listPreferences(
+     *   'collection',
+     *   'object_id',
+     * );
+     * ```
+     */
+    listPreferences(collection, objectID, options) {
+        return this._client.get(path `/v1/objects/${collection}/${objectID}/preferences`, options);
+    }
+    /**
+     * Returns a paginated list of schedules for an object.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const schedule of client.objects.listSchedules(
+     *   'collection',
+     *   'id',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    listSchedules(collection, id, query = {}, options) {
+        return this._client.getAPIList(path `/v1/objects/${collection}/${id}/schedules`, (EntriesCursor), { query, ...options });
+    }
+    /**
+     * List subscriptions for an object. Either list the recipients that subscribe to
+     * the provided object, or list the objects that the provided object is subscribed
+     * to. Determined by the `mode` query parameter.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const subscription of client.objects.listSubscriptions(
+     *   'collection',
+     *   'object_id',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    listSubscriptions(collection, objectID, query = {}, options) {
+        return this._client.getAPIList(path `/v1/objects/${collection}/${objectID}/subscriptions`, (EntriesCursor), { query, ...options });
+    }
+    /**
+     * Creates a new object or updates an existing one in the specified collection.
+     * This operation is used to identify objects with their properties, as well as
+     * optional preferences and channel data.
+     *
+     * @example
+     * ```ts
+     * const object = await client.objects.set(
+     *   'collection',
+     *   'id',
+     *   {
+     *     channel_data: {
+     *       '97c5837d-c65c-4d54-aa39-080eeb81c69d': {
+     *         data: { tokens: ['push_token_123'] },
+     *       },
+     *     },
+     *     locale: 'en-US',
+     *     preferences: {
+     *       default: {
+     *         channel_types: { email: true },
+     *         workflows: {
+     *           'dinosaurs-loose': {
+     *             channel_types: { email: true },
+     *           },
+     *         },
+     *       },
+     *     },
+     *     timezone: 'America/New_York',
+     *   },
+     * );
+     * ```
+     */
+    set(collection, id, body, options) {
+        return this._client.put(path `/v1/objects/${collection}/${id}`, { body, ...options });
+    }
+    /**
+     * Sets the channel data for the specified object and channel. If no object exists
+     * in the current environment for the given `collection` and `object_id`, Knock
+     * will create the object as part of this request.
+     *
+     * @example
+     * ```ts
+     * const channelData = await client.objects.setChannelData(
+     *   'collection',
+     *   'object_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { data: { tokens: ['push_token_1'] } },
+     * );
+     * ```
+     */
+    setChannelData(collection, objectID, channelID, body, options) {
+        return this._client.put(path `/v1/objects/${collection}/${objectID}/channel_data/${channelID}`, {
+            body,
+            ...options,
+        });
+    }
+    /**
+     * Sets preferences within the given preference set. This is a destructive
+     * operation and will replace any existing preferences with the preferences given.
+     * If no object exists in the current environment for the given `:collection` and
+     * `:object_id`, Knock will create the object as part of this request. The
+     * preference set `:id` can be either `default` or a `tenant.id`. Learn more about
+     * [per-tenant preferences](/preferences/tenant-preferences).
+     *
+     * @example
+     * ```ts
+     * const preferenceSet = await client.objects.setPreferences(
+     *   'collection',
+     *   'object_id',
+     *   'default',
+     *   {
+     *     categories: {
+     *       marketing: false,
+     *       transactional: { channel_types: { email: false } },
+     *     },
+     *     channel_types: { email: true },
+     *     workflows: {
+     *       'dinosaurs-loose': {
+     *         channel_types: { email: false },
+     *       },
+     *     },
+     *   },
+     * );
+     * ```
+     */
+    setPreferences(collection, objectID, id, body, options) {
+        return this._client.put(path `/v1/objects/${collection}/${objectID}/preferences/${id}`, {
+            body,
+            ...options,
+        });
+    }
+    /**
+     * Unsets the channel data for the specified object and channel.
+     *
+     * @example
+     * ```ts
+     * const response = await client.objects.unsetChannelData(
+     *   'collection',
+     *   'object_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
+     */
+    unsetChannelData(collection, objectID, channelID, options) {
+        return this._client.delete(path `/v1/objects/${collection}/${objectID}/channel_data/${channelID}`, options);
+    }
+}
+Objects.Bulk = Bulk;
+//# sourceMappingURL=objects.mjs.map

package/resources/objects/objects.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.mjs","sourceRoot":"","sources":["../../src/resources/objects/objects.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,KAAK,OAAO;OACZ,EAAE,IAAI,EAA+D;OASrE,EAAE,aAAa,EAAyC;OAExD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAgYtD,CAAC;IA9XC;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,UAAkB,EAClB,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,eAAe,UAAU,EAAE,EAAE,CAAA,aAAqB,CAAA,EAAE;YACrF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,UAAkB,EAAE,EAAU,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,eAAe,UAAU,IAAI,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,gBAAgB,CACd,UAAkB,EAClB,QAAgB,EAChB,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,eAAe,UAAU,IAAI,QAAQ,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CACjB,UAAkB,EAClB,QAAgB,EAChB,IAAqC,EACrC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,eAAe,UAAU,IAAI,QAAQ,gBAAgB,EAAE;YACpF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,GAAG,CAAC,UAAkB,EAAE,EAAU,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,UAAU,IAAI,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,UAAkB,EAClB,QAAgB,EAChB,SAAiB,EACjB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,UAAU,IAAI,QAAQ,iBAAiB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1G,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,UAAkB,EAClB,QAAgB,EAChB,EAAU,EACV,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,UAAU,IAAI,QAAQ,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CACV,UAAkB,EAClB,EAAU,EACV,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,eAAe,UAAU,IAAI,EAAE,WAAW,EAC9C,CAAA,aAAkC,CAAA,EAClC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,eAAe,CACb,UAAkB,EAClB,QAAgB,EAChB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,UAAU,IAAI,QAAQ,cAAc,EAAE,OAAO,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,UAAkB,EAClB,EAAU,EACV,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,eAAe,UAAU,IAAI,EAAE,YAAY,EAC/C,CAAA,aAAoC,CAAA,EACpC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,CACf,UAAkB,EAClB,QAAgB,EAChB,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,eAAe,UAAU,IAAI,QAAQ,gBAAgB,EACzD,CAAA,aAA4C,CAAA,EAC5C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,GAAG,CAAC,UAAkB,EAAE,EAAU,EAAE,IAAqB,EAAE,OAAwB;QACjF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,UAAU,IAAI,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,cAAc,CACZ,UAAkB,EAClB,QAAgB,EAChB,SAAiB,EACjB,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,UAAU,IAAI,QAAQ,iBAAiB,SAAS,EAAE,EAAE;YAC7F,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,cAAc,CACZ,UAAkB,EAClB,QAAgB,EAChB,EAAU,EACV,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,UAAU,IAAI,QAAQ,gBAAgB,EAAE,EAAE,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,gBAAgB,CACd,UAAkB,EAClB,QAAgB,EAChB,SAAiB,EACjB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CACxB,IAAI,CAAA,eAAe,UAAU,IAAI,QAAQ,iBAAiB,SAAS,EAAE,EACrE,OAAO,CACR,CAAC;IACJ,CAAC;CACF;AAqWD,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC"}

package/resources/objects.d.mts

@@ -0,0 +1,2 @@
+export * from "./objects/index.mjs";
+//# sourceMappingURL=objects.d.mts.map

package/resources/objects.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.d.mts","sourceRoot":"","sources":["../src/resources/objects.ts"],"names":[],"mappings":""}

package/resources/objects.d.ts

@@ -0,0 +1,2 @@
+export * from "./objects/index.js";
+//# sourceMappingURL=objects.d.ts.map

package/resources/objects.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.d.ts","sourceRoot":"","sources":["../src/resources/objects.ts"],"names":[],"mappings":""}

package/resources/objects.js

@@ -0,0 +1,6 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("../internal/tslib.js");
+tslib_1.__exportStar(require("./objects/index.js"), exports);
+//# sourceMappingURL=objects.js.map

package/resources/objects.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.js","sourceRoot":"","sources":["../src/resources/objects.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6DAAgC"}

package/resources/objects.mjs

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export * from "./objects/index.mjs";
+//# sourceMappingURL=objects.mjs.map

package/resources/objects.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.mjs","sourceRoot":"","sources":["../src/resources/objects.ts"],"names":[],"mappings":"AAAA,sFAAsF"}

package/resources/providers/index.d.mts

@@ -0,0 +1,4 @@
+export { MsTeams, type MsTeamCheckAuthResponse, type MsTeamListChannelsResponse, type MsTeamListTeamsResponse, type MsTeamRevokeAccessResponse, type MsTeamCheckAuthParams, type MsTeamListChannelsParams, type MsTeamListTeamsParams, type MsTeamRevokeAccessParams, type MsTeamListTeamsResponsesMsTeamsPagination, } from "./ms-teams.mjs";
+export { Providers } from "./providers.mjs";
+export { Slack, type SlackCheckAuthResponse, type SlackListChannelsResponse, type SlackRevokeAccessResponse, type SlackCheckAuthParams, type SlackListChannelsParams, type SlackRevokeAccessParams, type SlackListChannelsResponsesSlackChannelsCursor, } from "./slack.mjs";
+//# sourceMappingURL=index.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/providers/index.ts"],"names":[],"mappings":"OAEO,EACL,OAAO,EACP,KAAK,uBAAuB,EAC5B,KAAK,0BAA0B,EAC/B,KAAK,uBAAuB,EAC5B,KAAK,0BAA0B,EAC/B,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,yCAAyC,GAC/C;OACM,EAAE,SAAS,EAAE;OACb,EACL,KAAK,EACL,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EAC9B,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,6CAA6C,GACnD"}