@knocklabs/node 1.0.0 → 1.1.0

package/resources/users/bulk.d.mts

@@ -8,18 +8,59 @@ export declare class Bulk extends APIResource {
     /**
      * Deletes multiple users in a single operation. Accepts up to 100 user IDs to
      * delete and returns a bulk operation that can be queried for progress.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation = await client.users.bulk.delete({
+     *   user_ids: ['user_1', 'user_2'],
+     * });
+     * ```
      */
     delete(body: BulkDeleteParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
     /**
      * Identifies multiple users in a single operation. Allows creating or updating up
      * to 100 users in a single batch with various properties, preferences, and channel
      * data.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation = await client.users.bulk.identify({
+     *   users: [
+     *     {
+     *       email: 'jane@ingen.net',
+     *       id: 'user_1',
+     *       name: 'Jane Doe',
+     *       timezone: 'America/New_York',
+     *     },
+     *   ],
+     * });
+     * ```
      */
     identify(body: BulkIdentifyParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
     /**
      * Sets preferences for multiple users in a single operation. Supports either
      * setting the same preferences for multiple users or specific preferences for each
      * user.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation =
+     *   await client.users.bulk.setPreferences({
+     *     preferences: {
+     *       categories: {
+     *         marketing: false,
+     *         transactional: { channel_types: { email: false } },
+     *       },
+     *       channel_types: { email: true },
+     *       workflows: {
+     *         'dinosaurs-loose': {
+     *           channel_types: { email: false },
+     *         },
+     *       },
+     *     },
+     *     user_ids: ['user_1', 'user_2'],
+     *   });
+     * ```
      */
     setPreferences(body: BulkSetPreferencesParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
 }

package/resources/users/bulk.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"bulk.d.mts","sourceRoot":"","sources":["../../src/resources/users/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,cAAc;OACnB,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAIrG;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAIzG;;;;OAIG;IACH,cAAc,CACZ,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAG/C;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,WAAW,EAAE,cAAc,CAAC,oBAAoB,CAAC;IAEjD;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
+{"version":3,"file":"bulk.d.mts","sourceRoot":"","sources":["../../src/resources/users/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,cAAc;OACnB,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAIrG;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAIzG;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,cAAc,CACZ,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAG/C;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,WAAW,EAAE,cAAc,CAAC,oBAAoB,CAAC;IAEjD;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/users/bulk.d.ts

@@ -8,18 +8,59 @@ export declare class Bulk extends APIResource {
     /**
      * Deletes multiple users in a single operation. Accepts up to 100 user IDs to
      * delete and returns a bulk operation that can be queried for progress.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation = await client.users.bulk.delete({
+     *   user_ids: ['user_1', 'user_2'],
+     * });
+     * ```
      */
     delete(body: BulkDeleteParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
     /**
      * Identifies multiple users in a single operation. Allows creating or updating up
      * to 100 users in a single batch with various properties, preferences, and channel
      * data.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation = await client.users.bulk.identify({
+     *   users: [
+     *     {
+     *       email: 'jane@ingen.net',
+     *       id: 'user_1',
+     *       name: 'Jane Doe',
+     *       timezone: 'America/New_York',
+     *     },
+     *   ],
+     * });
+     * ```
      */
     identify(body: BulkIdentifyParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
     /**
      * Sets preferences for multiple users in a single operation. Supports either
      * setting the same preferences for multiple users or specific preferences for each
      * user.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation =
+     *   await client.users.bulk.setPreferences({
+     *     preferences: {
+     *       categories: {
+     *         marketing: false,
+     *         transactional: { channel_types: { email: false } },
+     *       },
+     *       channel_types: { email: true },
+     *       workflows: {
+     *         'dinosaurs-loose': {
+     *           channel_types: { email: false },
+     *         },
+     *       },
+     *     },
+     *     user_ids: ['user_1', 'user_2'],
+     *   });
+     * ```
      */
     setPreferences(body: BulkSetPreferencesParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"bulk.d.ts","sourceRoot":"","sources":["../../src/resources/users/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,cAAc;OACnB,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAIrG;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAIzG;;;;OAIG;IACH,cAAc,CACZ,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAG/C;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,WAAW,EAAE,cAAc,CAAC,oBAAoB,CAAC;IAEjD;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
+{"version":3,"file":"bulk.d.ts","sourceRoot":"","sources":["../../src/resources/users/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,cAAc;OACnB,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAIrG;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAIzG;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,cAAc,CACZ,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAG/C;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,WAAW,EAAE,cAAc,CAAC,oBAAoB,CAAC;IAEjD;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/users/bulk.js

@@ -7,6 +7,13 @@ class Bulk extends resource_1.APIResource {
     /**
      * Deletes multiple users in a single operation. Accepts up to 100 user IDs to
      * delete and returns a bulk operation that can be queried for progress.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation = await client.users.bulk.delete({
+     *   user_ids: ['user_1', 'user_2'],
+     * });
+     * ```
      */
     delete(body, options) {
         return this._client.post('/v1/users/bulk/delete', { body, ...options });
@@ -15,6 +22,20 @@ class Bulk extends resource_1.APIResource {
      * Identifies multiple users in a single operation. Allows creating or updating up
      * to 100 users in a single batch with various properties, preferences, and channel
      * data.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation = await client.users.bulk.identify({
+     *   users: [
+     *     {
+     *       email: 'jane@ingen.net',
+     *       id: 'user_1',
+     *       name: 'Jane Doe',
+     *       timezone: 'America/New_York',
+     *     },
+     *   ],
+     * });
+     * ```
      */
     identify(body, options) {
         return this._client.post('/v1/users/bulk/identify', { body, ...options });
@@ -23,6 +44,26 @@ class Bulk extends resource_1.APIResource {
      * Sets preferences for multiple users in a single operation. Supports either
      * setting the same preferences for multiple users or specific preferences for each
      * user.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation =
+     *   await client.users.bulk.setPreferences({
+     *     preferences: {
+     *       categories: {
+     *         marketing: false,
+     *         transactional: { channel_types: { email: false } },
+     *       },
+     *       channel_types: { email: true },
+     *       workflows: {
+     *         'dinosaurs-loose': {
+     *           channel_types: { email: false },
+     *         },
+     *       },
+     *     },
+     *     user_ids: ['user_1', 'user_2'],
+     *   });
+     * ```
      */
     setPreferences(body, options) {
         return this._client.post('/v1/users/bulk/preferences', { body, ...options });

package/resources/users/bulk.js.map

@@ -1 +1 @@
-{"version":3,"file":"bulk.js","sourceRoot":"","sources":["../../src/resources/users/bulk.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAOlD,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;OAGG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,IAAwB,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,cAAc,CACZ,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF;AA7BD,oBA6BC"}
+{"version":3,"file":"bulk.js","sourceRoot":"","sources":["../../src/resources/users/bulk.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAOlD,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CAAC,IAAwB,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,cAAc,CACZ,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF;AAtED,oBAsEC"}

package/resources/users/bulk.mjs

@@ -4,6 +4,13 @@ export class Bulk extends APIResource {
     /**
      * Deletes multiple users in a single operation. Accepts up to 100 user IDs to
      * delete and returns a bulk operation that can be queried for progress.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation = await client.users.bulk.delete({
+     *   user_ids: ['user_1', 'user_2'],
+     * });
+     * ```
      */
     delete(body, options) {
         return this._client.post('/v1/users/bulk/delete', { body, ...options });
@@ -12,6 +19,20 @@ export class Bulk extends APIResource {
      * Identifies multiple users in a single operation. Allows creating or updating up
      * to 100 users in a single batch with various properties, preferences, and channel
      * data.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation = await client.users.bulk.identify({
+     *   users: [
+     *     {
+     *       email: 'jane@ingen.net',
+     *       id: 'user_1',
+     *       name: 'Jane Doe',
+     *       timezone: 'America/New_York',
+     *     },
+     *   ],
+     * });
+     * ```
      */
     identify(body, options) {
         return this._client.post('/v1/users/bulk/identify', { body, ...options });
@@ -20,6 +41,26 @@ export class Bulk extends APIResource {
      * Sets preferences for multiple users in a single operation. Supports either
      * setting the same preferences for multiple users or specific preferences for each
      * user.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation =
+     *   await client.users.bulk.setPreferences({
+     *     preferences: {
+     *       categories: {
+     *         marketing: false,
+     *         transactional: { channel_types: { email: false } },
+     *       },
+     *       channel_types: { email: true },
+     *       workflows: {
+     *         'dinosaurs-loose': {
+     *           channel_types: { email: false },
+     *         },
+     *       },
+     *     },
+     *     user_ids: ['user_1', 'user_2'],
+     *   });
+     * ```
      */
     setPreferences(body, options) {
         return this._client.post('/v1/users/bulk/preferences', { body, ...options });

package/resources/users/bulk.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"bulk.mjs","sourceRoot":"","sources":["../../src/resources/users/bulk.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAOtB,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;OAGG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,IAAwB,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,cAAc,CACZ,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF"}
+{"version":3,"file":"bulk.mjs","sourceRoot":"","sources":["../../src/resources/users/bulk.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAOtB,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CAAC,IAAwB,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,cAAc,CACZ,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF"}

package/resources/users/feeds.d.mts

@@ -7,11 +7,30 @@ import { RequestOptions } from "../../internal/request-options.mjs";
 export declare class Feeds extends APIResource {
     /**
      * Returns the feed settings for a user.
+     *
+     * @example
+     * ```ts
+     * const response = await client.users.feeds.getSettings(
+     *   'user_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
      */
     getSettings(userID: string, id: string, options?: RequestOptions): APIPromise<FeedGetSettingsResponse>;
     /**
      * Returns a paginated list of feed items for a user, including metadata about the
      * feed.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const feedListItemsResponse of client.users.feeds.listItems(
+     *   'user_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listItems(userID: string, id: string, query?: FeedListItemsParams | null | undefined, options?: RequestOptions): PagePromise<FeedListItemsResponsesEntriesCursor, FeedListItemsResponse>;
 }

package/resources/users/feeds.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"feeds.d.mts","sourceRoot":"","sources":["../../src/resources/users/feeds.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAItG;;;OAGG;IACH,SAAS,CACP,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,qBAAqB,CAAC;CAO3E;AAED,MAAM,MAAM,mCAAmC,GAAG,aAAa,CAAC,qBAAqB,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,QAAQ,EAAE,uBAAuB,CAAC,QAAQ,CAAC;CAC5C;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,iBAAiB,EAAE,OAAO,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAExC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAEvC;;OAEG;IACH,MAAM,EAAE,KAAK,CACX,qBAAqB,CAAC,4BAA4B,GAAG,qBAAqB,CAAC,8BAA8B,CAC1G,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,qBAAqB,CAAC,MAAM,CAAC;IAErC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,4BAA4B;QAC3C;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,8BAA8B;QAC7C;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;QAEtD;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,YAAY,CAAC;KACpB;IAED,UAAiB,8BAA8B,CAAC;QAC9C;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;IAE1C;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAC;IAEvD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACrC;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"feeds.d.mts","sourceRoot":"","sources":["../../src/resources/users/feeds.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAItG;;;;;;;;;;;;;;OAcG;IACH,SAAS,CACP,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,qBAAqB,CAAC;CAO3E;AAED,MAAM,MAAM,mCAAmC,GAAG,aAAa,CAAC,qBAAqB,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,QAAQ,EAAE,uBAAuB,CAAC,QAAQ,CAAC;CAC5C;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,iBAAiB,EAAE,OAAO,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAExC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAEvC;;OAEG;IACH,MAAM,EAAE,KAAK,CACX,qBAAqB,CAAC,4BAA4B,GAAG,qBAAqB,CAAC,8BAA8B,CAC1G,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,qBAAqB,CAAC,MAAM,CAAC;IAErC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,4BAA4B;QAC3C;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,8BAA8B;QAC7C;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;QAEtD;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,YAAY,CAAC;KACpB;IAED,UAAiB,8BAA8B,CAAC;QAC9C;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;IAE1C;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAC;IAEvD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACrC;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/users/feeds.d.ts

@@ -7,11 +7,30 @@ import { RequestOptions } from "../../internal/request-options.js";
 export declare class Feeds extends APIResource {
     /**
      * Returns the feed settings for a user.
+     *
+     * @example
+     * ```ts
+     * const response = await client.users.feeds.getSettings(
+     *   'user_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
      */
     getSettings(userID: string, id: string, options?: RequestOptions): APIPromise<FeedGetSettingsResponse>;
     /**
      * Returns a paginated list of feed items for a user, including metadata about the
      * feed.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const feedListItemsResponse of client.users.feeds.listItems(
+     *   'user_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listItems(userID: string, id: string, query?: FeedListItemsParams | null | undefined, options?: RequestOptions): PagePromise<FeedListItemsResponsesEntriesCursor, FeedListItemsResponse>;
 }

package/resources/users/feeds.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"feeds.d.ts","sourceRoot":"","sources":["../../src/resources/users/feeds.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAItG;;;OAGG;IACH,SAAS,CACP,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,qBAAqB,CAAC;CAO3E;AAED,MAAM,MAAM,mCAAmC,GAAG,aAAa,CAAC,qBAAqB,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,QAAQ,EAAE,uBAAuB,CAAC,QAAQ,CAAC;CAC5C;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,iBAAiB,EAAE,OAAO,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAExC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAEvC;;OAEG;IACH,MAAM,EAAE,KAAK,CACX,qBAAqB,CAAC,4BAA4B,GAAG,qBAAqB,CAAC,8BAA8B,CAC1G,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,qBAAqB,CAAC,MAAM,CAAC;IAErC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,4BAA4B;QAC3C;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,8BAA8B;QAC7C;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;QAEtD;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,YAAY,CAAC;KACpB;IAED,UAAiB,8BAA8B,CAAC;QAC9C;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;IAE1C;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAC;IAEvD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACrC;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"feeds.d.ts","sourceRoot":"","sources":["../../src/resources/users/feeds.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAItG;;;;;;;;;;;;;;OAcG;IACH,SAAS,CACP,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,qBAAqB,CAAC;CAO3E;AAED,MAAM,MAAM,mCAAmC,GAAG,aAAa,CAAC,qBAAqB,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,QAAQ,EAAE,uBAAuB,CAAC,QAAQ,CAAC;CAC5C;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,iBAAiB,EAAE,OAAO,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAExC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAEvC;;OAEG;IACH,MAAM,EAAE,KAAK,CACX,qBAAqB,CAAC,4BAA4B,GAAG,qBAAqB,CAAC,8BAA8B,CAC1G,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,qBAAqB,CAAC,MAAM,CAAC;IAErC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,4BAA4B;QAC3C;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,8BAA8B;QAC7C;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;QAEtD;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,YAAY,CAAC;KACpB;IAED,UAAiB,8BAA8B,CAAC;QAC9C;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;IAE1C;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAC;IAEvD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACrC;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/users/feeds.js

@@ -8,6 +8,14 @@ const path_1 = require("../../internal/utils/path.js");
 class Feeds extends resource_1.APIResource {
     /**
      * Returns the feed settings for a user.
+     *
+     * @example
+     * ```ts
+     * const response = await client.users.feeds.getSettings(
+     *   'user_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
      */
     getSettings(userID, id, options) {
         return this._client.get((0, path_1.path) `/v1/users/${userID}/feeds/${id}/settings`, options);
@@ -15,6 +23,17 @@ class Feeds extends resource_1.APIResource {
     /**
      * Returns a paginated list of feed items for a user, including metadata about the
      * feed.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const feedListItemsResponse of client.users.feeds.listItems(
+     *   'user_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listItems(userID, id, query = {}, options) {
         return this._client.getAPIList((0, path_1.path) `/v1/users/${userID}/feeds/${id}`, (pagination_1.EntriesCursor), { query, ...options });

package/resources/users/feeds.js.map

@@ -1 +1 @@
-{"version":3,"file":"feeds.js","sourceRoot":"","sources":["../../src/resources/users/feeds.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,yDAA6F;AAE7F,uDAAiD;AAEjD,MAAa,KAAM,SAAQ,sBAAW;IACpC;;OAEG;IACH,WAAW,CAAC,MAAc,EAAE,EAAU,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,UAAU,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IACnF,CAAC;IAED;;;OAGG;IACH,SAAS,CACP,MAAc,EACd,EAAU,EACV,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,aAAa,MAAM,UAAU,EAAE,EAAE,EACrC,CAAA,0BAAoC,CAAA,EACpC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AAxBD,sBAwBC"}
+{"version":3,"file":"feeds.js","sourceRoot":"","sources":["../../src/resources/users/feeds.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,yDAA6F;AAE7F,uDAAiD;AAEjD,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;OAUG;IACH,WAAW,CAAC,MAAc,EAAE,EAAU,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,UAAU,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,SAAS,CACP,MAAc,EACd,EAAU,EACV,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,aAAa,MAAM,UAAU,EAAE,EAAE,EACrC,CAAA,0BAAoC,CAAA,EACpC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AA3CD,sBA2CC"}

package/resources/users/feeds.mjs

@@ -5,6 +5,14 @@ import { path } from "../../internal/utils/path.mjs";
 export class Feeds extends APIResource {
     /**
      * Returns the feed settings for a user.
+     *
+     * @example
+     * ```ts
+     * const response = await client.users.feeds.getSettings(
+     *   'user_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
      */
     getSettings(userID, id, options) {
         return this._client.get(path `/v1/users/${userID}/feeds/${id}/settings`, options);
@@ -12,6 +20,17 @@ export class Feeds extends APIResource {
     /**
      * Returns a paginated list of feed items for a user, including metadata about the
      * feed.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const feedListItemsResponse of client.users.feeds.listItems(
+     *   'user_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listItems(userID, id, query = {}, options) {
         return this._client.getAPIList(path `/v1/users/${userID}/feeds/${id}`, (EntriesCursor), { query, ...options });

package/resources/users/feeds.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"feeds.mjs","sourceRoot":"","sources":["../../src/resources/users/feeds.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,aAAa,EAAyC;OAExD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,WAAW,CAAC,MAAc,EAAE,EAAU,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,UAAU,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IACnF,CAAC;IAED;;;OAGG;IACH,SAAS,CACP,MAAc,EACd,EAAU,EACV,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,aAAa,MAAM,UAAU,EAAE,EAAE,EACrC,CAAA,aAAoC,CAAA,EACpC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"feeds.mjs","sourceRoot":"","sources":["../../src/resources/users/feeds.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,aAAa,EAAyC;OAExD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,WAAW,CAAC,MAAc,EAAE,EAAU,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,UAAU,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,SAAS,CACP,MAAc,EACd,EAAU,EACV,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,aAAa,MAAM,UAAU,EAAE,EAAE,EACrC,CAAA,aAAoC,CAAA,EACpC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF"}

package/resources/users/guides.d.mts

@@ -4,21 +4,89 @@ import { RequestOptions } from "../../internal/request-options.mjs";
 export declare class Guides extends APIResource {
     /**
      * Returns a list of eligible in-app guides for a specific user and channel.
+     *
+     * @example
+     * ```ts
+     * const response = await client.users.guides.getChannel(
+     *   'user_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
      */
     getChannel(userID: string, channelID: string, query?: GuideGetChannelParams | null | undefined, options?: RequestOptions): APIPromise<GuideGetChannelResponse>;
     /**
      * Records that a guide has been archived by a user, triggering any associated
      * archived events.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.users.guides.markMessageAsArchived(
+     *     'user_id',
+     *     'message_id',
+     *     {
+     *       channel_id: '123e4567-e89b-12d3-a456-426614174000',
+     *       guide_id: '7e9dc78c-b3b1-4127-a54e-71f1899b831a',
+     *       guide_key: 'tour_notification',
+     *       guide_step_ref: 'lab_tours',
+     *     },
+     *   );
+     * ```
      */
     markMessageAsArchived(userID: string, messageID: string, body: GuideMarkMessageAsArchivedParams, options?: RequestOptions): APIPromise<GuideMarkMessageAsArchivedResponse>;
     /**
      * Records that a user has interacted with a guide, triggering any associated
      * interacted events.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.users.guides.markMessageAsInteracted(
+     *     'user_id',
+     *     'message_id',
+     *     {
+     *       channel_id: '123e4567-e89b-12d3-a456-426614174000',
+     *       guide_id: '7e9dc78c-b3b1-4127-a54e-71f1899b831a',
+     *       guide_key: 'tour_notification',
+     *       guide_step_ref: 'lab_tours',
+     *     },
+     *   );
+     * ```
      */
     markMessageAsInteracted(userID: string, messageID: string, body: GuideMarkMessageAsInteractedParams, options?: RequestOptions): APIPromise<GuideMarkMessageAsInteractedResponse>;
     /**
      * Records that a guide has been seen by a user, triggering any associated seen
      * events.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.users.guides.markMessageAsSeen(
+     *     'user_id',
+     *     'message_id',
+     *     {
+     *       channel_id: '123e4567-e89b-12d3-a456-426614174000',
+     *       guide_id: '7e9dc78c-b3b1-4127-a54e-71f1899b831a',
+     *       guide_key: 'tour_notification',
+     *       guide_step_ref: 'lab_tours',
+     *       content: {
+     *         body: "Limited spots available for today's behind-the-scenes DNA extraction demonstration.",
+     *         title: 'DNA Lab Tour Available',
+     *       },
+     *       data: {
+     *         next_time: '14:30',
+     *         spots_left: 8,
+     *         tour_id: 'dna_lab_tour',
+     *       },
+     *       metadata: {
+     *         cta: 'Reserve Spot',
+     *         theme: 'amber',
+     *         type: 'banner',
+     *       },
+     *       tenant: 'ingen_isla_nublar',
+     *     },
+     *   );
+     * ```
      */
     markMessageAsSeen(userID: string, messageID: string, body: GuideMarkMessageAsSeenParams, options?: RequestOptions): APIPromise<GuideMarkMessageAsSeenResponse>;
 }

package/resources/users/guides.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"guides.d.mts","sourceRoot":"","sources":["../../src/resources/users/guides.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,UAAU,CACR,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;;OAGG;IACH,qBAAqB,CACnB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,gCAAgC,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kCAAkC,CAAC;IAOjD;;;OAGG;IACH,uBAAuB,CACrB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,kCAAkC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAOnD;;;OAGG;IACH,iBAAiB,CACf,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAM9C;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC;IAE7C;;OAEG;IACH,SAAS,CAAC,EAAE,uBAAuB,CAAC,SAAS,GAAG,IAAI,CAAC;CACtD;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,KAAK;QACpB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEnC;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;KACb;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
+{"version":3,"file":"guides.d.mts","sourceRoot":"","sources":["../../src/resources/users/guides.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;OAUG;IACH,UAAU,CACR,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;;;;;;;;;;;;;;;;;OAkBG;IACH,qBAAqB,CACnB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,gCAAgC,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kCAAkC,CAAC;IAOjD;;;;;;;;;;;;;;;;;;OAkBG;IACH,uBAAuB,CACrB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,kCAAkC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAOnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,iBAAiB,CACf,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAM9C;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC;IAE7C;;OAEG;IACH,SAAS,CAAC,EAAE,uBAAuB,CAAC,SAAS,GAAG,IAAI,CAAC;CACtD;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,KAAK;QACpB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEnC;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;KACb;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}

package/resources/users/guides.d.ts

@@ -4,21 +4,89 @@ import { RequestOptions } from "../../internal/request-options.js";
 export declare class Guides extends APIResource {
     /**
      * Returns a list of eligible in-app guides for a specific user and channel.
+     *
+     * @example
+     * ```ts
+     * const response = await client.users.guides.getChannel(
+     *   'user_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
      */
     getChannel(userID: string, channelID: string, query?: GuideGetChannelParams | null | undefined, options?: RequestOptions): APIPromise<GuideGetChannelResponse>;
     /**
      * Records that a guide has been archived by a user, triggering any associated
      * archived events.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.users.guides.markMessageAsArchived(
+     *     'user_id',
+     *     'message_id',
+     *     {
+     *       channel_id: '123e4567-e89b-12d3-a456-426614174000',
+     *       guide_id: '7e9dc78c-b3b1-4127-a54e-71f1899b831a',
+     *       guide_key: 'tour_notification',
+     *       guide_step_ref: 'lab_tours',
+     *     },
+     *   );
+     * ```
      */
     markMessageAsArchived(userID: string, messageID: string, body: GuideMarkMessageAsArchivedParams, options?: RequestOptions): APIPromise<GuideMarkMessageAsArchivedResponse>;
     /**
      * Records that a user has interacted with a guide, triggering any associated
      * interacted events.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.users.guides.markMessageAsInteracted(
+     *     'user_id',
+     *     'message_id',
+     *     {
+     *       channel_id: '123e4567-e89b-12d3-a456-426614174000',
+     *       guide_id: '7e9dc78c-b3b1-4127-a54e-71f1899b831a',
+     *       guide_key: 'tour_notification',
+     *       guide_step_ref: 'lab_tours',
+     *     },
+     *   );
+     * ```
      */
     markMessageAsInteracted(userID: string, messageID: string, body: GuideMarkMessageAsInteractedParams, options?: RequestOptions): APIPromise<GuideMarkMessageAsInteractedResponse>;
     /**
      * Records that a guide has been seen by a user, triggering any associated seen
      * events.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.users.guides.markMessageAsSeen(
+     *     'user_id',
+     *     'message_id',
+     *     {
+     *       channel_id: '123e4567-e89b-12d3-a456-426614174000',
+     *       guide_id: '7e9dc78c-b3b1-4127-a54e-71f1899b831a',
+     *       guide_key: 'tour_notification',
+     *       guide_step_ref: 'lab_tours',
+     *       content: {
+     *         body: "Limited spots available for today's behind-the-scenes DNA extraction demonstration.",
+     *         title: 'DNA Lab Tour Available',
+     *       },
+     *       data: {
+     *         next_time: '14:30',
+     *         spots_left: 8,
+     *         tour_id: 'dna_lab_tour',
+     *       },
+     *       metadata: {
+     *         cta: 'Reserve Spot',
+     *         theme: 'amber',
+     *         type: 'banner',
+     *       },
+     *       tenant: 'ingen_isla_nublar',
+     *     },
+     *   );
+     * ```
      */
     markMessageAsSeen(userID: string, messageID: string, body: GuideMarkMessageAsSeenParams, options?: RequestOptions): APIPromise<GuideMarkMessageAsSeenResponse>;
 }