@knocklabs/node 1.0.0 → 1.1.0

package/resources/users/users.mjs

@@ -19,6 +19,30 @@ export class Users extends APIResource {
      * Create or update a user with the provided identification data. When you identify
      * an existing user, the system merges the properties you specific with what is
      * currently set on the user, updating only the fields included in your requests.
+     *
+     * @example
+     * ```ts
+     * const user = await client.users.update('user_id', {
+     *   channel_data: {
+     *     '97c5837d-c65c-4d54-aa39-080eeb81c69d': {
+     *       data: { tokens: ['push_token_123'] },
+     *     },
+     *   },
+     *   email: 'ian.malcolm@chaos.theory',
+     *   name: 'Dr. Ian Malcolm',
+     *   preferences: {
+     *     default: {
+     *       channel_types: { email: true },
+     *       workflows: {
+     *         'dinosaurs-loose': {
+     *           channel_types: { email: true },
+     *         },
+     *       },
+     *     },
+     *   },
+     *   timezone: 'America/New_York',
+     * });
+     * ```
      */
     update(userID, body, options) {
         return this._client.put(path `/v1/users/${userID}`, { body, ...options });
@@ -26,24 +50,50 @@ export class Users extends APIResource {
     /**
      * Retrieve a paginated list of users in the environment. Defaults to 50 users per
      * page.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const user of client.users.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query = {}, options) {
         return this._client.getAPIList('/v1/users', (EntriesCursor), { query, ...options });
     }
     /**
      * Permanently delete a user and all associated data.
+     *
+     * @example
+     * ```ts
+     * const user = await client.users.delete('user_id');
+     * ```
      */
     delete(userID, options) {
         return this._client.delete(path `/v1/users/${userID}`, options);
     }
     /**
      * Retrieve a specific user by their ID.
+     *
+     * @example
+     * ```ts
+     * const user = await client.users.get('user_id');
+     * ```
      */
     get(userID, options) {
         return this._client.get(path `/v1/users/${userID}`, options);
     }
     /**
      * Retrieves the channel data for a specific user and channel ID.
+     *
+     * @example
+     * ```ts
+     * const channelData = await client.users.getChannelData(
+     *   'user_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
      */
     getChannelData(userID, channelID, options) {
         return this._client.get(path `/v1/users/${userID}/channel_data/${channelID}`, options);
@@ -51,6 +101,14 @@ export class Users extends APIResource {
     /**
      * Retrieves a specific preference set for a user identified by the preference set
      * ID.
+     *
+     * @example
+     * ```ts
+     * const preferenceSet = await client.users.getPreferences(
+     *   'user_id',
+     *   'default',
+     * );
+     * ```
      */
     getPreferences(userID, id, query = {}, options) {
         return this._client.get(path `/v1/users/${userID}/preferences/${id}`, { query, ...options });
@@ -59,6 +117,16 @@ export class Users extends APIResource {
      * Returns a paginated list of messages for a specific user. Allows filtering by
      * message status and provides various sorting options. Messages outside the
      * account's retention window will not be included in the results.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const message of client.users.listMessages(
+     *   'user-123',
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listMessages(userID, query = {}, options) {
         return this._client.getAPIList(path `/v1/users/${userID}/messages`, (EntriesCursor), {
@@ -68,12 +136,29 @@ export class Users extends APIResource {
     }
     /**
      * Retrieves a list of all preference sets for a specific user.
+     *
+     * @example
+     * ```ts
+     * const preferenceSets = await client.users.listPreferences(
+     *   'user_id',
+     * );
+     * ```
      */
     listPreferences(userID, options) {
         return this._client.get(path `/v1/users/${userID}/preferences`, options);
     }
     /**
      * Returns a paginated list of schedules for a specific user, in descending order.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const schedule of client.users.listSchedules(
+     *   'user_id',
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listSchedules(userID, query = {}, options) {
         return this._client.getAPIList(path `/v1/users/${userID}/schedules`, (EntriesCursor), { query, ...options });
@@ -81,6 +166,16 @@ export class Users extends APIResource {
     /**
      * Retrieves a paginated list of subscriptions for a specific user, in descending
      * order.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const subscription of client.users.listSubscriptions(
+     *   'user_id',
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listSubscriptions(userID, query = {}, options) {
         return this._client.getAPIList(path `/v1/users/${userID}/subscriptions`, (EntriesCursor), { query, ...options });
@@ -88,12 +183,28 @@ export class Users extends APIResource {
     /**
      * Merge two users together, where the user specified with the `from_user_id` param
      * will be merged into the user specified by `user_id`.
+     *
+     * @example
+     * ```ts
+     * const user = await client.users.merge('user_id', {
+     *   from_user_id: 'user_1',
+     * });
+     * ```
      */
     merge(userID, body, options) {
         return this._client.post(path `/v1/users/${userID}/merge`, { body, ...options });
     }
     /**
      * Updates or creates channel data for a specific user and channel ID.
+     *
+     * @example
+     * ```ts
+     * const channelData = await client.users.setChannelData(
+     *   'user_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { data: { tokens: ['push_token_1'] } },
+     * );
+     * ```
      */
     setChannelData(userID, channelID, body, options) {
         return this._client.put(path `/v1/users/${userID}/channel_data/${channelID}`, { body, ...options });
@@ -101,12 +212,40 @@ export class Users extends APIResource {
     /**
      * Updates a complete preference set for a user. This is a destructive operation
      * that will replace the existing preference set for the user.
+     *
+     * @example
+     * ```ts
+     * const preferenceSet = await client.users.setPreferences(
+     *   'user_id',
+     *   'default',
+     *   {
+     *     categories: {
+     *       marketing: false,
+     *       transactional: { channel_types: { email: false } },
+     *     },
+     *     channel_types: { email: true },
+     *     workflows: {
+     *       'dinosaurs-loose': {
+     *         channel_types: { email: false },
+     *       },
+     *     },
+     *   },
+     * );
+     * ```
      */
     setPreferences(userID, id, body, options) {
         return this._client.put(path `/v1/users/${userID}/preferences/${id}`, { body, ...options });
     }
     /**
      * Deletes channel data for a specific user and channel ID.
+     *
+     * @example
+     * ```ts
+     * const response = await client.users.unsetChannelData(
+     *   'user_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
      */
     unsetChannelData(userID, channelID, options) {
         return this._client.delete(path `/v1/users/${userID}/channel_data/${channelID}`, options);

package/resources/users/users.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"users.mjs","sourceRoot":"","sources":["../../src/resources/users/users.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAUf,KAAK,OAAO;OACZ,EAAE,IAAI,EAAkE;OACxE,KAAK,QAAQ;OACb,EAKL,KAAK,GACN;OACM,KAAK,SAAS;OACd,EASL,MAAM,GACP;OAEM,EAAE,aAAa,EAAyC;OAExD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IAAtC;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAyJtD,CAAC;IAvJC;;;;OAIG;IACH,MAAM,CAAC,MAAc,EAAE,IAAsB,EAAE,OAAwB;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;OAGG;IACH,IAAI,CACF,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,aAAmB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,MAAc,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,MAAc,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,cAAc,CACZ,MAAc,EACd,SAAiB,EACjB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,iBAAiB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED;;;OAGG;IACH,cAAc,CACZ,MAAc,EACd,EAAU,EACV,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,gBAAgB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;OAIG;IACH,YAAY,CACV,MAAc,EACd,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,aAAa,MAAM,WAAW,EAAE,CAAA,aAAkC,CAAA,EAAE;YACrG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,MAAc,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,cAAc,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;OAEG;IACH,aAAa,CACX,MAAc,EACd,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,aAAa,MAAM,YAAY,EACnC,CAAA,aAAoC,CAAA,EACpC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,iBAAiB,CACf,MAAc,EACd,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,aAAa,MAAM,gBAAgB,EACvC,CAAA,aAA4C,CAAA,EAC5C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAc,EAAE,IAAqB,EAAE,OAAwB;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,MAAM,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;OAEG;IACH,cAAc,CACZ,MAAc,EACd,SAAiB,EACjB,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,iBAAiB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;OAGG;IACH,cAAc,CACZ,MAAc,EACd,EAAU,EACV,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,gBAAgB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACH,gBAAgB,CAAC,MAAc,EAAE,SAAiB,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,MAAM,iBAAiB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;CACF;AAkaD,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;AACpB,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;AACtB,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC"}
+{"version":3,"file":"users.mjs","sourceRoot":"","sources":["../../src/resources/users/users.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAUf,KAAK,OAAO;OACZ,EAAE,IAAI,EAAkE;OACxE,KAAK,QAAQ;OACb,EAKL,KAAK,GACN;OACM,KAAK,SAAS;OACd,EASL,MAAM,GACP;OAEM,EAAE,aAAa,EAAyC;OAExD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IAAtC;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAoStD,CAAC;IAlSC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CAAC,MAAc,EAAE,IAAsB,EAAE,OAAwB;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,aAAmB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,MAAc,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,MAAc,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc,CACZ,MAAc,EACd,SAAiB,EACjB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,iBAAiB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,MAAc,EACd,EAAU,EACV,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,gBAAgB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,YAAY,CACV,MAAc,EACd,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,aAAa,MAAM,WAAW,EAAE,CAAA,aAAkC,CAAA,EAAE;YACrG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,eAAe,CAAC,MAAc,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,cAAc,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,MAAc,EACd,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,aAAa,MAAM,YAAY,EACnC,CAAA,aAAoC,CAAA,EACpC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CACf,MAAc,EACd,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,aAAa,MAAM,gBAAgB,EACvC,CAAA,aAA4C,CAAA,EAC5C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAc,EAAE,IAAqB,EAAE,OAAwB;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,MAAM,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,MAAc,EACd,SAAiB,EACjB,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,iBAAiB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,cAAc,CACZ,MAAc,EACd,EAAU,EACV,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,gBAAgB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;OAUG;IACH,gBAAgB,CAAC,MAAc,EAAE,SAAiB,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,MAAM,iBAAiB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;CACF;AAobD,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;AACpB,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;AACtB,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC"}

package/resources/users.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("./users/index.js"), exports);
+const tslib_1 = require("../internal/tslib.js");
+tslib_1.__exportStar(require("./users/index.js"), exports);
 //# sourceMappingURL=users.js.map

package/resources/users.js.map

@@ -1 +1 @@
-{"version":3,"file":"users.js","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;AAEtF,mDAA8B"}
+{"version":3,"file":"users.js","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,2DAA8B"}

package/resources/workflows.d.mts

@@ -8,6 +8,14 @@ export declare class Workflows extends APIResource {
      * When invoked for a workflow using a specific workflow key and cancellation key,
      * will cancel any queued workflow runs associated with that key/cancellation key
      * pair. Can optionally be provided one or more recipients to scope the request to.
+     *
+     * @example
+     * ```ts
+     * const response = await client.workflows.cancel('key', {
+     *   cancellation_key: 'cancel-workflow-123',
+     *   recipients: ['jhammond'],
+     * });
+     * ```
      */
     cancel(key: string, body: WorkflowCancelParams, options?: RequestOptions): APIPromise<string>;
     /**
@@ -16,6 +24,28 @@ export declare class Workflows extends APIResource {
      * workflow runs are executed asynchronously. This endpoint also handles
      * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
      * for the `actor`, `recipient`, and `tenant` fields.
+     *
+     * @example
+     * ```ts
+     * const response = await client.workflows.trigger('key', {
+     *   recipients: ['dr_grant', 'dr_sattler', 'dr_malcolm'],
+     *   actor: 'mr_dna',
+     *   cancellation_key: 'isla_nublar_incident_1993',
+     *   data: {
+     *     affected_areas: [
+     *       'visitor_center',
+     *       'raptor_pen',
+     *       'trex_paddock',
+     *     ],
+     *     attraction_id: 'paddock_rex_01',
+     *     evacuation_protocol: 'active',
+     *     message: 'Life finds a way',
+     *     severity: 'critical',
+     *     system_status: 'fences_failing',
+     *   },
+     *   tenant: 'ingen_isla_nublar',
+     * });
+     * ```
      */
     trigger(key: string, body: WorkflowTriggerParams, options?: RequestOptions): APIPromise<WorkflowTriggerResponse>;
 }

package/resources/workflows.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"workflows.d.mts","sourceRoot":"","sources":["../src/resources/workflows.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI7F;;;;;;OAMG;IACH,OAAO,CACL,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAGvC;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;;OAMG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC;CAC7D;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAElD;;;;OAIG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAE9C;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
+{"version":3,"file":"workflows.d.mts","sourceRoot":"","sources":["../src/resources/workflows.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI7F;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,OAAO,CACL,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAGvC;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;;OAMG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC;CAC7D;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAElD;;;;OAIG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAE9C;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/workflows.d.ts

@@ -8,6 +8,14 @@ export declare class Workflows extends APIResource {
      * When invoked for a workflow using a specific workflow key and cancellation key,
      * will cancel any queued workflow runs associated with that key/cancellation key
      * pair. Can optionally be provided one or more recipients to scope the request to.
+     *
+     * @example
+     * ```ts
+     * const response = await client.workflows.cancel('key', {
+     *   cancellation_key: 'cancel-workflow-123',
+     *   recipients: ['jhammond'],
+     * });
+     * ```
      */
     cancel(key: string, body: WorkflowCancelParams, options?: RequestOptions): APIPromise<string>;
     /**
@@ -16,6 +24,28 @@ export declare class Workflows extends APIResource {
      * workflow runs are executed asynchronously. This endpoint also handles
      * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
      * for the `actor`, `recipient`, and `tenant` fields.
+     *
+     * @example
+     * ```ts
+     * const response = await client.workflows.trigger('key', {
+     *   recipients: ['dr_grant', 'dr_sattler', 'dr_malcolm'],
+     *   actor: 'mr_dna',
+     *   cancellation_key: 'isla_nublar_incident_1993',
+     *   data: {
+     *     affected_areas: [
+     *       'visitor_center',
+     *       'raptor_pen',
+     *       'trex_paddock',
+     *     ],
+     *     attraction_id: 'paddock_rex_01',
+     *     evacuation_protocol: 'active',
+     *     message: 'Life finds a way',
+     *     severity: 'critical',
+     *     system_status: 'fences_failing',
+     *   },
+     *   tenant: 'ingen_isla_nublar',
+     * });
+     * ```
      */
     trigger(key: string, body: WorkflowTriggerParams, options?: RequestOptions): APIPromise<WorkflowTriggerResponse>;
 }

package/resources/workflows.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"workflows.d.ts","sourceRoot":"","sources":["../src/resources/workflows.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI7F;;;;;;OAMG;IACH,OAAO,CACL,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAGvC;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;;OAMG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC;CAC7D;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAElD;;;;OAIG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAE9C;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
+{"version":3,"file":"workflows.d.ts","sourceRoot":"","sources":["../src/resources/workflows.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI7F;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,OAAO,CACL,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAGvC;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;;OAMG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC;CAC7D;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAElD;;;;OAIG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAE9C;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/workflows.js

@@ -9,6 +9,14 @@ class Workflows extends resource_1.APIResource {
      * When invoked for a workflow using a specific workflow key and cancellation key,
      * will cancel any queued workflow runs associated with that key/cancellation key
      * pair. Can optionally be provided one or more recipients to scope the request to.
+     *
+     * @example
+     * ```ts
+     * const response = await client.workflows.cancel('key', {
+     *   cancellation_key: 'cancel-workflow-123',
+     *   recipients: ['jhammond'],
+     * });
+     * ```
      */
     cancel(key, body, options) {
         return this._client.post((0, path_1.path) `/v1/workflows/${key}/cancel`, { body, ...options });
@@ -19,6 +27,28 @@ class Workflows extends resource_1.APIResource {
      * workflow runs are executed asynchronously. This endpoint also handles
      * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
      * for the `actor`, `recipient`, and `tenant` fields.
+     *
+     * @example
+     * ```ts
+     * const response = await client.workflows.trigger('key', {
+     *   recipients: ['dr_grant', 'dr_sattler', 'dr_malcolm'],
+     *   actor: 'mr_dna',
+     *   cancellation_key: 'isla_nublar_incident_1993',
+     *   data: {
+     *     affected_areas: [
+     *       'visitor_center',
+     *       'raptor_pen',
+     *       'trex_paddock',
+     *     ],
+     *     attraction_id: 'paddock_rex_01',
+     *     evacuation_protocol: 'active',
+     *     message: 'Life finds a way',
+     *     severity: 'critical',
+     *     system_status: 'fences_failing',
+     *   },
+     *   tenant: 'ingen_isla_nublar',
+     * });
+     * ```
      */
     trigger(key, body, options) {
         return this._client.post((0, path_1.path) `/v1/workflows/${key}/trigger`, { body, ...options });

package/resources/workflows.js.map

@@ -1 +1 @@
-{"version":3,"file":"workflows.js","sourceRoot":"","sources":["../src/resources/workflows.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAK/C,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;OAIG;IACH,MAAM,CAAC,GAAW,EAAE,IAA0B,EAAE,OAAwB;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,iBAAiB,GAAG,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CACL,GAAW,EACX,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,iBAAiB,GAAG,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF;AAxBD,8BAwBC"}
+{"version":3,"file":"workflows.js","sourceRoot":"","sources":["../src/resources/workflows.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAK/C,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,GAAW,EAAE,IAA0B,EAAE,OAAwB;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,iBAAiB,GAAG,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,OAAO,CACL,GAAW,EACX,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,iBAAiB,GAAG,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF;AAtDD,8BAsDC"}

package/resources/workflows.mjs

@@ -6,6 +6,14 @@ export class Workflows extends APIResource {
      * When invoked for a workflow using a specific workflow key and cancellation key,
      * will cancel any queued workflow runs associated with that key/cancellation key
      * pair. Can optionally be provided one or more recipients to scope the request to.
+     *
+     * @example
+     * ```ts
+     * const response = await client.workflows.cancel('key', {
+     *   cancellation_key: 'cancel-workflow-123',
+     *   recipients: ['jhammond'],
+     * });
+     * ```
      */
     cancel(key, body, options) {
         return this._client.post(path `/v1/workflows/${key}/cancel`, { body, ...options });
@@ -16,6 +24,28 @@ export class Workflows extends APIResource {
      * workflow runs are executed asynchronously. This endpoint also handles
      * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
      * for the `actor`, `recipient`, and `tenant` fields.
+     *
+     * @example
+     * ```ts
+     * const response = await client.workflows.trigger('key', {
+     *   recipients: ['dr_grant', 'dr_sattler', 'dr_malcolm'],
+     *   actor: 'mr_dna',
+     *   cancellation_key: 'isla_nublar_incident_1993',
+     *   data: {
+     *     affected_areas: [
+     *       'visitor_center',
+     *       'raptor_pen',
+     *       'trex_paddock',
+     *     ],
+     *     attraction_id: 'paddock_rex_01',
+     *     evacuation_protocol: 'active',
+     *     message: 'Life finds a way',
+     *     severity: 'critical',
+     *     system_status: 'fences_failing',
+     *   },
+     *   tenant: 'ingen_isla_nublar',
+     * });
+     * ```
      */
     trigger(key, body, options) {
         return this._client.post(path `/v1/workflows/${key}/trigger`, { body, ...options });

package/resources/workflows.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"workflows.mjs","sourceRoot":"","sources":["../src/resources/workflows.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAKf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;OAIG;IACH,MAAM,CAAC,GAAW,EAAE,IAA0B,EAAE,OAAwB;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,iBAAiB,GAAG,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CACL,GAAW,EACX,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,iBAAiB,GAAG,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF"}
+{"version":3,"file":"workflows.mjs","sourceRoot":"","sources":["../src/resources/workflows.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAKf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,GAAW,EAAE,IAA0B,EAAE,OAAwB;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,iBAAiB,GAAG,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,OAAO,CACL,GAAW,EACX,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,iBAAiB,GAAG,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF"}

package/resources.js

@@ -1,18 +1,5 @@
 "use strict";
-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("./resources/index.js"), exports);
+const tslib_1 = require("./internal/tslib.js");
+tslib_1.__exportStar(require("./resources/index.js"), exports);
 //# sourceMappingURL=resources.js.map

package/resources.js.map

@@ -1 +1 @@
-{"version":3,"file":"resources.js","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAkC"}
+{"version":3,"file":"resources.js","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":";;;AAAA,+DAAkC"}

package/src/client.ts

@@ -283,6 +283,23 @@ export class Knock {
     this.apiKey = apiKey;
   }
 
+  /**
+   * Create a new client instance re-using the same options given to the current client with optional overriding.
+   */
+  withOptions(options: Partial<ClientOptions>): this {
+    return new (this.constructor as any as new (props: ClientOptions) => typeof this)({
+      ...this._options,
+      baseURL: this.baseURL,
+      maxRetries: this.maxRetries,
+      timeout: this.timeout,
+      logger: this.logger,
+      logLevel: this.logLevel,
+      fetchOptions: this.fetchOptions,
+      apiKey: this.apiKey,
+      ...options,
+    });
+  }
+
   protected defaultQuery(): Record<string, string | undefined> | undefined {
     return this._options.defaultQuery;
   }

package/src/internal/headers.ts

@@ -71,8 +71,8 @@ function* iterateHeaders(headers: HeadersLike): IterableIterator<readonly [strin
 export const buildHeaders = (newHeaders: HeadersLike[]): NullableHeaders => {
   const targetHeaders = new Headers();
   const nullHeaders = new Set<string>();
-  const seenHeaders = new Set<string>();
   for (const headers of newHeaders) {
+    const seenHeaders = new Set<string>();
     for (const [name, value] of iterateHeaders(headers)) {
       const lowerName = name.toLowerCase();
       if (!seenHeaders.has(lowerName)) {

package/src/internal/to-file.ts

@@ -1,6 +1,6 @@
-import { type File, getFile } from './shims/file';
 import { BlobPart, getName, makeFile, isAsyncIterable } from './uploads';
 import type { FilePropertyBag } from './builtin-types';
+import { checkFileSupport } from './uploads';
 
 type BlobLikePart = string | ArrayBuffer | ArrayBufferView | BlobLike | DataView;
 
@@ -85,12 +85,14 @@ export async function toFile(
   name?: string | null | undefined,
   options?: FilePropertyBag | undefined,
 ): Promise<File> {
+  checkFileSupport();
+
   // If it's a promise, resolve it.
   value = await value;
 
   // If we've been given a `File` we don't need to do anything
   if (isFileLike(value)) {
-    if (value instanceof getFile()) {
+    if (value instanceof File) {
       return value;
     }
     return makeFile([await value.arrayBuffer()], value.name);

package/src/internal/uploads.ts

@@ -1,7 +1,6 @@
 import { type RequestOptions } from './request-options';
 import type { FilePropertyBag, Fetch } from './builtin-types';
 import type { Knock } from '../client';
-import { type File, getFile } from './shims/file';
 import { ReadableStreamFrom } from './shims';
 
 export type BlobPart = string | ArrayBuffer | ArrayBufferView | Blob | DataView;
@@ -12,6 +11,20 @@ interface BunFile extends Blob {
   readonly name?: string | undefined;
 }
 
+export const checkFileSupport = () => {
+  if (typeof File === 'undefined') {
+    const { process } = globalThis as any;
+    const isOldNode =
+      typeof process?.versions?.node === 'string' && parseInt(process.versions.node.split('.')) < 20;
+    throw new Error(
+      '`File` is not defined as a global, which is required for file uploads.' +
+        (isOldNode ?
+          " Update to Node 20 LTS or newer, or set `globalThis.File` to `import('node:buffer').File`."
+        : ''),
+    );
+  }
+};
+
 /**
  * Typically, this is a native "File" class.
  *
@@ -32,7 +45,7 @@ export function makeFile(
   fileName: string | undefined,
   options?: FilePropertyBag,
 ): File {
-  const File = getFile();
+  checkFileSupport();
   return new File(fileBits as any, fileName ?? 'unknown_file', options);
 }
 
@@ -125,8 +138,7 @@ export const createForm = async <T = Record<string, unknown>>(
 
 // We check for Blob not File because Bun.File doesn't inherit from File,
 // but they both inherit from Blob and have a `name` property at runtime.
-const isNamedBlob = (value: object) =>
-  value instanceof getFile() || (value instanceof Blob && 'name' in value);
+const isNamedBlob = (value: object) => value instanceof Blob && 'name' in value;
 
 const isUploadable = (value: unknown) =>
   typeof value === 'object' &&

package/src/internal/utils/uuid.ts

@@ -1,12 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { getCrypto } from '../shims/crypto';
-
 /**
  * https://stackoverflow.com/a/2117523
  */
 export let uuid4 = function () {
-  const crypto = getCrypto();
+  const { crypto } = globalThis as any;
   if (crypto?.randomUUID) {
     uuid4 = crypto.randomUUID.bind(crypto);
     return crypto.randomUUID();