@knocklabs/node 1.0.0 → 1.2.0

package/resources/tenants/bulk.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"bulk.mjs","sourceRoot":"","sources":["../../src/resources/tenants/bulk.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAMtB,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;OAEG;IACH,MAAM,CAAC,MAAwB,EAAE,OAAwB;QACvD,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,IAAmB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF"}
+{"version":3,"file":"bulk.mjs","sourceRoot":"","sources":["../../src/resources/tenants/bulk.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAMtB,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAwB,EAAE,OAAwB;QACvD,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,IAAmB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF"}

package/resources/tenants/tenants.d.mts

@@ -10,19 +10,52 @@ export declare class Tenants extends APIResource {
     bulk: BulkAPI.Bulk;
     /**
      * List tenants for the current environment.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const tenant of client.tenants.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query?: TenantListParams | null | undefined, options?: RequestOptions): PagePromise<TenantsEntriesCursor, Tenant>;
     /**
      * Delete a tenant and all associated data. This operation cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const tenant = await client.tenants.delete('id');
+     * ```
      */
     delete(id: string, options?: RequestOptions): APIPromise<string>;
     /**
      * Get a tenant by ID.
+     *
+     * @example
+     * ```ts
+     * const tenant = await client.tenants.get('id');
+     * ```
      */
     get(id: string, options?: RequestOptions): APIPromise<Tenant>;
     /**
      * Sets a tenant within an environment, performing an upsert operation. Any
      * existing properties will be merged with the incoming properties.
+     *
+     * @example
+     * ```ts
+     * const tenant = await client.tenants.set('id', {
+     *   settings: {
+     *     branding: {
+     *       icon_url:
+     *         'https://example.com/trex_silhouette_icon.png',
+     *       logo_url: 'https://example.com/amber_fossil_logo.png',
+     *       primary_color: '#DF1A22',
+     *       primary_color_contrast: '#FFDE00',
+     *     },
+     *   },
+     * });
+     * ```
      */
     set(id: string, body: TenantSetParams, options?: RequestOptions): APIPromise<Tenant>;
 }

package/resources/tenants/tenants.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"tenants.d.mts","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,KAAK,cAAc;OACnB,KAAK,OAAO;OACZ,EAAE,IAAI,EAAE,gBAAgB,EAAE,aAAa,EAAE;OACzC,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;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAC;IAI5C;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIhE;;OAEG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI7D;;;OAGG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAGrF;AAED,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,aAAa,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAElC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEpC;;;WAGG;QACH,cAAc,CAAC,EAAE,cAAc,CAAC,aAAa,GAAG,IAAI,CAAC;KACtD;IAED,UAAiB,QAAQ,CAAC;QACxB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxC;KACF;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAE/D;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC,QAAQ,CAAC;IAElC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,aAAa,CAAC;IAC7B;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;QAE7B;;WAEG;QACH,cAAc,CAAC,EAAE,cAAc,CAAC,oBAAoB,GAAG,IAAI,CAAC;KAC7D;IAED,UAAiB,QAAQ,CAAC;QACxB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxC;KACF;CACF;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAE1C,MAAM,WAAW,gBAAiB,SAAQ,mBAAmB;IAC3D;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAE/D;;OAEG;IACH,QAAQ,CAAC,EAAE,eAAe,CAAC,QAAQ,CAAC;IAEpC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;QAE7B;;WAEG;QACH,cAAc,CAAC,EAAE,cAAc,CAAC,oBAAoB,GAAG,IAAI,CAAC;KAC7D;IAED,UAAiB,QAAQ,CAAC;QACxB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxC;KACF;CACF;AAID,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;IAEF,OAAO,EAAE,IAAI,IAAI,IAAI,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,KAAK,aAAa,IAAI,aAAa,EAAE,CAAC;CACzG"}
+{"version":3,"file":"tenants.d.mts","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,KAAK,cAAc;OACnB,KAAK,OAAO;OACZ,EAAE,IAAI,EAAE,gBAAgB,EAAE,aAAa,EAAE;OACzC,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;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAC;IAI5C;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIhE;;;;;;;OAOG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI7D;;;;;;;;;;;;;;;;;;OAkBG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAGrF;AAED,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,aAAa,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAElC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEpC;;;WAGG;QACH,cAAc,CAAC,EAAE,cAAc,CAAC,aAAa,GAAG,IAAI,CAAC;KACtD;IAED,UAAiB,QAAQ,CAAC;QACxB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxC;KACF;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAE/D;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC,QAAQ,CAAC;IAElC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,aAAa,CAAC;IAC7B;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;QAE7B;;WAEG;QACH,cAAc,CAAC,EAAE,cAAc,CAAC,oBAAoB,GAAG,IAAI,CAAC;KAC7D;IAED,UAAiB,QAAQ,CAAC;QACxB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxC;KACF;CACF;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAE1C,MAAM,WAAW,gBAAiB,SAAQ,mBAAmB;IAC3D;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAE/D;;OAEG;IACH,QAAQ,CAAC,EAAE,eAAe,CAAC,QAAQ,CAAC;IAEpC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;QAE7B;;WAEG;QACH,cAAc,CAAC,EAAE,cAAc,CAAC,oBAAoB,GAAG,IAAI,CAAC;KAC7D;IAED,UAAiB,QAAQ,CAAC;QACxB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxC;KACF;CACF;AAID,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;IAEF,OAAO,EAAE,IAAI,IAAI,IAAI,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,KAAK,aAAa,IAAI,aAAa,EAAE,CAAC;CACzG"}

package/resources/tenants/tenants.d.ts

@@ -10,19 +10,52 @@ export declare class Tenants extends APIResource {
     bulk: BulkAPI.Bulk;
     /**
      * List tenants for the current environment.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const tenant of client.tenants.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query?: TenantListParams | null | undefined, options?: RequestOptions): PagePromise<TenantsEntriesCursor, Tenant>;
     /**
      * Delete a tenant and all associated data. This operation cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const tenant = await client.tenants.delete('id');
+     * ```
      */
     delete(id: string, options?: RequestOptions): APIPromise<string>;
     /**
      * Get a tenant by ID.
+     *
+     * @example
+     * ```ts
+     * const tenant = await client.tenants.get('id');
+     * ```
      */
     get(id: string, options?: RequestOptions): APIPromise<Tenant>;
     /**
      * Sets a tenant within an environment, performing an upsert operation. Any
      * existing properties will be merged with the incoming properties.
+     *
+     * @example
+     * ```ts
+     * const tenant = await client.tenants.set('id', {
+     *   settings: {
+     *     branding: {
+     *       icon_url:
+     *         'https://example.com/trex_silhouette_icon.png',
+     *       logo_url: 'https://example.com/amber_fossil_logo.png',
+     *       primary_color: '#DF1A22',
+     *       primary_color_contrast: '#FFDE00',
+     *     },
+     *   },
+     * });
+     * ```
      */
     set(id: string, body: TenantSetParams, options?: RequestOptions): APIPromise<Tenant>;
 }

package/resources/tenants/tenants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tenants.d.ts","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,KAAK,cAAc;OACnB,KAAK,OAAO;OACZ,EAAE,IAAI,EAAE,gBAAgB,EAAE,aAAa,EAAE;OACzC,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;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAC;IAI5C;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIhE;;OAEG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI7D;;;OAGG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAGrF;AAED,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,aAAa,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAElC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEpC;;;WAGG;QACH,cAAc,CAAC,EAAE,cAAc,CAAC,aAAa,GAAG,IAAI,CAAC;KACtD;IAED,UAAiB,QAAQ,CAAC;QACxB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxC;KACF;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAE/D;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC,QAAQ,CAAC;IAElC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,aAAa,CAAC;IAC7B;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;QAE7B;;WAEG;QACH,cAAc,CAAC,EAAE,cAAc,CAAC,oBAAoB,GAAG,IAAI,CAAC;KAC7D;IAED,UAAiB,QAAQ,CAAC;QACxB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxC;KACF;CACF;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAE1C,MAAM,WAAW,gBAAiB,SAAQ,mBAAmB;IAC3D;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAE/D;;OAEG;IACH,QAAQ,CAAC,EAAE,eAAe,CAAC,QAAQ,CAAC;IAEpC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;QAE7B;;WAEG;QACH,cAAc,CAAC,EAAE,cAAc,CAAC,oBAAoB,GAAG,IAAI,CAAC;KAC7D;IAED,UAAiB,QAAQ,CAAC;QACxB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxC;KACF;CACF;AAID,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;IAEF,OAAO,EAAE,IAAI,IAAI,IAAI,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,KAAK,aAAa,IAAI,aAAa,EAAE,CAAC;CACzG"}
+{"version":3,"file":"tenants.d.ts","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,KAAK,cAAc;OACnB,KAAK,OAAO;OACZ,EAAE,IAAI,EAAE,gBAAgB,EAAE,aAAa,EAAE;OACzC,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;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAC;IAI5C;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIhE;;;;;;;OAOG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI7D;;;;;;;;;;;;;;;;;;OAkBG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAGrF;AAED,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,aAAa,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAElC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEpC;;;WAGG;QACH,cAAc,CAAC,EAAE,cAAc,CAAC,aAAa,GAAG,IAAI,CAAC;KACtD;IAED,UAAiB,QAAQ,CAAC;QACxB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxC;KACF;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAE/D;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC,QAAQ,CAAC;IAElC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,aAAa,CAAC;IAC7B;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;QAE7B;;WAEG;QACH,cAAc,CAAC,EAAE,cAAc,CAAC,oBAAoB,GAAG,IAAI,CAAC;KAC7D;IAED,UAAiB,QAAQ,CAAC;QACxB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxC;KACF;CACF;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAE1C,MAAM,WAAW,gBAAiB,SAAQ,mBAAmB;IAC3D;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAE/D;;OAEG;IACH,QAAQ,CAAC,EAAE,eAAe,CAAC,QAAQ,CAAC;IAEpC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;QAE7B;;WAEG;QACH,cAAc,CAAC,EAAE,cAAc,CAAC,oBAAoB,GAAG,IAAI,CAAC;KAC7D;IAED,UAAiB,QAAQ,CAAC;QACxB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxC;KACF;CACF;AAID,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;IAEF,OAAO,EAAE,IAAI,IAAI,IAAI,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,KAAK,aAAa,IAAI,aAAa,EAAE,CAAC;CACzG"}

package/resources/tenants/tenants.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.Tenants = 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");
@@ -37,18 +15,36 @@ class Tenants extends resource_1.APIResource {
     }
     /**
      * List tenants for the current environment.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const tenant of client.tenants.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query = {}, options) {
         return this._client.getAPIList('/v1/tenants', (pagination_1.EntriesCursor), { query, ...options });
     }
     /**
      * Delete a tenant and all associated data. This operation cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const tenant = await client.tenants.delete('id');
+     * ```
      */
     delete(id, options) {
         return this._client.delete((0, path_1.path) `/v1/tenants/${id}`, options);
     }
     /**
      * Get a tenant by ID.
+     *
+     * @example
+     * ```ts
+     * const tenant = await client.tenants.get('id');
+     * ```
      */
     get(id, options) {
         return this._client.get((0, path_1.path) `/v1/tenants/${id}`, options);
@@ -56,6 +52,21 @@ class Tenants extends resource_1.APIResource {
     /**
      * Sets a tenant within an environment, performing an upsert operation. Any
      * existing properties will be merged with the incoming properties.
+     *
+     * @example
+     * ```ts
+     * const tenant = await client.tenants.set('id', {
+     *   settings: {
+     *     branding: {
+     *       icon_url:
+     *         'https://example.com/trex_silhouette_icon.png',
+     *       logo_url: 'https://example.com/amber_fossil_logo.png',
+     *       primary_color: '#DF1A22',
+     *       primary_color_contrast: '#FFDE00',
+     *     },
+     *   },
+     * });
+     * ```
      */
     set(id, body, options) {
         return this._client.put((0, path_1.path) `/v1/tenants/${id}`, { body, ...options });

package/resources/tenants/tenants.js.map

@@ -1 +1 @@
-{"version":3,"file":"tenants.js","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,qDAAkD;AAGlD,mDAAkC;AAClC,oCAA+D;AAE/D,yDAA6F;AAE7F,uDAAiD;AAEjD,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAiCtD,CAAC;IA/BC;;OAEG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,0BAAqB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,EAAU,EAAE,OAAwB;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,EAAU,EAAE,IAAqB,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF;AAlCD,0BAkCC;AA+OD,OAAO,CAAC,IAAI,GAAG,WAAI,CAAC"}
+{"version":3,"file":"tenants.js","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAGlD,2DAAkC;AAClC,oCAA+D;AAE/D,yDAA6F;AAE7F,uDAAiD;AAEjD,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkEtD,CAAC;IAhEC;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,0BAAqB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,EAAU,EAAE,OAAwB;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,GAAG,CAAC,EAAU,EAAE,IAAqB,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF;AAnED,0BAmEC;AA+OD,OAAO,CAAC,IAAI,GAAG,WAAI,CAAC"}

package/resources/tenants/tenants.mjs

@@ -11,18 +11,36 @@ export class Tenants extends APIResource {
     }
     /**
      * List tenants for the current environment.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const tenant of client.tenants.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query = {}, options) {
         return this._client.getAPIList('/v1/tenants', (EntriesCursor), { query, ...options });
     }
     /**
      * Delete a tenant and all associated data. This operation cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const tenant = await client.tenants.delete('id');
+     * ```
      */
     delete(id, options) {
         return this._client.delete(path `/v1/tenants/${id}`, options);
     }
     /**
      * Get a tenant by ID.
+     *
+     * @example
+     * ```ts
+     * const tenant = await client.tenants.get('id');
+     * ```
      */
     get(id, options) {
         return this._client.get(path `/v1/tenants/${id}`, options);
@@ -30,6 +48,21 @@ export class Tenants extends APIResource {
     /**
      * Sets a tenant within an environment, performing an upsert operation. Any
      * existing properties will be merged with the incoming properties.
+     *
+     * @example
+     * ```ts
+     * const tenant = await client.tenants.set('id', {
+     *   settings: {
+     *     branding: {
+     *       icon_url:
+     *         'https://example.com/trex_silhouette_icon.png',
+     *       logo_url: 'https://example.com/amber_fossil_logo.png',
+     *       primary_color: '#DF1A22',
+     *       primary_color_contrast: '#FFDE00',
+     *     },
+     *   },
+     * });
+     * ```
      */
     set(id, body, options) {
         return this._client.put(path `/v1/tenants/${id}`, { body, ...options });

package/resources/tenants/tenants.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"tenants.mjs","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,OAAO;OACZ,EAAE,IAAI,EAAmC;OAEzC,EAAE,aAAa,EAAyC;OAExD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAiCtD,CAAC;IA/BC;;OAEG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,aAAqB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,EAAU,EAAE,OAAwB;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,EAAU,EAAE,IAAqB,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF;AA+OD,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC"}
+{"version":3,"file":"tenants.mjs","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,OAAO;OACZ,EAAE,IAAI,EAAmC;OAEzC,EAAE,aAAa,EAAyC;OAExD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkEtD,CAAC;IAhEC;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,aAAqB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,EAAU,EAAE,OAAwB;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,GAAG,CAAC,EAAU,EAAE,IAAqB,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF;AA+OD,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC"}

package/resources/tenants.js

@@ -1,19 +1,6 @@
 "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 __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./tenants/index.js"), exports);
+const tslib_1 = require("../internal/tslib.js");
+tslib_1.__exportStar(require("./tenants/index.js"), exports);
 //# sourceMappingURL=tenants.js.map

package/resources/tenants.js.map

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

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>;
 }