featurebase-node 0.0.2

package/src/client.ts

@@ -0,0 +1,1169 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import type { RequestInit, RequestInfo, BodyInit } from './internal/builtin-types';
+import type { HTTPMethod, PromiseOrValue, MergedRequestInit, FinalizedRequestInit } from './internal/types';
+import { uuid4 } from './internal/utils/uuid';
+import { validatePositiveInteger, isAbsoluteURL, safeJSON } from './internal/utils/values';
+import { sleep } from './internal/utils/sleep';
+export type { Logger, LogLevel } from './internal/utils/log';
+import { castToError, isAbortError } from './internal/errors';
+import type { APIResponseProps } from './internal/parse';
+import { getPlatformHeaders } from './internal/detect-platform';
+import * as Shims from './internal/shims';
+import * as Opts from './internal/request-options';
+import { stringifyQuery } from './internal/utils/query';
+import { VERSION } from './version';
+import * as Errors from './core/error';
+import * as Uploads from './core/uploads';
+import * as API from './resources/index';
+import { APIPromise } from './core/api-promise';
+import {
+  Admin,
+  AdminListParams,
+  AdminListResponse,
+  AdminListRolesParams,
+  AdminListRolesResponse,
+  AdminRetrieveParams,
+  Admins,
+} from './resources/admins';
+import { Board, BoardListParams, BoardListResponse, BoardRetrieveParams, Boards } from './resources/boards';
+import { Brand, BrandListParams, BrandListResponse, BrandRetrieveParams, Brands } from './resources/brands';
+import {
+  Comment,
+  CommentCreateParams,
+  CommentDelete0Params,
+  CommentDelete0Response,
+  CommentDelete1Params,
+  CommentDelete1Response,
+  CommentListParams,
+  CommentListResponse,
+  CommentRetrieveParams,
+  CommentUpdateParams,
+  Comments,
+} from './resources/comments';
+import {
+  CustomField,
+  CustomFieldList,
+  CustomFieldListParams,
+  CustomFieldRetrieveParams,
+  CustomFields,
+} from './resources/custom-fields';
+import {
+  PostStatus,
+  PostStatusListParams,
+  PostStatusListResponse,
+  PostStatusRetrieveParams,
+  PostStatuses,
+} from './resources/post-statuses';
+import {
+  Survey,
+  SurveyListParams,
+  SurveyListResponse,
+  SurveyNextAction,
+  SurveyRetrieveParams,
+  SurveyRetrieveResponsesParams,
+  SurveyRetrieveResponsesResponse,
+  Surveys,
+} from './resources/surveys';
+import {
+  ConversationTag,
+  TagCreateOrRenameParams,
+  TagDeleteParams,
+  TagDeleteResponse,
+  TagListParams,
+  TagListResponse,
+  TagRetrieveParams,
+  Tags,
+} from './resources/tags';
+import { Team, TeamListParams, TeamListResponse, TeamRetrieveParams, Teams } from './resources/teams';
+import {
+  Webhook,
+  WebhookCreateParams,
+  WebhookDeleteParams,
+  WebhookDeleteResponse,
+  WebhookListParams,
+  WebhookListResponse,
+  WebhookRefreshSecretParams,
+  WebhookRequestConfigInput,
+  WebhookRetrieveParams,
+  WebhookUpdateParams,
+  Webhooks,
+} from './resources/webhooks';
+import {
+  Changelog,
+  ChangelogCreateParams,
+  ChangelogDeleteParams,
+  ChangelogDeleteResponse,
+  ChangelogListParams,
+  ChangelogListResponse,
+  ChangelogPublishParams,
+  ChangelogRetrieveParams,
+  ChangelogUnpublishParams,
+  ChangelogUpdateParams,
+  Changelogs,
+  PublishUnpublishSuccess,
+} from './resources/changelogs/changelogs';
+import {
+  Companies,
+  Company,
+  CompanyCreateOrUpdateParams,
+  CompanyDeleteByCompanyIDParams,
+  CompanyDeleteParams,
+  CompanyListParams,
+  CompanyListResponse,
+  CompanyRetrieveParams,
+  DeletedCompany,
+} from './resources/companies/companies';
+import {
+  Contact,
+  ContactBlockParams,
+  ContactBlockResponse,
+  ContactCreateOrUpdateParams,
+  ContactCreateOrUpdateResponse,
+  ContactDeleteParams,
+  ContactList,
+  ContactListParams,
+  ContactRetrieveParams,
+  ContactRetrieveResponse,
+  ContactUnblockParams,
+  ContactUnblockResponse,
+  Contacts,
+  DeletedContact,
+} from './resources/contacts/contacts';
+import {
+  Conversation,
+  ConversationCreateParams,
+  ConversationDeleteParams,
+  ConversationDeleteResponse,
+  ConversationListParams,
+  ConversationListResponse,
+  ConversationPart,
+  ConversationPartAuthor,
+  ConversationParticipant,
+  ConversationRedactParams,
+  ConversationReplyParams,
+  ConversationRetrieveParams,
+  ConversationTagApplication,
+  ConversationUpdateParams,
+  Conversations,
+  CsatEmailDelivery,
+  CsatRatedAgent,
+  CsatWorkflowLink,
+  EmailRecipients,
+} from './resources/conversations/conversations';
+import { HelpCenter } from './resources/help-center/help-center';
+import {
+  Post,
+  PostCreateParams,
+  PostDeleteParams,
+  PostDeleteResponse,
+  PostListParams,
+  PostListResponse,
+  PostRetrieveParams,
+  PostUpdateParams,
+  Posts,
+} from './resources/posts/posts';
+import {
+  AuthorInput,
+  Ticket,
+  TicketCreateParams,
+  TicketDeleteParams,
+  TicketDeleteResponse,
+  TicketListParams,
+  TicketListResponse,
+  TicketReplyParams,
+  TicketRetrieveParams,
+  TicketUpdateParams,
+  Tickets,
+} from './resources/tickets/tickets';
+import { type Fetch } from './internal/builtin-types';
+import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
+import { FinalRequestOptions, RequestOptions } from './internal/request-options';
+import { readEnv } from './internal/utils/env';
+import {
+  type LogLevel,
+  type Logger,
+  formatRequestDetails,
+  loggerFor,
+  parseLogLevel,
+} from './internal/utils/log';
+import { isEmptyObj } from './internal/utils/values';
+
+export interface ClientOptions {
+  /**
+   * API key as Bearer token. Use: Authorization: Bearer sk_...
+   */
+  apiKey?: string | undefined;
+
+  /**
+   * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
+   *
+   * Defaults to process.env['FEATUREBASE_BASE_URL'].
+   */
+  baseURL?: string | null | 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.
+   *
+   * 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;
+  /**
+   * Additional `RequestInit` options to be passed to `fetch` calls.
+   * Properties will be overridden by per-request `fetchOptions`.
+   */
+  fetchOptions?: MergedRequestInit | undefined;
+
+  /**
+   * Specify a custom `fetch` function implementation.
+   *
+   * If not provided, we expect that `fetch` is defined globally.
+   */
+  fetch?: Fetch | undefined;
+
+  /**
+   * 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 | undefined;
+
+  /**
+   * Default headers to include with every request to the API.
+   *
+   * These can be removed in individual requests by explicitly setting the
+   * header to `null` in request options.
+   */
+  defaultHeaders?: HeadersLike | undefined;
+
+  /**
+   * Default query parameters to include with every request to the API.
+   *
+   * These can be removed in individual requests by explicitly setting the
+   * param to `undefined` in request options.
+   */
+  defaultQuery?: Record<string, string | undefined> | undefined;
+
+  /**
+   * Set the log level.
+   *
+   * Defaults to process.env['FEATUREBASE_LOG'] or 'warn' if it isn't set.
+   */
+  logLevel?: LogLevel | undefined;
+
+  /**
+   * Set the logger.
+   *
+   * Defaults to globalThis.console.
+   */
+  logger?: Logger | undefined;
+}
+
+/**
+ * API Client for interfacing with the Featurebase API.
+ */
+export class Featurebase {
+  apiKey: string;
+
+  baseURL: string;
+  maxRetries: number;
+  timeout: number;
+  logger: Logger;
+  logLevel: LogLevel | undefined;
+  fetchOptions: MergedRequestInit | undefined;
+
+  private fetch: Fetch;
+  #encoder: Opts.RequestEncoder;
+  protected idempotencyHeader?: string;
+  private _options: ClientOptions;
+
+  /**
+   * API Client for interfacing with the Featurebase API.
+   *
+   * @param {string | undefined} [opts.apiKey=process.env['FEATUREBASE_API_KEY'] ?? undefined]
+   * @param {string} [opts.baseURL=process.env['FEATUREBASE_BASE_URL'] ?? https://do.featurebase.app] - Override the default base URL for the API.
+   * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
+   * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
+   * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
+   * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
+   * @param {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API.
+   * @param {Record<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
+   */
+  constructor({
+    baseURL = readEnv('FEATUREBASE_BASE_URL'),
+    apiKey = readEnv('FEATUREBASE_API_KEY'),
+    ...opts
+  }: ClientOptions = {}) {
+    if (apiKey === undefined) {
+      throw new Errors.FeaturebaseError(
+        "The FEATUREBASE_API_KEY environment variable is missing or empty; either provide it, or instantiate the Featurebase client with an apiKey option, like new Featurebase({ apiKey: 'My API Key' }).",
+      );
+    }
+
+    const options: ClientOptions = {
+      apiKey,
+      ...opts,
+      baseURL: baseURL || `https://do.featurebase.app`,
+    };
+
+    this.baseURL = options.baseURL!;
+    this.timeout = options.timeout ?? Featurebase.DEFAULT_TIMEOUT /* 1 minute */;
+    this.logger = options.logger ?? console;
+    const defaultLogLevel = 'warn';
+    // Set default logLevel early so that we can log a warning in parseLogLevel.
+    this.logLevel = defaultLogLevel;
+    this.logLevel =
+      parseLogLevel(options.logLevel, 'ClientOptions.logLevel', this) ??
+      parseLogLevel(readEnv('FEATUREBASE_LOG'), "process.env['FEATUREBASE_LOG']", this) ??
+      defaultLogLevel;
+    this.fetchOptions = options.fetchOptions;
+    this.maxRetries = options.maxRetries ?? 2;
+    this.fetch = options.fetch ?? Shims.getDefaultFetch();
+    this.#encoder = Opts.FallbackEncoder;
+
+    const customHeadersEnv = readEnv('FEATUREBASE_CUSTOM_HEADERS');
+    if (customHeadersEnv) {
+      const parsed: Record<string, string> = {};
+      for (const line of customHeadersEnv.split('\n')) {
+        const colon = line.indexOf(':');
+        if (colon >= 0) {
+          parsed[line.substring(0, colon).trim()] = line.substring(colon + 1).trim();
+        }
+      }
+      options.defaultHeaders = { ...parsed, ...options.defaultHeaders };
+    }
+
+    this._options = options;
+
+    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 {
+    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;
+  }
+
+  /**
+   * Check whether the base URL is set to its default.
+   */
+  #baseURLOverridden(): boolean {
+    return this.baseURL !== 'https://do.featurebase.app';
+  }
+
+  protected defaultQuery(): Record<string, string | undefined> | undefined {
+    return this._options.defaultQuery;
+  }
+
+  protected validateHeaders({ values, nulls }: NullableHeaders) {
+    return;
+  }
+
+  protected async authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
+    return buildHeaders([{ Authorization: `Bearer ${this.apiKey}` }]);
+  }
+
+  protected stringifyQuery(query: object | Record<string, unknown>): string {
+    return stringifyQuery(query);
+  }
+
+  private getUserAgent(): string {
+    return `${this.constructor.name}/JS ${VERSION}`;
+  }
+
+  protected defaultIdempotencyKey(): string {
+    return `stainless-node-retry-${uuid4()}`;
+  }
+
+  protected makeStatusError(
+    status: number,
+    error: Object,
+    message: string | undefined,
+    headers: Headers,
+  ): Errors.APIError {
+    return Errors.APIError.generate(status, error, message, headers);
+  }
+
+  buildURL(
+    path: string,
+    query: Record<string, unknown> | null | undefined,
+    defaultBaseURL?: string | undefined,
+  ): string {
+    const baseURL = (!this.#baseURLOverridden() && defaultBaseURL) || this.baseURL;
+    const url =
+      isAbsoluteURL(path) ?
+        new URL(path)
+      : new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
+
+    const defaultQuery = this.defaultQuery();
+    const pathQuery = Object.fromEntries(url.searchParams);
+    if (!isEmptyObj(defaultQuery) || !isEmptyObj(pathQuery)) {
+      query = { ...pathQuery, ...defaultQuery, ...query };
+    }
+
+    if (typeof query === 'object' && query && !Array.isArray(query)) {
+      url.search = this.stringifyQuery(query);
+    }
+
+    return url.toString();
+  }
+
+  /**
+   * Used as a callback for mutating the given `FinalRequestOptions` object.
+   */
+  protected async prepareOptions(options: FinalRequestOptions): Promise<void> {}
+
+  /**
+   * Used as a callback for mutating the given `RequestInit` object.
+   *
+   * This is useful for cases where you want to add certain headers based off of
+   * the request properties, e.g. `method` or `url`.
+   */
+  protected async prepareRequest(
+    request: RequestInit,
+    { url, options }: { url: string; options: FinalRequestOptions },
+  ): Promise<void> {}
+
+  get<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp> {
+    return this.methodRequest('get', path, opts);
+  }
+
+  post<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp> {
+    return this.methodRequest('post', path, opts);
+  }
+
+  patch<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp> {
+    return this.methodRequest('patch', path, opts);
+  }
+
+  put<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp> {
+    return this.methodRequest('put', path, opts);
+  }
+
+  delete<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp> {
+    return this.methodRequest('delete', path, opts);
+  }
+
+  private methodRequest<Rsp>(
+    method: HTTPMethod,
+    path: string,
+    opts?: PromiseOrValue<RequestOptions>,
+  ): APIPromise<Rsp> {
+    return this.request(
+      Promise.resolve(opts).then((opts) => {
+        return { method, path, ...opts };
+      }),
+    );
+  }
+
+  request<Rsp>(
+    options: PromiseOrValue<FinalRequestOptions>,
+    remainingRetries: number | null = null,
+  ): APIPromise<Rsp> {
+    return new APIPromise(this, this.makeRequest(options, remainingRetries, undefined));
+  }
+
+  private async makeRequest(
+    optionsInput: PromiseOrValue<FinalRequestOptions>,
+    retriesRemaining: number | null,
+    retryOfRequestLogID: string | undefined,
+  ): Promise<APIResponseProps> {
+    const options = await optionsInput;
+    const maxRetries = options.maxRetries ?? this.maxRetries;
+    if (retriesRemaining == null) {
+      retriesRemaining = maxRetries;
+    }
+
+    await this.prepareOptions(options);
+
+    const { req, url, timeout } = await this.buildRequest(options, {
+      retryCount: maxRetries - retriesRemaining,
+    });
+
+    await this.prepareRequest(req, { url, options });
+
+    /** Not an API request ID, just for correlating local log entries. */
+    const requestLogID = 'log_' + ((Math.random() * (1 << 24)) | 0).toString(16).padStart(6, '0');
+    const retryLogStr = retryOfRequestLogID === undefined ? '' : `, retryOf: ${retryOfRequestLogID}`;
+    const startTime = Date.now();
+
+    loggerFor(this).debug(
+      `[${requestLogID}] sending request`,
+      formatRequestDetails({
+        retryOfRequestLogID,
+        method: options.method,
+        url,
+        options,
+        headers: req.headers,
+      }),
+    );
+
+    if (options.signal?.aborted) {
+      throw new Errors.APIUserAbortError();
+    }
+
+    const controller = new AbortController();
+    const response = await this.fetchWithTimeout(url, req, timeout, controller).catch(castToError);
+    const headersTime = Date.now();
+
+    if (response instanceof globalThis.Error) {
+      const retryMessage = `retrying, ${retriesRemaining} attempts remaining`;
+      if (options.signal?.aborted) {
+        throw new Errors.APIUserAbortError();
+      }
+      // detect native connection timeout errors
+      // deno throws "TypeError: error sending request for url (https://example/): client error (Connect): tcp connect error: Operation timed out (os error 60): Operation timed out (os error 60)"
+      // undici throws "TypeError: fetch failed" with cause "ConnectTimeoutError: Connect Timeout Error (attempted address: example:443, timeout: 1ms)"
+      // others do not provide enough information to distinguish timeouts from other connection errors
+      const isTimeout =
+        isAbortError(response) ||
+        /timed? ?out/i.test(String(response) + ('cause' in response ? String(response.cause) : ''));
+      if (retriesRemaining) {
+        loggerFor(this).info(
+          `[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} - ${retryMessage}`,
+        );
+        loggerFor(this).debug(
+          `[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} (${retryMessage})`,
+          formatRequestDetails({
+            retryOfRequestLogID,
+            url,
+            durationMs: headersTime - startTime,
+            message: response.message,
+          }),
+        );
+        return this.retryRequest(options, retriesRemaining, retryOfRequestLogID ?? requestLogID);
+      }
+      loggerFor(this).info(
+        `[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} - error; no more retries left`,
+      );
+      loggerFor(this).debug(
+        `[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} (error; no more retries left)`,
+        formatRequestDetails({
+          retryOfRequestLogID,
+          url,
+          durationMs: headersTime - startTime,
+          message: response.message,
+        }),
+      );
+      if (isTimeout) {
+        throw new Errors.APIConnectionTimeoutError();
+      }
+      throw new Errors.APIConnectionError({ cause: response });
+    }
+
+    const responseInfo = `[${requestLogID}${retryLogStr}] ${req.method} ${url} ${
+      response.ok ? 'succeeded' : 'failed'
+    } with status ${response.status} in ${headersTime - startTime}ms`;
+
+    if (!response.ok) {
+      const shouldRetry = await this.shouldRetry(response);
+      if (retriesRemaining && shouldRetry) {
+        const retryMessage = `retrying, ${retriesRemaining} attempts remaining`;
+
+        // We don't need the body of this response.
+        await Shims.CancelReadableStream(response.body);
+        loggerFor(this).info(`${responseInfo} - ${retryMessage}`);
+        loggerFor(this).debug(
+          `[${requestLogID}] response error (${retryMessage})`,
+          formatRequestDetails({
+            retryOfRequestLogID,
+            url: response.url,
+            status: response.status,
+            headers: response.headers,
+            durationMs: headersTime - startTime,
+          }),
+        );
+        return this.retryRequest(
+          options,
+          retriesRemaining,
+          retryOfRequestLogID ?? requestLogID,
+          response.headers,
+        );
+      }
+
+      const retryMessage = shouldRetry ? `error; no more retries left` : `error; not retryable`;
+
+      loggerFor(this).info(`${responseInfo} - ${retryMessage}`);
+
+      const errText = await response.text().catch((err: any) => castToError(err).message);
+      const errJSON = safeJSON(errText) as any;
+      const errMessage = errJSON ? undefined : errText;
+
+      loggerFor(this).debug(
+        `[${requestLogID}] response error (${retryMessage})`,
+        formatRequestDetails({
+          retryOfRequestLogID,
+          url: response.url,
+          status: response.status,
+          headers: response.headers,
+          message: errMessage,
+          durationMs: Date.now() - startTime,
+        }),
+      );
+
+      const err = this.makeStatusError(response.status, errJSON, errMessage, response.headers);
+      throw err;
+    }
+
+    loggerFor(this).info(responseInfo);
+    loggerFor(this).debug(
+      `[${requestLogID}] response start`,
+      formatRequestDetails({
+        retryOfRequestLogID,
+        url: response.url,
+        status: response.status,
+        headers: response.headers,
+        durationMs: headersTime - startTime,
+      }),
+    );
+
+    return { response, options, controller, requestLogID, retryOfRequestLogID, startTime };
+  }
+
+  async fetchWithTimeout(
+    url: RequestInfo,
+    init: RequestInit | undefined,
+    ms: number,
+    controller: AbortController,
+  ): Promise<Response> {
+    const { signal, method, ...options } = init || {};
+    const abort = this._makeAbort(controller);
+    if (signal) signal.addEventListener('abort', abort, { once: true });
+
+    const timeout = setTimeout(abort, ms);
+
+    const isReadableBody =
+      ((globalThis as any).ReadableStream && options.body instanceof (globalThis as any).ReadableStream) ||
+      (typeof options.body === 'object' && options.body !== null && Symbol.asyncIterator in options.body);
+
+    const fetchOptions: RequestInit = {
+      signal: controller.signal as any,
+      ...(isReadableBody ? { duplex: 'half' } : {}),
+      method: 'GET',
+      ...options,
+    };
+    if (method) {
+      // Custom methods like 'patch' need to be uppercased
+      // See https://github.com/nodejs/undici/issues/2294
+      fetchOptions.method = method.toUpperCase();
+    }
+
+    try {
+      // use undefined this binding; fetch errors if bound to something else in browser/cloudflare
+      return await this.fetch.call(undefined, url, fetchOptions);
+    } finally {
+      clearTimeout(timeout);
+    }
+  }
+
+  private async shouldRetry(response: Response): Promise<boolean> {
+    // Note this is not a standard header.
+    const shouldRetryHeader = response.headers.get('x-should-retry');
+
+    // If the server explicitly says whether or not to retry, obey.
+    if (shouldRetryHeader === 'true') return true;
+    if (shouldRetryHeader === 'false') return false;
+
+    // Retry on request timeouts.
+    if (response.status === 408) return true;
+
+    // Retry on lock timeouts.
+    if (response.status === 409) return true;
+
+    // Retry on rate limits.
+    if (response.status === 429) return true;
+
+    // Retry internal errors.
+    if (response.status >= 500) return true;
+
+    return false;
+  }
+
+  private async retryRequest(
+    options: FinalRequestOptions,
+    retriesRemaining: number,
+    requestLogID: string,
+    responseHeaders?: Headers | undefined,
+  ): Promise<APIResponseProps> {
+    let timeoutMillis: number | undefined;
+
+    // Note the `retry-after-ms` header may not be standard, but is a good idea and we'd like proactive support for it.
+    const retryAfterMillisHeader = responseHeaders?.get('retry-after-ms');
+    if (retryAfterMillisHeader) {
+      const timeoutMs = parseFloat(retryAfterMillisHeader);
+      if (!Number.isNaN(timeoutMs)) {
+        timeoutMillis = timeoutMs;
+      }
+    }
+
+    // About the Retry-After header: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After
+    const retryAfterHeader = responseHeaders?.get('retry-after');
+    if (retryAfterHeader && !timeoutMillis) {
+      const timeoutSeconds = parseFloat(retryAfterHeader);
+      if (!Number.isNaN(timeoutSeconds)) {
+        timeoutMillis = timeoutSeconds * 1000;
+      } else {
+        timeoutMillis = Date.parse(retryAfterHeader) - Date.now();
+      }
+    }
+
+    // If the API asks us to wait a certain amount of time, just do what it
+    // says, but otherwise calculate a default
+    if (timeoutMillis === undefined) {
+      const maxRetries = options.maxRetries ?? this.maxRetries;
+      timeoutMillis = this.calculateDefaultRetryTimeoutMillis(retriesRemaining, maxRetries);
+    }
+    await sleep(timeoutMillis);
+
+    return this.makeRequest(options, retriesRemaining - 1, requestLogID);
+  }
+
+  private calculateDefaultRetryTimeoutMillis(retriesRemaining: number, maxRetries: number): number {
+    const initialRetryDelay = 0.5;
+    const maxRetryDelay = 8.0;
+
+    const numRetries = maxRetries - retriesRemaining;
+
+    // Apply exponential backoff, but not more than the max.
+    const sleepSeconds = Math.min(initialRetryDelay * Math.pow(2, numRetries), maxRetryDelay);
+
+    // Apply some jitter, take up to at most 25 percent of the retry time.
+    const jitter = 1 - Math.random() * 0.25;
+
+    return sleepSeconds * jitter * 1000;
+  }
+
+  async buildRequest(
+    inputOptions: FinalRequestOptions,
+    { retryCount = 0 }: { retryCount?: number } = {},
+  ): Promise<{ req: FinalizedRequestInit; url: string; timeout: number }> {
+    const options = { ...inputOptions };
+    const { method, path, query, defaultBaseURL } = options;
+
+    const url = this.buildURL(path!, query as Record<string, unknown>, defaultBaseURL);
+    if ('timeout' in options) validatePositiveInteger('timeout', options.timeout);
+    options.timeout = options.timeout ?? this.timeout;
+    const { bodyHeaders, body } = this.buildBody({ options });
+    const reqHeaders = await this.buildHeaders({ options: inputOptions, method, bodyHeaders, retryCount });
+
+    const req: FinalizedRequestInit = {
+      method,
+      headers: reqHeaders,
+      ...(options.signal && { signal: options.signal }),
+      ...((globalThis as any).ReadableStream &&
+        body instanceof (globalThis as any).ReadableStream && { duplex: 'half' }),
+      ...(body && { body }),
+      ...((this.fetchOptions as any) ?? {}),
+      ...((options.fetchOptions as any) ?? {}),
+    };
+
+    return { req, url, timeout: options.timeout };
+  }
+
+  private async buildHeaders({
+    options,
+    method,
+    bodyHeaders,
+    retryCount,
+  }: {
+    options: FinalRequestOptions;
+    method: HTTPMethod;
+    bodyHeaders: HeadersLike;
+    retryCount: number;
+  }): Promise<Headers> {
+    let idempotencyHeaders: HeadersLike = {};
+    if (this.idempotencyHeader && method !== 'get') {
+      if (!options.idempotencyKey) options.idempotencyKey = this.defaultIdempotencyKey();
+      idempotencyHeaders[this.idempotencyHeader] = options.idempotencyKey;
+    }
+
+    const headers = buildHeaders([
+      idempotencyHeaders,
+      {
+        Accept: 'application/json',
+        'User-Agent': this.getUserAgent(),
+        'X-Stainless-Retry-Count': String(retryCount),
+        ...(options.timeout ? { 'X-Stainless-Timeout': String(Math.trunc(options.timeout / 1000)) } : {}),
+        ...getPlatformHeaders(),
+      },
+      await this.authHeaders(options),
+      this._options.defaultHeaders,
+      bodyHeaders,
+      options.headers,
+    ]);
+
+    this.validateHeaders(headers);
+
+    return headers.values;
+  }
+
+  private _makeAbort(controller: AbortController) {
+    // note: we can't just inline this method inside `fetchWithTimeout()` because then the closure
+    //       would capture all request options, and cause a memory leak.
+    return () => controller.abort();
+  }
+
+  private buildBody({ options: { body, headers: rawHeaders } }: { options: FinalRequestOptions }): {
+    bodyHeaders: HeadersLike;
+    body: BodyInit | undefined;
+  } {
+    if (!body) {
+      return { bodyHeaders: undefined, body: undefined };
+    }
+    const headers = buildHeaders([rawHeaders]);
+    if (
+      // Pass raw type verbatim
+      ArrayBuffer.isView(body) ||
+      body instanceof ArrayBuffer ||
+      body instanceof DataView ||
+      (typeof body === 'string' &&
+        // Preserve legacy string encoding behavior for now
+        headers.values.has('content-type')) ||
+      // `Blob` is superset of `File`
+      ((globalThis as any).Blob && body instanceof (globalThis as any).Blob) ||
+      // `FormData` -> `multipart/form-data`
+      body instanceof FormData ||
+      // `URLSearchParams` -> `application/x-www-form-urlencoded`
+      body instanceof URLSearchParams ||
+      // Send chunked stream (each chunk has own `length`)
+      ((globalThis as any).ReadableStream && body instanceof (globalThis as any).ReadableStream)
+    ) {
+      return { bodyHeaders: undefined, body: body as BodyInit };
+    } else if (
+      typeof body === 'object' &&
+      (Symbol.asyncIterator in body ||
+        (Symbol.iterator in body && 'next' in body && typeof body.next === 'function'))
+    ) {
+      return { bodyHeaders: undefined, body: Shims.ReadableStreamFrom(body as AsyncIterable<Uint8Array>) };
+    } else if (
+      typeof body === 'object' &&
+      headers.values.get('content-type') === 'application/x-www-form-urlencoded'
+    ) {
+      return {
+        bodyHeaders: { 'content-type': 'application/x-www-form-urlencoded' },
+        body: this.stringifyQuery(body),
+      };
+    } else {
+      return this.#encoder({ body, headers });
+    }
+  }
+
+  static Featurebase = this;
+  static DEFAULT_TIMEOUT = 60000; // 1 minute
+
+  static FeaturebaseError = Errors.FeaturebaseError;
+  static APIError = Errors.APIError;
+  static APIConnectionError = Errors.APIConnectionError;
+  static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
+  static APIUserAbortError = Errors.APIUserAbortError;
+  static NotFoundError = Errors.NotFoundError;
+  static ConflictError = Errors.ConflictError;
+  static RateLimitError = Errors.RateLimitError;
+  static BadRequestError = Errors.BadRequestError;
+  static AuthenticationError = Errors.AuthenticationError;
+  static InternalServerError = Errors.InternalServerError;
+  static PermissionDeniedError = Errors.PermissionDeniedError;
+  static UnprocessableEntityError = Errors.UnprocessableEntityError;
+
+  static toFile = Uploads.toFile;
+
+  /**
+   * Boards (post categories) organize feedback into distinct containers with their own settings.
+   */
+  boards: API.Boards = new API.Boards(this);
+  /**
+   * User-submitted feedback and feature requests. Posts belong to boards and can be upvoted, commented on, and tracked through statuses.
+   */
+  posts: API.Posts = new API.Posts(this);
+  /**
+   * Post statuses define the workflow stages for posts (e.g., In Review, Active, Completed).
+   */
+  postStatuses: API.PostStatuses = new API.PostStatuses(this);
+  /**
+   * Release notes and updates published by the organization. Changelogs keep users informed about new features, improvements, and fixes.
+   */
+  changelogs: API.Changelogs = new API.Changelogs(this);
+  /**
+   * Team members who manage your Featurebase organization. Admins have roles that define their permissions.
+   */
+  admins: API.Admins = new API.Admins(this);
+  /**
+   * Configurable input fields for posts in your Featurebase organization. Custom fields allow you to collect additional structured data when users create posts.
+   */
+  customFields: API.CustomFields = new API.CustomFields(this);
+  /**
+   * Surveys allow you to collect targeted feedback from your users within your product. Surveys can be targeted to specific user segments or pages and can contain multiple questions with conditional logic.
+   */
+  surveys: API.Surveys = new API.Surveys(this);
+  helpCenter: API.HelpCenter = new API.HelpCenter(this);
+  /**
+   * Contacts are the customers and leads in your Featurebase organization. Use this endpoint to list and retrieve contact information.
+   */
+  contacts: API.Contacts = new API.Contacts(this);
+  /**
+   * Teams are groups within your Featurebase organization. Use this endpoint to list and retrieve team information for conversation assignment and organization management.
+   */
+  teams: API.Teams = new API.Teams(this);
+  /**
+   * Companies represent organizations or businesses that your users belong to. Use this endpoint to list and retrieve company information.
+   */
+  companies: API.Companies = new API.Companies(this);
+  /**
+   * Brands represent distinct brand identities within your organization. Each brand can have its own help center and email sending address. Use this endpoint to list and retrieve brand information.
+   */
+  brands: API.Brands = new API.Brands(this);
+  /**
+   * Conversations are messenger/inbox conversations in your Featurebase organization. Use this endpoint to list and retrieve conversation information.
+   */
+  conversations: API.Conversations = new API.Conversations(this);
+  /**
+   * Conversation tags let you organize, filter, and automate around inbox conversations. Use these endpoints to list, look up, create, rename, and delete workspace conversation tags.
+   */
+  tags: API.Tags = new API.Tags(this);
+  /**
+   * Tickets represent support requests in your Featurebase organization. Create, update, reply to, and manage tickets via these endpoints.
+   */
+  tickets: API.Tickets = new API.Tickets(this);
+  /**
+   * Webhooks allow you to receive real-time HTTP callbacks when events occur in your Featurebase organization. Configure webhook endpoints to subscribe to specific event types.
+   */
+  webhooks: API.Webhooks = new API.Webhooks(this);
+  /**
+   * Threaded discussions on posts and changelogs. Comments support voting, moderation, and privacy controls.
+   */
+  comments: API.Comments = new API.Comments(this);
+}
+
+Featurebase.Boards = Boards;
+Featurebase.Posts = Posts;
+Featurebase.PostStatuses = PostStatuses;
+Featurebase.Changelogs = Changelogs;
+Featurebase.Admins = Admins;
+Featurebase.CustomFields = CustomFields;
+Featurebase.Surveys = Surveys;
+Featurebase.HelpCenter = HelpCenter;
+Featurebase.Contacts = Contacts;
+Featurebase.Teams = Teams;
+Featurebase.Companies = Companies;
+Featurebase.Brands = Brands;
+Featurebase.Conversations = Conversations;
+Featurebase.Tags = Tags;
+Featurebase.Tickets = Tickets;
+Featurebase.Webhooks = Webhooks;
+Featurebase.Comments = Comments;
+
+export declare namespace Featurebase {
+  export type RequestOptions = Opts.RequestOptions;
+
+  export {
+    Boards as Boards,
+    type Board as Board,
+    type BoardListResponse as BoardListResponse,
+    type BoardRetrieveParams as BoardRetrieveParams,
+    type BoardListParams as BoardListParams,
+  };
+
+  export {
+    Posts as Posts,
+    type Post as Post,
+    type PostListResponse as PostListResponse,
+    type PostDeleteResponse as PostDeleteResponse,
+    type PostCreateParams as PostCreateParams,
+    type PostRetrieveParams as PostRetrieveParams,
+    type PostUpdateParams as PostUpdateParams,
+    type PostListParams as PostListParams,
+    type PostDeleteParams as PostDeleteParams,
+  };
+
+  export {
+    PostStatuses as PostStatuses,
+    type PostStatus as PostStatus,
+    type PostStatusListResponse as PostStatusListResponse,
+    type PostStatusRetrieveParams as PostStatusRetrieveParams,
+    type PostStatusListParams as PostStatusListParams,
+  };
+
+  export {
+    Changelogs as Changelogs,
+    type Changelog as Changelog,
+    type PublishUnpublishSuccess as PublishUnpublishSuccess,
+    type ChangelogListResponse as ChangelogListResponse,
+    type ChangelogDeleteResponse as ChangelogDeleteResponse,
+    type ChangelogCreateParams as ChangelogCreateParams,
+    type ChangelogRetrieveParams as ChangelogRetrieveParams,
+    type ChangelogUpdateParams as ChangelogUpdateParams,
+    type ChangelogListParams as ChangelogListParams,
+    type ChangelogDeleteParams as ChangelogDeleteParams,
+    type ChangelogPublishParams as ChangelogPublishParams,
+    type ChangelogUnpublishParams as ChangelogUnpublishParams,
+  };
+
+  export {
+    Admins as Admins,
+    type Admin as Admin,
+    type AdminListResponse as AdminListResponse,
+    type AdminListRolesResponse as AdminListRolesResponse,
+    type AdminRetrieveParams as AdminRetrieveParams,
+    type AdminListParams as AdminListParams,
+    type AdminListRolesParams as AdminListRolesParams,
+  };
+
+  export {
+    CustomFields as CustomFields,
+    type CustomField as CustomField,
+    type CustomFieldList as CustomFieldList,
+    type CustomFieldRetrieveParams as CustomFieldRetrieveParams,
+    type CustomFieldListParams as CustomFieldListParams,
+  };
+
+  export {
+    Surveys as Surveys,
+    type Survey as Survey,
+    type SurveyNextAction as SurveyNextAction,
+    type SurveyListResponse as SurveyListResponse,
+    type SurveyRetrieveResponsesResponse as SurveyRetrieveResponsesResponse,
+    type SurveyRetrieveParams as SurveyRetrieveParams,
+    type SurveyListParams as SurveyListParams,
+    type SurveyRetrieveResponsesParams as SurveyRetrieveResponsesParams,
+  };
+
+  export { HelpCenter as HelpCenter };
+
+  export {
+    Contacts as Contacts,
+    type Contact as Contact,
+    type ContactList as ContactList,
+    type DeletedContact as DeletedContact,
+    type ContactRetrieveResponse as ContactRetrieveResponse,
+    type ContactBlockResponse as ContactBlockResponse,
+    type ContactCreateOrUpdateResponse as ContactCreateOrUpdateResponse,
+    type ContactUnblockResponse as ContactUnblockResponse,
+    type ContactRetrieveParams as ContactRetrieveParams,
+    type ContactListParams as ContactListParams,
+    type ContactDeleteParams as ContactDeleteParams,
+    type ContactBlockParams as ContactBlockParams,
+    type ContactCreateOrUpdateParams as ContactCreateOrUpdateParams,
+    type ContactUnblockParams as ContactUnblockParams,
+  };
+
+  export {
+    Teams as Teams,
+    type Team as Team,
+    type TeamListResponse as TeamListResponse,
+    type TeamRetrieveParams as TeamRetrieveParams,
+    type TeamListParams as TeamListParams,
+  };
+
+  export {
+    Companies as Companies,
+    type Company as Company,
+    type DeletedCompany as DeletedCompany,
+    type CompanyListResponse as CompanyListResponse,
+    type CompanyRetrieveParams as CompanyRetrieveParams,
+    type CompanyListParams as CompanyListParams,
+    type CompanyDeleteParams as CompanyDeleteParams,
+    type CompanyCreateOrUpdateParams as CompanyCreateOrUpdateParams,
+    type CompanyDeleteByCompanyIDParams as CompanyDeleteByCompanyIDParams,
+  };
+
+  export {
+    Brands as Brands,
+    type Brand as Brand,
+    type BrandListResponse as BrandListResponse,
+    type BrandRetrieveParams as BrandRetrieveParams,
+    type BrandListParams as BrandListParams,
+  };
+
+  export {
+    Conversations as Conversations,
+    type Conversation as Conversation,
+    type ConversationPart as ConversationPart,
+    type ConversationPartAuthor as ConversationPartAuthor,
+    type ConversationParticipant as ConversationParticipant,
+    type ConversationTagApplication as ConversationTagApplication,
+    type CsatEmailDelivery as CsatEmailDelivery,
+    type CsatRatedAgent as CsatRatedAgent,
+    type CsatWorkflowLink as CsatWorkflowLink,
+    type EmailRecipients as EmailRecipients,
+    type ConversationListResponse as ConversationListResponse,
+    type ConversationDeleteResponse as ConversationDeleteResponse,
+    type ConversationCreateParams as ConversationCreateParams,
+    type ConversationRetrieveParams as ConversationRetrieveParams,
+    type ConversationUpdateParams as ConversationUpdateParams,
+    type ConversationListParams as ConversationListParams,
+    type ConversationDeleteParams as ConversationDeleteParams,
+    type ConversationRedactParams as ConversationRedactParams,
+    type ConversationReplyParams as ConversationReplyParams,
+  };
+
+  export {
+    Tags as Tags,
+    type ConversationTag as ConversationTag,
+    type TagListResponse as TagListResponse,
+    type TagDeleteResponse as TagDeleteResponse,
+    type TagRetrieveParams as TagRetrieveParams,
+    type TagListParams as TagListParams,
+    type TagDeleteParams as TagDeleteParams,
+    type TagCreateOrRenameParams as TagCreateOrRenameParams,
+  };
+
+  export {
+    Tickets as Tickets,
+    type AuthorInput as AuthorInput,
+    type Ticket as Ticket,
+    type TicketListResponse as TicketListResponse,
+    type TicketDeleteResponse as TicketDeleteResponse,
+    type TicketCreateParams as TicketCreateParams,
+    type TicketRetrieveParams as TicketRetrieveParams,
+    type TicketUpdateParams as TicketUpdateParams,
+    type TicketListParams as TicketListParams,
+    type TicketDeleteParams as TicketDeleteParams,
+    type TicketReplyParams as TicketReplyParams,
+  };
+
+  export {
+    Webhooks as Webhooks,
+    type Webhook as Webhook,
+    type WebhookRequestConfigInput as WebhookRequestConfigInput,
+    type WebhookListResponse as WebhookListResponse,
+    type WebhookDeleteResponse as WebhookDeleteResponse,
+    type WebhookCreateParams as WebhookCreateParams,
+    type WebhookRetrieveParams as WebhookRetrieveParams,
+    type WebhookUpdateParams as WebhookUpdateParams,
+    type WebhookListParams as WebhookListParams,
+    type WebhookDeleteParams as WebhookDeleteParams,
+    type WebhookRefreshSecretParams as WebhookRefreshSecretParams,
+  };
+
+  export {
+    Comments as Comments,
+    type Comment as Comment,
+    type CommentListResponse as CommentListResponse,
+    type CommentDelete0Response as CommentDelete0Response,
+    type CommentDelete1Response as CommentDelete1Response,
+    type CommentCreateParams as CommentCreateParams,
+    type CommentRetrieveParams as CommentRetrieveParams,
+    type CommentUpdateParams as CommentUpdateParams,
+    type CommentListParams as CommentListParams,
+    type CommentDelete0Params as CommentDelete0Params,
+    type CommentDelete1Params as CommentDelete1Params,
+  };
+}