@knocklabs/node 1.0.0 → 1.2.0

package/resources/objects/objects.d.ts

@@ -19,11 +19,29 @@ export declare class Objects extends APIResource {
     /**
      * 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: string, query?: ObjectListParams | null | undefined, options?: RequestOptions): PagePromise<ObjectsEntriesCursor, Object>;
     /**
      * 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: string, id: string, options?: RequestOptions): APIPromise<string>;
     /**
@@ -31,56 +49,179 @@ export declare class Objects extends APIResource {
      * 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: string, objectID: string, body: ObjectAddSubscriptionsParams, options?: RequestOptions): APIPromise<ObjectAddSubscriptionsResponse>;
     /**
      * 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: string, objectID: string, body: ObjectDeleteSubscriptionsParams, options?: RequestOptions): APIPromise<ObjectDeleteSubscriptionsResponse>;
     /**
      * 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: string, id: string, options?: RequestOptions): APIPromise<Object>;
     /**
      * 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: string, objectID: string, channelID: string, options?: RequestOptions): APIPromise<ChannelDataAPI.ChannelData>;
     /**
      * 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: string, objectID: string, id: string, options?: RequestOptions): APIPromise<PreferencesAPI.PreferenceSet>;
     /**
      * 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: string, id: string, query?: ObjectListMessagesParams | null | undefined, options?: RequestOptions): PagePromise<MessagesEntriesCursor, MessagesAPI.Message>;
     /**
      * Returns a paginated list of preference sets for the specified object.
+     *
+     * @example
+     * ```ts
+     * const preferenceSets = await client.objects.listPreferences(
+     *   'collection',
+     *   'object_id',
+     * );
+     * ```
      */
     listPreferences(collection: string, objectID: string, options?: RequestOptions): APIPromise<ObjectListPreferencesResponse>;
     /**
      * 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: string, id: string, query?: ObjectListSchedulesParams | null | undefined, options?: RequestOptions): PagePromise<SchedulesEntriesCursor, SchedulesAPI.Schedule>;
     /**
      * 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: string, objectID: string, query?: ObjectListSubscriptionsParams | null | undefined, options?: RequestOptions): PagePromise<SubscriptionsEntriesCursor, SubscriptionsAPI.Subscription>;
     /**
      * 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': {
+     *         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: string, id: string, body: ObjectSetParams, options?: RequestOptions): APIPromise<Object>;
     /**
      * 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: string, objectID: string, channelID: string, body: ObjectSetChannelDataParams, options?: RequestOptions): APIPromise<ChannelDataAPI.ChannelData>;
     /**
@@ -90,10 +231,40 @@ export declare class Objects extends APIResource {
      * `: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: string, objectID: string, id: string, body: ObjectSetPreferencesParams, options?: RequestOptions): APIPromise<PreferencesAPI.PreferenceSet>;
     /**
      * 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: string, objectID: string, channelID: string, options?: RequestOptions): APIPromise<string>;
 }
@@ -148,7 +319,10 @@ export interface Object {
      * Timestamp when the resource was created.
      */
     created_at?: string | null;
-    [k: string]: unknown;
+    /**
+     * The custom properties associated with the object.
+     */
+    properties?: Record<string, unknown>;
 }
 /**
  * A `204 No Content` response.
@@ -321,10 +495,10 @@ export interface ObjectSetParams {
      */
     preferences?: PreferencesAPI.InlinePreferenceSetRequest;
     /**
-     * The timezone of the object. Must be a valid
-     * [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
-     * Used for
-     * [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
+     * The timezone of the object. Must be a
+     * valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
+     * Used
+     * for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
      */
     timezone?: string | null;
     [k: string]: unknown;

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

@@ -1 +1 @@
-{"version":3,"file":"objects.d.ts","sourceRoot":"","sources":["../../src/resources/objects/objects.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,KAAK,WAAW;OAChB,EAAE,qBAAqB,EAAE;OACzB,KAAK,OAAO;OACZ,EAAE,IAAI,EAAE,0BAA0B,EAAE,gBAAgB,EAAE,aAAa,EAAE;OACrE,KAAK,cAAc;OACnB,KAAK,cAAc;OACnB,KAAK,aAAa;OAClB,KAAK,gBAAgB;OACrB,EAAE,0BAA0B,EAAE;OAC9B,KAAK,YAAY;OACjB,EAAE,sBAAsB,EAAE;OAC1B,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IAEpD;;;OAGG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAC;IAO5C;;;OAGG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIpF;;;;;OAKG;IACH,gBAAgB,CACd,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C;;;OAGG;IACH,mBAAmB,CACjB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAOhD;;;OAGG;IACH,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIjF;;OAEG;IACH,cAAc,CACZ,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,WAAW,CAAC;IAIzC;;OAEG;IACH,cAAc,CACZ,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,aAAa,CAAC;IAI3C;;;;OAIG;IACH,YAAY,CACV,UAAU,EAAE,MAAM,EAClB,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qBAAqB,EAAE,WAAW,CAAC,OAAO,CAAC;IAQ1D;;OAEG;IACH,eAAe,CACb,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;OAEG;IACH,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sBAAsB,EAAE,YAAY,CAAC,QAAQ,CAAC;IAQ7D;;;;OAIG;IACH,iBAAiB,CACf,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,gBAAgB,CAAC,YAAY,CAAC;IAQzE;;;;OAIG;IACH,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIxG;;;;OAIG;IACH,cAAc,CACZ,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,WAAW,CAAC;IAOzC;;;;;;;OAOG;IACH,cAAc,CACZ,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,aAAa,CAAC;IAO3C;;OAEG;IACH,gBAAgB,CACd,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;CAMtB;AAED,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAE/D,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,KAAK,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;AAElF;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG,KAAK,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;AAErF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,KAAK,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;AAEhF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,MAAM,CAAC;AAEpD,MAAM,WAAW,gBAAiB,SAAQ,mBAAmB;IAC3D;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAElD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CAC7C;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;CACrD;AAED,MAAM,WAAW,wBAAyB,SAAQ,mBAAmB;IACnE;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,YAAY,GAAG,cAAc,GAAG,UAAU,CAAC,CAAC;IAExF,WAAW,CAAC,EAAE,wBAAwB,CAAC,UAAU,CAAC;IAElD;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CACZ,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,oBAAoB,GAAG,aAAa,GAAG,UAAU,GAAG,SAAS,CAChG,CAAC;IAEF;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,yBAA0B,SAAQ,mBAAmB;IACpE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,6BAA8B,SAAQ,mBAAmB;IACxE;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAE/B;;;;OAIG;IACH,IAAI,CAAC,EAAE,WAAW,GAAG,QAAQ,CAAC;IAE9B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,6BAA6B,CAAC,MAAM,CAAC,CAAC;IAEtD;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;CACtD;AAED,yBAAiB,6BAA6B,CAAC;IAC7C;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,CAAC;IAEvD;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,CAAC;IAExD;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,IAAI,EACA,cAAc,CAAC,eAAe,GAC9B,cAAc,CAAC,oBAAoB,GACnC,cAAc,CAAC,gBAAgB,GAC/B,cAAc,CAAC,kBAAkB,GACjC,cAAc,CAAC,kBAAkB,CAAC;CACvC;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CACjB,MAAM,EACN,OAAO,GAAG,0BAA0B,CAAC,0CAA0C,CAChF,GAAG,IAAI,CAAC;IAET;;OAEG;IACH,aAAa,CAAC,EAAE,cAAc,CAAC,yBAAyB,GAAG,IAAI,CAAC;IAEhE;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAChB,MAAM,EACN,OAAO,GAAG,0BAA0B,CAAC,0CAA0C,CAChF,GAAG,IAAI,CAAC;CACV;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;;OAGG;IACH,UAAiB,0CAA0C;QACzD;;WAEG;QACH,aAAa,CAAC,EAAE,cAAc,CAAC,yBAAyB,GAAG,IAAI,CAAC;QAEhE;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;KAChD;IAED;;;OAGG;IACH,UAAiB,0CAA0C;QACzD;;WAEG;QACH,aAAa,CAAC,EAAE,cAAc,CAAC,yBAAyB,GAAG,IAAI,CAAC;QAEhE;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;KAChD;CACF;AAID,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;IAEF,OAAO,EACL,IAAI,IAAI,IAAI,EACZ,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;CACH;AAED,OAAO,EAAE,KAAK,qBAAqB,EAAE,KAAK,sBAAsB,EAAE,KAAK,0BAA0B,EAAE,CAAC"}
+{"version":3,"file":"objects.d.ts","sourceRoot":"","sources":["../../src/resources/objects/objects.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,KAAK,WAAW;OAChB,EAAE,qBAAqB,EAAE;OACzB,KAAK,OAAO;OACZ,EAAE,IAAI,EAAE,0BAA0B,EAAE,gBAAgB,EAAE,aAAa,EAAE;OACrE,KAAK,cAAc;OACnB,KAAK,cAAc;OACnB,KAAK,aAAa;OAClB,KAAK,gBAAgB;OACrB,EAAE,0BAA0B,EAAE;OAC9B,KAAK,YAAY;OACjB,EAAE,sBAAsB,EAAE;OAC1B,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IAEpD;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAC;IAO5C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIpF;;;;;;;;;;;;;;;;;OAiBG;IACH,gBAAgB,CACd,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CACjB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAOhD;;;;;;;;OAQG;IACH,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIjF;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,WAAW,CAAC;IAIzC;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,aAAa,CAAC;IAI3C;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CACV,UAAU,EAAE,MAAM,EAClB,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qBAAqB,EAAE,WAAW,CAAC,OAAO,CAAC;IAQ1D;;;;;;;;;;OAUG;IACH,eAAe,CACb,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sBAAsB,EAAE,YAAY,CAAC,QAAQ,CAAC;IAQ7D;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,CACf,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,gBAAgB,CAAC,YAAY,CAAC;IAQzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIxG;;;;;;;;;;;;;;OAcG;IACH,cAAc,CACZ,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,WAAW,CAAC;IAOzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,cAAc,CACZ,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,aAAa,CAAC;IAO3C;;;;;;;;;;;OAWG;IACH,gBAAgB,CACd,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;CAMtB;AAED,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAE/D,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,KAAK,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;AAElF;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG,KAAK,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;AAErF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,KAAK,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;AAEhF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,MAAM,CAAC;AAEpD,MAAM,WAAW,gBAAiB,SAAQ,mBAAmB;IAC3D;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAElD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CAC7C;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;CACrD;AAED,MAAM,WAAW,wBAAyB,SAAQ,mBAAmB;IACnE;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,YAAY,GAAG,cAAc,GAAG,UAAU,CAAC,CAAC;IAExF,WAAW,CAAC,EAAE,wBAAwB,CAAC,UAAU,CAAC;IAElD;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CACZ,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,oBAAoB,GAAG,aAAa,GAAG,UAAU,GAAG,SAAS,CAChG,CAAC;IAEF;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,yBAA0B,SAAQ,mBAAmB;IACpE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,6BAA8B,SAAQ,mBAAmB;IACxE;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAE/B;;;;OAIG;IACH,IAAI,CAAC,EAAE,WAAW,GAAG,QAAQ,CAAC;IAE9B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,6BAA6B,CAAC,MAAM,CAAC,CAAC;IAEtD;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;CACtD;AAED,yBAAiB,6BAA6B,CAAC;IAC7C;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,CAAC;IAEvD;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,CAAC;IAExD;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,IAAI,EACA,cAAc,CAAC,eAAe,GAC9B,cAAc,CAAC,oBAAoB,GACnC,cAAc,CAAC,gBAAgB,GAC/B,cAAc,CAAC,kBAAkB,GACjC,cAAc,CAAC,kBAAkB,CAAC;CACvC;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CACjB,MAAM,EACN,OAAO,GAAG,0BAA0B,CAAC,0CAA0C,CAChF,GAAG,IAAI,CAAC;IAET;;OAEG;IACH,aAAa,CAAC,EAAE,cAAc,CAAC,yBAAyB,GAAG,IAAI,CAAC;IAEhE;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAChB,MAAM,EACN,OAAO,GAAG,0BAA0B,CAAC,0CAA0C,CAChF,GAAG,IAAI,CAAC;CACV;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;;OAGG;IACH,UAAiB,0CAA0C;QACzD;;WAEG;QACH,aAAa,CAAC,EAAE,cAAc,CAAC,yBAAyB,GAAG,IAAI,CAAC;QAEhE;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;KAChD;IAED;;;OAGG;IACH,UAAiB,0CAA0C;QACzD;;WAEG;QACH,aAAa,CAAC,EAAE,cAAc,CAAC,yBAAyB,GAAG,IAAI,CAAC;QAEhE;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;KAChD;CACF;AAID,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;IAEF,OAAO,EACL,IAAI,IAAI,IAAI,EACZ,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;CACH;AAED,OAAO,EAAE,KAAK,qBAAqB,EAAE,KAAK,sBAAsB,EAAE,KAAK,0BAA0B,EAAE,CAAC"}

package/resources/objects/objects.js

@@ -1,32 +1,10 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 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 = __importStar(require("./bulk.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");
@@ -38,6 +16,16 @@ class Objects extends resource_1.APIResource {
     /**
      * 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), {
@@ -48,6 +36,14 @@ class Objects extends resource_1.APIResource {
     /**
      * 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);
@@ -57,6 +53,18 @@ class Objects extends resource_1.APIResource {
      * 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 });
@@ -64,6 +72,16 @@ class Objects extends resource_1.APIResource {
     /**
      * 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`, {
@@ -74,18 +92,41 @@ class Objects extends resource_1.APIResource {
     /**
      * 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);
@@ -94,18 +135,48 @@ class Objects extends resource_1.APIResource {
      * 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 });
@@ -114,6 +185,17 @@ class Objects extends resource_1.APIResource {
      * 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 });
@@ -122,6 +204,33 @@ class Objects extends resource_1.APIResource {
      * 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': {
+     *         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 });
@@ -130,6 +239,16 @@ class Objects extends resource_1.APIResource {
      * 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}`, {
@@ -144,6 +263,27 @@ class Objects extends resource_1.APIResource {
      * `: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}`, {
@@ -153,6 +293,15 @@ class Objects extends resource_1.APIResource {
     }
     /**
      * 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);

package/resources/objects/objects.js.map

@@ -1 +1 @@
-{"version":3,"file":"objects.js","sourceRoot":"","sources":["../../src/resources/objects/objects.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,qDAAkD;AAIlD,mDAAkC;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;IAqNtD,CAAC;IAnNC;;;OAGG;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;;;OAGG;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;;;;;OAKG;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;;;OAGG;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;;;OAGG;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;;OAEG;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;;OAEG;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;;;;OAIG;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;;OAEG;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;;OAEG;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;;;;OAIG;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;;;;OAIG;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;;;;OAIG;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;;;;;;;OAOG;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;;OAEG;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;AAtND,0BAsNC;AAqWD,OAAO,CAAC,IAAI,GAAG,WAAI,CAAC"}
+{"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;AAwWD,OAAO,CAAC,IAAI,GAAG,WAAI,CAAC"}