@knocklabs/node 1.10.2 → 1.11.0

package/src/client.ts

@@ -167,6 +167,8 @@ export interface ClientOptions {
    *
    * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
    * much longer than this timeout before the promise succeeds or fails.
+   *
+   * @unit milliseconds
    */
   timeout?: number | undefined;
   /**
@@ -292,17 +294,19 @@ export class Knock {
    * 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)({
+    const client = 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,
+      fetch: this.fetch,
       fetchOptions: this.fetchOptions,
       apiKey: this.apiKey,
       ...options,
     });
+    return client;
   }
 
   /**
@@ -320,7 +324,7 @@ export class Knock {
     return;
   }
 
-  protected authHeaders(opts: FinalRequestOptions): NullableHeaders | undefined {
+  protected async authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
     return buildHeaders([{ Authorization: `Bearer ${this.apiKey}` }]);
   }
 
@@ -436,7 +440,9 @@ export class Knock {
 
     await this.prepareOptions(options);
 
-    const { req, url, timeout } = this.buildRequest(options, { retryCount: maxRetries - retriesRemaining });
+    const { req, url, timeout } = await this.buildRequest(options, {
+      retryCount: maxRetries - retriesRemaining,
+    });
 
     await this.prepareRequest(req, { url, options });
 
@@ -514,7 +520,7 @@ export class Knock {
     } with status ${response.status} in ${headersTime - startTime}ms`;
 
     if (!response.ok) {
-      const shouldRetry = this.shouldRetry(response);
+      const shouldRetry = await this.shouldRetry(response);
       if (retriesRemaining && shouldRetry) {
         const retryMessage = `retrying, ${retriesRemaining} attempts remaining`;
 
@@ -632,7 +638,7 @@ export class Knock {
     }
   }
 
-  private shouldRetry(response: Response): boolean {
+  private async shouldRetry(response: Response): Promise<boolean> {
     // Note this is not a standard header.
     const shouldRetryHeader = response.headers.get('x-should-retry');
 
@@ -709,10 +715,10 @@ export class Knock {
     return sleepSeconds * jitter * 1000;
   }
 
-  buildRequest(
+  async buildRequest(
     inputOptions: FinalRequestOptions,
     { retryCount = 0 }: { retryCount?: number } = {},
-  ): { req: FinalizedRequestInit; url: string; timeout: number } {
+  ): Promise<{ req: FinalizedRequestInit; url: string; timeout: number }> {
     const options = { ...inputOptions };
     const { method, path, query, defaultBaseURL } = options;
 
@@ -720,7 +726,7 @@ export class Knock {
     if ('timeout' in options) validatePositiveInteger('timeout', options.timeout);
     options.timeout = options.timeout ?? this.timeout;
     const { bodyHeaders, body } = this.buildBody({ options });
-    const reqHeaders = this.buildHeaders({ options: inputOptions, method, bodyHeaders, retryCount });
+    const reqHeaders = await this.buildHeaders({ options: inputOptions, method, bodyHeaders, retryCount });
 
     const req: FinalizedRequestInit = {
       method,
@@ -736,7 +742,7 @@ export class Knock {
     return { req, url, timeout: options.timeout };
   }
 
-  private buildHeaders({
+  private async buildHeaders({
     options,
     method,
     bodyHeaders,
@@ -746,7 +752,7 @@ export class Knock {
     method: HTTPMethod;
     bodyHeaders: HeadersLike;
     retryCount: number;
-  }): Headers {
+  }): Promise<Headers> {
     let idempotencyHeaders: HeadersLike = {};
     if (this.idempotencyHeader && method !== 'get') {
       if (!options.idempotencyKey) options.idempotencyKey = this.defaultIdempotencyKey();
@@ -762,7 +768,7 @@ export class Knock {
         ...(options.timeout ? { 'X-Stainless-Timeout': String(Math.trunc(options.timeout / 1000)) } : {}),
         ...getPlatformHeaders(),
       },
-      this.authHeaders(options),
+      await this.authHeaders(options),
       this._options.defaultHeaders,
       bodyHeaders,
       options.headers,

package/src/internal/request-options.ts

@@ -9,17 +9,70 @@ import { type HeadersLike } from './headers';
 export type FinalRequestOptions = RequestOptions & { method: HTTPMethod; path: string };
 
 export type RequestOptions = {
+  /**
+   * The HTTP method for the request (e.g., 'get', 'post', 'put', 'delete').
+   */
   method?: HTTPMethod;
+
+  /**
+   * The URL path for the request.
+   *
+   * @example "/v1/foo"
+   */
   path?: string;
+
+  /**
+   * Query parameters to include in the request URL.
+   */
   query?: object | undefined | null;
+
+  /**
+   * The request body. Can be a string, JSON object, FormData, or other supported types.
+   */
   body?: unknown;
+
+  /**
+   * HTTP headers to include with the request. Can be a Headers object, plain object, or array of tuples.
+   */
   headers?: HeadersLike;
+
+  /**
+   * The maximum number of times that the client will retry a request in case of a
+   * temporary failure, like a network error or a 5XX error from the server.
+   *
+   * @default 2
+   */
   maxRetries?: number;
+
   stream?: boolean | undefined;
+
+  /**
+   * The maximum amount of time (in milliseconds) that the client should wait for a response
+   * from the server before timing out a single request.
+   *
+   * @unit milliseconds
+   */
   timeout?: number;
+
+  /**
+   * Additional `RequestInit` options to be passed to the underlying `fetch` call.
+   * These options will be merged with the client's default fetch options.
+   */
   fetchOptions?: MergedRequestInit;
+
+  /**
+   * An AbortSignal that can be used to cancel the request.
+   */
   signal?: AbortSignal | undefined | null;
+
+  /**
+   * A unique key for this request to enable idempotency.
+   */
   idempotencyKey?: string;
+
+  /**
+   * Override the default base URL for this specific request.
+   */
   defaultBaseURL?: string | undefined;
 
   __binaryResponse?: boolean | undefined;

package/src/internal/types.ts

@@ -7,7 +7,7 @@ export type KeysEnum<T> = { [P in keyof Required<T>]: true };
 
 export type FinalizedRequestInit = RequestInit & { headers: Headers };
 
-type NotAny<T> = [unknown] extends [T] ? never : T;
+type NotAny<T> = [0] extends [1 & T] ? never : T;
 
 /**
  * Some environments overload the global fetch function, and Parameters<T> only gets the last signature.
@@ -64,13 +64,15 @@ type OverloadedParameters<T> =
  * [1]: https://www.typescriptlang.org/tsconfig/#typeAcquisition
  */
 /** @ts-ignore For users with \@types/node */
-type UndiciTypesRequestInit = NotAny<import('../node_modules/undici-types').RequestInit> | NotAny<import('../../node_modules/undici-types').RequestInit> | NotAny<import('../../../node_modules/undici-types').RequestInit> | NotAny<import('../../../../node_modules/undici-types').RequestInit> | NotAny<import('../../../../../node_modules/undici-types').RequestInit> | NotAny<import('../../../../../../node_modules/undici-types').RequestInit> | NotAny<import('../../../../../../../node_modules/undici-types').RequestInit> | NotAny<import('../../../../../../../../node_modules/undici-types').RequestInit> | NotAny<import('../../../../../../../../../node_modules/undici-types').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/undici-types').RequestInit>;
+type UndiciTypesRequestInit = NotAny<import('../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit>;
 /** @ts-ignore For users with undici */
-type UndiciRequestInit = NotAny<import('../node_modules/undici').RequestInit> | NotAny<import('../../node_modules/undici').RequestInit> | NotAny<import('../../../node_modules/undici').RequestInit> | NotAny<import('../../../../node_modules/undici').RequestInit> | NotAny<import('../../../../../node_modules/undici').RequestInit> | NotAny<import('../../../../../../node_modules/undici').RequestInit> | NotAny<import('../../../../../../../node_modules/undici').RequestInit> | NotAny<import('../../../../../../../../node_modules/undici').RequestInit> | NotAny<import('../../../../../../../../../node_modules/undici').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/undici').RequestInit>;
+type UndiciRequestInit = NotAny<import('../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/undici/index.d.ts').RequestInit>;
 /** @ts-ignore For users with \@types/bun */
 type BunRequestInit = globalThis.FetchRequestInit;
-/** @ts-ignore For users with node-fetch */
-type NodeFetchRequestInit = NotAny<import('../node_modules/node-fetch').RequestInit> | NotAny<import('../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/node-fetch').RequestInit>;
+/** @ts-ignore For users with node-fetch@2 */
+type NodeFetch2RequestInit = NotAny<import('../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit>;
+/** @ts-ignore For users with node-fetch@3, doesn't need file extension because types are at ./@types/index.d.ts */
+type NodeFetch3RequestInit =  NotAny<import('../node_modules/node-fetch').RequestInit> | NotAny<import('../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/node-fetch').RequestInit>;
 /** @ts-ignore For users who use Deno */
 type FetchRequestInit = NonNullable<OverloadedParameters<typeof fetch>[1]>;
 /* eslint-enable */
@@ -79,7 +81,8 @@ type RequestInits =
   | NotAny<UndiciTypesRequestInit>
   | NotAny<UndiciRequestInit>
   | NotAny<BunRequestInit>
-  | NotAny<NodeFetchRequestInit>
+  | NotAny<NodeFetch2RequestInit>
+  | NotAny<NodeFetch3RequestInit>
   | NotAny<RequestInit>
   | NotAny<FetchRequestInit>;
 

package/src/internal/uploads.ts

@@ -90,7 +90,7 @@ export const multipartFormRequestOptions = async (
   return { ...opts, body: await createForm(opts.body, fetch) };
 };
 
-const supportsFormDataMap = /** @__PURE__ */ new WeakMap<Fetch, Promise<boolean>>();
+const supportsFormDataMap = /* @__PURE__ */ new WeakMap<Fetch, Promise<boolean>>();
 
 /**
  * node-fetch doesn't support the global FormData object in recent node versions. Instead of sending

package/src/internal/utils/log.ts

@@ -58,7 +58,7 @@ const noopLogger = {
   debug: noop,
 };
 
-let cachedLoggers = /** @__PURE__ */ new WeakMap<Logger, [LogLevel, Logger]>();
+let cachedLoggers = /* @__PURE__ */ new WeakMap<Logger, [LogLevel, Logger]>();
 
 export function loggerFor(client: Knock): Logger {
   const logger = client.logger;

package/src/internal/utils/path.ts

@@ -12,25 +12,43 @@ export function encodeURIPath(str: string) {
   return str.replace(/[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/g, encodeURIComponent);
 }
 
+const EMPTY = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.create(null));
+
 export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
   function path(statics: readonly string[], ...params: readonly unknown[]): string {
     // If there are no params, no processing is needed.
     if (statics.length === 1) return statics[0]!;
 
     let postPath = false;
+    const invalidSegments = [];
     const path = statics.reduce((previousValue, currentValue, index) => {
       if (/[?#]/.test(currentValue)) {
         postPath = true;
       }
-      return (
-        previousValue +
-        currentValue +
-        (index === params.length ? '' : (postPath ? encodeURIComponent : pathEncoder)(String(params[index])))
-      );
+      const value = params[index];
+      let encoded = (postPath ? encodeURIComponent : pathEncoder)('' + value);
+      if (
+        index !== params.length &&
+        (value == null ||
+          (typeof value === 'object' &&
+            // handle values from other realms
+            value.toString ===
+              Object.getPrototypeOf(Object.getPrototypeOf((value as any).hasOwnProperty ?? EMPTY) ?? EMPTY)
+                ?.toString))
+      ) {
+        encoded = value + '';
+        invalidSegments.push({
+          start: previousValue.length + currentValue.length,
+          length: encoded.length,
+          error: `Value of type ${Object.prototype.toString
+            .call(value)
+            .slice(8, -1)} is not a valid path parameter`,
+        });
+      }
+      return previousValue + currentValue + (index === params.length ? '' : encoded);
     }, '');
 
     const pathOnly = path.split(/[?#]/, 1)[0]!;
-    const invalidSegments = [];
     const invalidSegmentPattern = /(?<=^|\/)(?:\.|%2e){1,2}(?=\/|$)/gi;
     let match;
 
@@ -39,9 +57,12 @@ export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
       invalidSegments.push({
         start: match.index,
         length: match[0].length,
+        error: `Value "${match[0]}" can\'t be safely passed as a path parameter`,
       });
     }
 
+    invalidSegments.sort((a, b) => a.start - b.start);
+
     if (invalidSegments.length > 0) {
       let lastEnd = 0;
       const underline = invalidSegments.reduce((acc, segment) => {
@@ -51,7 +72,11 @@ export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
         return acc + spaces + arrows;
       }, '');
 
-      throw new KnockError(`Path parameters result in path with invalid segments:\n${path}\n${underline}`);
+      throw new KnockError(
+        `Path parameters result in path with invalid segments:\n${invalidSegments
+          .map((e) => e.error)
+          .join('\n')}\n${path}\n${underline}`,
+      );
     }
 
     return path;

package/src/resources/audiences.ts

@@ -81,7 +81,7 @@ export interface AudienceMember {
   user: UsersAPI.User;
 
   /**
-   * The ID for the user that you set when identifying them in Knock.
+   * The unique identifier of the user.
    */
   user_id: string;
 
@@ -145,7 +145,7 @@ export namespace AudienceAddMembersParams {
      */
     export interface User {
       /**
-       * The ID for the user that you set when identifying them in Knock.
+       * The unique identifier of the user.
        */
       id?: string;
     }
@@ -181,7 +181,7 @@ export namespace AudienceRemoveMembersParams {
      */
     export interface User {
       /**
-       * The ID for the user that you set when identifying them in Knock.
+       * The unique identifier of the user.
        */
       id?: string;
     }

package/src/resources/integrations/census.ts

@@ -25,7 +25,7 @@ export interface CensusCustomDestinationResponse {
   /**
    * The result of the RPC call.
    */
-  result?: Record<string, unknown>;
+  result?: { [key: string]: unknown };
 }
 
 export interface CensusCustomDestinationParams {
@@ -47,7 +47,7 @@ export interface CensusCustomDestinationParams {
   /**
    * The parameters for the method.
    */
-  params?: Record<string, unknown>;
+  params?: { [key: string]: unknown };
 }
 
 export declare namespace Census {

package/src/resources/integrations/hightouch.ts

@@ -25,7 +25,7 @@ export interface HightouchEmbeddedDestinationResponse {
   /**
    * The result of the RPC call.
    */
-  result?: Record<string, unknown>;
+  result?: { [key: string]: unknown };
 }
 
 export interface HightouchEmbeddedDestinationParams {
@@ -47,7 +47,7 @@ export interface HightouchEmbeddedDestinationParams {
   /**
    * The parameters for the method.
    */
-  params?: Record<string, unknown>;
+  params?: { [key: string]: unknown };
 }
 
 export declare namespace Hightouch {

package/src/resources/messages/batch.ts

@@ -275,7 +275,7 @@ export namespace BatchGetContentResponse {
     }
 
     /**
-     * The content of a push notification.
+     * Push channel data.
      */
     export interface MessagePushContent {
       /**
@@ -301,7 +301,7 @@ export namespace BatchGetContentResponse {
       /**
        * Additional data payload for the push notification.
        */
-      data?: Record<string, unknown> | null;
+      data?: { [key: string]: unknown } | null;
     }
 
     /**
@@ -316,7 +316,7 @@ export namespace BatchGetContentResponse {
       /**
        * The channel data connection from the recipient to the underlying provider.
        */
-      connection: Record<string, unknown>;
+      connection: { [key: string]: unknown };
 
       /**
        * The template structure for the chat message.
@@ -326,7 +326,7 @@ export namespace BatchGetContentResponse {
       /**
        * Additional metadata associated with the chat message.
        */
-      metadata?: Record<string, unknown> | null;
+      metadata?: { [key: string]: unknown } | null;
     }
 
     export namespace MessageChatContent {
@@ -342,7 +342,7 @@ export namespace BatchGetContentResponse {
         /**
          * The JSON content of the message.
          */
-        json_content?: Record<string, unknown> | null;
+        json_content?: { [key: string]: unknown } | null;
 
         /**
          * The summary of the chat message.
@@ -515,7 +515,7 @@ export interface BatchMarkAsInteractedParams {
   /**
    * Metadata about the interaction.
    */
-  metadata?: Record<string, unknown> | null;
+  metadata?: { [key: string]: unknown } | null;
 }
 
 export interface BatchMarkAsReadParams {

package/src/resources/messages/messages.ts

@@ -300,7 +300,7 @@ export interface Activity {
   /**
    * The workflow trigger `data` payload associated with the activity.
    */
-  data?: Record<string, unknown> | null;
+  data?: { [key: string]: unknown } | null;
 
   /**
    * Timestamp when the activity was created.
@@ -362,7 +362,7 @@ export interface Message {
    * after a [batch step](/designing-workflows/batch-function), includes the payload
    * `data` from the most-recent trigger request (the final `activity` in the batch).
    */
-  data?: Record<string, unknown> | null;
+  data?: { [key: string]: unknown } | null;
 
   /**
    * A list of engagement statuses.
@@ -387,7 +387,7 @@ export interface Message {
   /**
    * The metadata associated with the message.
    */
-  metadata?: Record<string, unknown> | null;
+  metadata?: { [key: string]: unknown } | null;
 
   /**
    * Timestamp when the message was read.
@@ -458,6 +458,11 @@ export namespace Message {
      * The ID of the version of the workflow that triggered the message.
      */
     version_id: string;
+
+    /**
+     * The step reference for the step in the workflow that generated the message
+     */
+    step_ref?: string | null;
   }
 }
 
@@ -510,12 +515,12 @@ export namespace MessageDeliveryLog {
     /**
      * The body content that was sent with the request.
      */
-    body?: string | Record<string, unknown>;
+    body?: string | { [key: string]: unknown };
 
     /**
      * The headers that were sent with the request.
      */
-    headers?: Record<string, unknown> | null;
+    headers?: { [key: string]: unknown } | null;
 
     /**
      * The host to which the request was sent.
@@ -545,12 +550,12 @@ export namespace MessageDeliveryLog {
     /**
      * The body content that was received with the response.
      */
-    body?: string | Record<string, unknown>;
+    body?: string | { [key: string]: unknown };
 
     /**
      * The headers that were received with the response.
      */
-    headers?: Record<string, unknown> | null;
+    headers?: { [key: string]: unknown } | null;
 
     /**
      * The HTTP status code of the response.
@@ -608,7 +613,7 @@ export interface MessageEvent {
   /**
    * The data associated with the message event. Only present for some event types.
    */
-  data?: Record<string, unknown> | null;
+  data?: { [key: string]: unknown } | null;
 }
 
 /**
@@ -713,7 +718,7 @@ export namespace MessageGetContentResponse {
   }
 
   /**
-   * The content of a push notification.
+   * Push channel data.
    */
   export interface MessagePushContent {
     /**
@@ -739,7 +744,7 @@ export namespace MessageGetContentResponse {
     /**
      * Additional data payload for the push notification.
      */
-    data?: Record<string, unknown> | null;
+    data?: { [key: string]: unknown } | null;
   }
 
   /**
@@ -754,7 +759,7 @@ export namespace MessageGetContentResponse {
     /**
      * The channel data connection from the recipient to the underlying provider.
      */
-    connection: Record<string, unknown>;
+    connection: { [key: string]: unknown };
 
     /**
      * The template structure for the chat message.
@@ -764,7 +769,7 @@ export namespace MessageGetContentResponse {
     /**
      * Additional metadata associated with the chat message.
      */
-    metadata?: Record<string, unknown> | null;
+    metadata?: { [key: string]: unknown } | null;
   }
 
   export namespace MessageChatContent {
@@ -780,7 +785,7 @@ export namespace MessageGetContentResponse {
       /**
        * The JSON content of the message.
        */
-      json_content?: Record<string, unknown> | null;
+      json_content?: { [key: string]: unknown } | null;
 
       /**
        * The summary of the chat message.
@@ -1000,7 +1005,7 @@ export interface MessageMarkAsInteractedParams {
   /**
    * Metadata about the interaction.
    */
-  metadata?: Record<string, unknown>;
+  metadata?: { [key: string]: unknown };
 }
 
 Messages.Batch = Batch;

package/src/resources/objects/bulk.ts

@@ -121,7 +121,7 @@ export namespace BulkAddSubscriptionsParams {
     /**
      * The custom properties associated with the subscription relationship.
      */
-    properties?: Record<string, unknown> | null;
+    properties?: { [key: string]: unknown } | null;
   }
 }
 

package/src/resources/objects/objects.ts

@@ -479,7 +479,7 @@ export interface Object {
   /**
    * The custom properties associated with the object.
    */
-  properties?: Record<string, unknown>;
+  properties?: { [key: string]: unknown };
 }
 
 /**
@@ -524,7 +524,7 @@ export interface ObjectAddSubscriptionsParams {
   /**
    * The custom properties associated with the subscription relationship.
    */
-  properties?: Record<string, unknown> | null;
+  properties?: { [key: string]: unknown } | null;
 }
 
 export interface ObjectDeleteSubscriptionsParams {
@@ -721,10 +721,9 @@ export interface ObjectSetPreferencesParams {
    * An object where the key is the category and the values are the preference
    * settings for that category.
    */
-  categories?: Record<
-    string,
-    boolean | ObjectSetPreferencesParams.PreferenceSetWorkflowCategorySettingObject
-  > | null;
+  categories?: {
+    [key: string]: boolean | ObjectSetPreferencesParams.PreferenceSetWorkflowCategorySettingObject;
+  } | null;
 
   /**
    * Channel type preferences.
@@ -735,10 +734,9 @@ export interface ObjectSetPreferencesParams {
    * An object where the key is the workflow key and the values are the preference
    * settings for that workflow.
    */
-  workflows?: Record<
-    string,
-    boolean | ObjectSetPreferencesParams.PreferenceSetWorkflowCategorySettingObject
-  > | null;
+  workflows?: {
+    [key: string]: boolean | ObjectSetPreferencesParams.PreferenceSetWorkflowCategorySettingObject;
+  } | null;
 }
 
 export namespace ObjectSetPreferencesParams {

package/src/resources/providers/slack.ts

@@ -189,7 +189,8 @@ export namespace SlackListChannelsParams {
     /**
      * Mix and match channel types by providing a comma-separated list of any
      * combination of public_channel, private_channel, mpim, im. Defaults to
-     * `"public_channel,private_channel"`.
+     * `"public_channel,private_channel"`. If the user's Slack ID is unavailable, this
+     * option is ignored and only public channels are returned.
      */
     types?: string;
   }