@knocklabs/node 1.0.0 → 1.2.0

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();

package/src/resources/audiences.ts

@@ -10,6 +10,18 @@ import { path } from '../internal/utils/path';
 export class Audiences extends APIResource {
   /**
    * Adds one or more members to the specified audience.
+   *
+   * @example
+   * ```ts
+   * const response = await client.audiences.addMembers('key', {
+   *   members: [
+   *     {
+   *       tenant: 'ingen_isla_nublar',
+   *       user: { id: 'dr_sattler' },
+   *     },
+   *   ],
+   * });
+   * ```
    */
   addMembers(key: string, body: AudienceAddMembersParams, options?: RequestOptions): APIPromise<string> {
     return this._client.post(path`/v1/audiences/${key}/members`, { body, ...options });
@@ -17,6 +29,11 @@ export class Audiences extends APIResource {
 
   /**
    * Returns a paginated list of members for the specified audience.
+   *
+   * @example
+   * ```ts
+   * const response = await client.audiences.listMembers('key');
+   * ```
    */
   listMembers(key: string, options?: RequestOptions): APIPromise<AudienceListMembersResponse> {
     return this._client.get(path`/v1/audiences/${key}/members`, options);
@@ -24,6 +41,14 @@ export class Audiences extends APIResource {
 
   /**
    * Removes one or more members from the specified audience.
+   *
+   * @example
+   * ```ts
+   * const response = await client.audiences.removeMembers(
+   *   'key',
+   *   { members: [{ user: {} }] },
+   * );
+   * ```
    */
   removeMembers(
     key: string,
@@ -103,6 +128,9 @@ export namespace AudienceAddMembersParams {
    * An audience member.
    */
   export interface Member {
+    /**
+     * An object containing the user's ID.
+     */
     user: Member.User;
 
     /**
@@ -112,6 +140,9 @@ export namespace AudienceAddMembersParams {
   }
 
   export namespace Member {
+    /**
+     * An object containing the user's ID.
+     */
     export interface User {
       /**
        * The ID for the user that you set when identifying them in Knock.
@@ -133,6 +164,9 @@ export namespace AudienceRemoveMembersParams {
    * An audience member.
    */
   export interface Member {
+    /**
+     * An object containing the user's ID.
+     */
     user: Member.User;
 
     /**
@@ -142,6 +176,9 @@ export namespace AudienceRemoveMembersParams {
   }
 
   export namespace Member {
+    /**
+     * An object containing the user's ID.
+     */
     export interface User {
       /**
        * The ID for the user that you set when identifying them in Knock.

package/src/resources/bulk-operations.ts

@@ -8,6 +8,13 @@ import { path } from '../internal/utils/path';
 export class BulkOperations extends APIResource {
   /**
    * Retrieves a bulk operation (if it exists) and displays the current state of it.
+   *
+   * @example
+   * ```ts
+   * const bulkOperation = await client.bulkOperations.get(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   get(id: string, options?: RequestOptions): APIPromise<BulkOperation> {
     return this._client.get(path`/v1/bulk_operations/${id}`, options);

package/src/resources/channels/bulk.ts

@@ -12,6 +12,27 @@ export class Bulk extends APIResource {
    * specified by the `channel_id` parameter. The action to perform is specified by
    * the `action` parameter, where the action is a status change action (e.g.
    * `archive`, `unarchive`).
+   *
+   * @example
+   * ```ts
+   * const bulkOperation =
+   *   await client.channels.bulk.updateMessageStatus(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     'seen',
+   *     {
+   *       archived: 'include',
+   *       delivery_status: 'delivered',
+   *       engagement_status: 'seen',
+   *       has_tenant: true,
+   *       newer_than: '2024-01-01T00:00:00Z',
+   *       older_than: '2024-01-01T00:00:00Z',
+   *       recipient_ids: ['recipient1', 'recipient2'],
+   *       tenants: ['tenant1', 'tenant2'],
+   *       trigger_data: '{"key":"value"}',
+   *       workflows: ['workflow1', 'workflow2'],
+   *     },
+   *   );
+   * ```
    */
   updateMessageStatus(
     channelID: string,

package/src/resources/messages/batch.ts

@@ -9,6 +9,16 @@ export class Batch extends APIResource {
   /**
    * Marks the given messages as archived. Archived messages are hidden from the
    * default message list in the feed but can still be accessed and unarchived later.
+   *
+   * @example
+   * ```ts
+   * const messages = await client.messages.batch.archive({
+   *   message_ids: [
+   *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+   *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+   *   ],
+   * });
+   * ```
    */
   archive(body: BatchArchiveParams, options?: RequestOptions): APIPromise<BatchArchiveResponse> {
     return this._client.post('/v1/messages/batch/archived', { body, ...options });
@@ -16,6 +26,13 @@ export class Batch extends APIResource {
 
   /**
    * Get the contents of multiple messages in a single request.
+   *
+   * @example
+   * ```ts
+   * const response = await client.messages.batch.getContent({
+   *   message_ids: ['string'],
+   * });
+   * ```
    */
   getContent(query: BatchGetContentParams, options?: RequestOptions): APIPromise<BatchGetContentResponse> {
     return this._client.get('/v1/messages/batch/content', { query, ...options });
@@ -27,6 +44,15 @@ export class Batch extends APIResource {
    * interaction. Cannot include more than 5 key-value pairs, must not contain nested
    * data. Read more about message engagement statuses
    * [here](/send-notifications/message-statuses#engagement-status).
+   *
+   * @example
+   * ```ts
+   * const messages =
+   *   await client.messages.batch.markAsInteracted({
+   *     message_ids: ['1jNaXzB2RZX3LY8wVQnfCKyPnv7'],
+   *     metadata: { key: 'value' },
+   *   });
+   * ```
    */
   markAsInteracted(
     body: BatchMarkAsInteractedParams,
@@ -38,6 +64,16 @@ export class Batch extends APIResource {
   /**
    * Marks the given messages as `read`. Read more about message engagement statuses
    * [here](/send-notifications/message-statuses#engagement-status).
+   *
+   * @example
+   * ```ts
+   * const messages = await client.messages.batch.markAsRead({
+   *   message_ids: [
+   *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+   *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+   *   ],
+   * });
+   * ```
    */
   markAsRead(body: BatchMarkAsReadParams, options?: RequestOptions): APIPromise<BatchMarkAsReadResponse> {
     return this._client.post('/v1/messages/batch/read', { body, ...options });
@@ -47,6 +83,16 @@ export class Batch extends APIResource {
    * Marks the given messages as `seen`. This indicates that the user has viewed the
    * message in their feed or inbox. Read more about message engagement statuses
    * [here](/send-notifications/message-statuses#engagement-status).
+   *
+   * @example
+   * ```ts
+   * const messages = await client.messages.batch.markAsSeen({
+   *   message_ids: [
+   *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+   *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+   *   ],
+   * });
+   * ```
    */
   markAsSeen(body: BatchMarkAsSeenParams, options?: RequestOptions): APIPromise<BatchMarkAsSeenResponse> {
     return this._client.post('/v1/messages/batch/seen', { body, ...options });
@@ -56,6 +102,16 @@ export class Batch extends APIResource {
    * Marks the given messages as `unread`. This reverses the `read` state. Read more
    * about message engagement statuses
    * [here](/send-notifications/message-statuses#engagement-status).
+   *
+   * @example
+   * ```ts
+   * const messages = await client.messages.batch.markAsUnread({
+   *   message_ids: [
+   *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+   *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+   *   ],
+   * });
+   * ```
    */
   markAsUnread(
     body: BatchMarkAsUnreadParams,
@@ -68,6 +124,16 @@ export class Batch extends APIResource {
    * Marks the given messages as `unseen`. This reverses the `seen` state. Read more
    * about message engagement statuses
    * [here](/send-notifications/message-statuses#engagement-status).
+   *
+   * @example
+   * ```ts
+   * const messages = await client.messages.batch.markAsUnseen({
+   *   message_ids: [
+   *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+   *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+   *   ],
+   * });
+   * ```
    */
   markAsUnseen(
     body: BatchMarkAsUnseenParams,
@@ -80,6 +146,16 @@ export class Batch extends APIResource {
    * Marks the given messages as unarchived. This reverses the `archived` state.
    * Archived messages are hidden from the default message list in the feed but can
    * still be accessed and unarchived later.
+   *
+   * @example
+   * ```ts
+   * const messages = await client.messages.batch.unarchive({
+   *   message_ids: [
+   *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+   *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+   *   ],
+   * });
+   * ```
    */
   unarchive(body: BatchUnarchiveParams, options?: RequestOptions): APIPromise<BatchUnarchiveResponse> {
     return this._client.post('/v1/messages/batch/unarchived', { body, ...options });

package/src/resources/messages/index.ts

@@ -1,6 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Activities, type ActivityListParams } from './activities';
 export {
   Batch,
   type BatchArchiveResponse,