@seamapi/http 2.18.0 → 2.19.0

package/index.d.ts

@@ -1 +1,6 @@
+/**
+ * JavaScript HTTP client for the Seam API written in TypeScript.
+ *
+ * @packageDocumentation
+ */
 export * from './lib/index.js';

package/index.js

@@ -1,2 +1,7 @@
+/**
+ * JavaScript HTTP client for the Seam API written in TypeScript.
+ *
+ * @packageDocumentation
+ */
 export * from './lib/index.js';
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,cAAc,gBAAgB,CAAA"}

package/lib/client.d.ts

@@ -3,8 +3,20 @@ import { type AxiosRetry } from 'axios-retry';
 export type Client = AxiosInstance;
 export declare const defaultTimeout = 30000;
 export interface ClientOptions {
+    /**
+     * Request timeout in milliseconds, applied per attempt.
+     * Set to 0 to disable the timeout. Defaults to 30 seconds.
+     */
     timeout?: number;
+    /**
+     * Options passed to the underlying Axios client.
+     */
     axiosOptions?: AxiosRequestConfig;
+    /**
+     * Options passed to axios-retry,
+     * which retries idempotent requests that fail
+     * because of a transport error, timeout, or HTTP 429 response.
+     */
     axiosRetryOptions?: AxiosRetryConfig;
 }
 type AxiosRetryConfig = Parameters<AxiosRetry>[1];

package/lib/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/lib/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAA+C,MAAM,OAAO,CAAA;AAC1E,OAAO,UAAU,EAAE,EAEjB,gBAAgB,EAChB,wBAAwB,GACzB,MAAM,aAAa,CAAA;AAEpB,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAA;AAI5E,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAA;AAYpC,MAAM,wBAAwB,GAAG;IAC/B,OAAO,EAAE,CAAC;IACV,cAAc,EAAE,wBAAwB;IACxC,UAAU,EAAE,gBAAgB;IAC5B,kBAAkB,EAAE,IAAI;IACxB,OAAO,EAAE,GAAG,EAAE,CAAC,SAAS;IACxB,uBAAuB,EAAE,GAAG,EAAE,CAAC,SAAS;IACxC,gBAAgB,EAAE,IAAI;CACY,CAAA;AAEpC,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,OAAsB,EAAiB,EAAE;IACpE,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC1B,gBAAgB,EAAE,wBAAwB;QAC1C,OAAO,EAAE,OAAO;QAChB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,cAAc;QAC1C,GAAG,OAAO,CAAC,YAAY;KACxB,CAAC,CAAA;IAEF,UAAU,CAAC,MAAM,EAAE;QACjB,GAAG,wBAAwB;QAC3B,GAAG,OAAO,CAAC,iBAAiB;KAC7B,CAAC,CAAA;IAEF,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAA;IAE7D,OAAO,MAAM,CAAA;AACf,CAAC,CAAA"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/lib/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAA+C,MAAM,OAAO,CAAA;AAC1E,OAAO,UAAU,EAAE,EAEjB,gBAAgB,EAChB,wBAAwB,GACzB,MAAM,aAAa,CAAA;AAEpB,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAA;AAI5E,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAA;AA0BpC,MAAM,wBAAwB,GAAG;IAC/B,OAAO,EAAE,CAAC;IACV,cAAc,EAAE,wBAAwB;IACxC,UAAU,EAAE,gBAAgB;IAC5B,kBAAkB,EAAE,IAAI;IACxB,OAAO,EAAE,GAAG,EAAE,CAAC,SAAS;IACxB,uBAAuB,EAAE,GAAG,EAAE,CAAC,SAAS;IACxC,gBAAgB,EAAE,IAAI;CACY,CAAA;AAEpC,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,OAAsB,EAAiB,EAAE;IACpE,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC1B,gBAAgB,EAAE,wBAAwB;QAC1C,OAAO,EAAE,OAAO;QAChB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,cAAc;QAC1C,GAAG,OAAO,CAAC,YAAY;KACxB,CAAC,CAAA;IAEF,UAAU,CAAC,MAAM,EAAE;QACjB,GAAG,wBAAwB;QAC3B,GAAG,OAAO,CAAC,iBAAiB;KAC7B,CAAC,CAAA;IAEF,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAA;IAE7D,OAAO,MAAM,CAAA;AACf,CAAC,CAAA"}

package/lib/index.d.ts

@@ -2,7 +2,7 @@ export { SeamHttpInvalidTokenError } from './auth.js';
 export * from './error-interceptor.js';
 export * from './openapi.js';
 export * from './options.js';
-export { isSeamActionAttemptError, isSeamActionAttemptFailedError, isSeamActionAttemptTimeoutError, SeamActionAttemptError, SeamActionAttemptFailedError, SeamActionAttemptTimeoutError, } from './resolve-action-attempt.js';
+export { type FailedActionAttempt, isSeamActionAttemptError, isSeamActionAttemptFailedError, isSeamActionAttemptTimeoutError, type ResolveActionAttemptOptions, SeamActionAttemptError, SeamActionAttemptFailedError, SeamActionAttemptTimeoutError, type SucceededActionAttempt, } from './resolve-action-attempt.js';
 export * from './resources/index.js';
 export * from './routes/index.js';
 export * from './seam-http-error.js';

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,WAAW,CAAA;AACrD,cAAc,wBAAwB,CAAA;AACtC,cAAc,cAAc,CAAA;AAC5B,cAAc,cAAc,CAAA;AAC5B,OAAO,EACL,wBAAwB,EACxB,8BAA8B,EAC9B,+BAA+B,EAC/B,sBAAsB,EACtB,4BAA4B,EAC5B,6BAA6B,GAC9B,MAAM,6BAA6B,CAAA;AACpC,cAAc,sBAAsB,CAAA;AACpC,cAAc,mBAAmB,CAAA;AACjC,cAAc,sBAAsB,CAAA;AACpC,cAAc,wBAAwB,CAAA;AACtC,cAAc,qBAAqB,CAAA;AACnC,OAAO,EACL,QAAQ,EACR,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,EACrB,gBAAgB,GACjB,MAAM,YAAY,CAAA;AACnB,cAAc,mCAAmC,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,WAAW,CAAA;AACrD,cAAc,wBAAwB,CAAA;AACtC,cAAc,cAAc,CAAA;AAC5B,cAAc,cAAc,CAAA;AAC5B,OAAO,EAEL,wBAAwB,EACxB,8BAA8B,EAC9B,+BAA+B,EAE/B,sBAAsB,EACtB,4BAA4B,EAC5B,6BAA6B,GAE9B,MAAM,6BAA6B,CAAA;AACpC,cAAc,sBAAsB,CAAA;AACpC,cAAc,mBAAmB,CAAA;AACjC,cAAc,sBAAsB,CAAA;AACpC,cAAc,wBAAwB,CAAA;AACtC,cAAc,qBAAqB,CAAA;AACnC,OAAO,EACL,QAAQ,EACR,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,EACrB,gBAAgB,GACjB,MAAM,YAAY,CAAA;AACnB,cAAc,mCAAmC,CAAA"}

package/lib/options.d.ts

@@ -1,54 +1,159 @@
 import type { Client, ClientOptions } from './client.js';
 import { type SeamHttpRequestOptions } from './request-options.js';
 export type { SeamHttpRequestOptions } from './request-options.js';
+/**
+ * Options for creating a SeamHttpWithoutWorkspace client,
+ * which is not scoped to a single workspace.
+ */
 export type SeamHttpWithoutWorkspaceOptions = SeamHttpWithoutWorkspaceOptionsFromEnv | SeamHttpWithoutWorkspaceOptionsWithClient | SeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken | SeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken;
+/**
+ * Options for creating a SeamHttp client.
+ */
 export type SeamHttpOptions = SeamHttpOptionsFromEnv | SeamHttpOptionsWithClient | SeamHttpOptionsWithApiKey | SeamHttpOptionsWithClientSessionToken | SeamHttpOptionsWithConsoleSessionToken | SeamHttpOptionsWithPersonalAccessToken;
 interface SeamHttpCommonOptions extends ClientOptions, SeamHttpRequestOptions {
+    /**
+     * The Seam API endpoint, e.g., `https://connect.getseam.com`.
+     * Defaults to the SEAM_ENDPOINT or SEAM_API_URL environment variable, if set.
+     */
     endpoint?: string;
 }
+/**
+ * Options for creating a SeamHttp client with `SeamHttp.fromPublishableKey`.
+ */
 export interface SeamHttpFromPublishableKeyOptions extends SeamHttpCommonOptions {
 }
+/**
+ * Options for creating a SeamHttp client that reads its configuration
+ * from the environment, e.g., the SEAM_API_KEY environment variable.
+ */
 export interface SeamHttpOptionsFromEnv extends SeamHttpCommonOptions {
 }
+/**
+ * Options for creating a SeamHttpWithoutWorkspace client that reads
+ * its configuration from the environment,
+ * e.g., the SEAM_PERSONAL_ACCESS_TOKEN environment variable.
+ */
 export interface SeamHttpWithoutWorkspaceOptionsFromEnv extends SeamHttpCommonOptions {
 }
+/**
+ * Options for creating a SeamHttpWithoutWorkspace client from an existing client.
+ */
 export interface SeamHttpWithoutWorkspaceOptionsWithClient extends SeamHttpCommonOptions {
     client: Client;
 }
+/**
+ * Returns true if the options include a client.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the client option
+ * is used with any other option.
+ */
 export declare const isSeamHttpWithoutWorkspaceOptionsWithClient: (options: SeamHttpOptions) => options is SeamHttpWithoutWorkspaceOptionsWithClient;
+/**
+ * Options for creating a SeamHttp client from an existing client.
+ */
 export interface SeamHttpOptionsWithClient extends SeamHttpRequestOptions {
     client: Client;
 }
+/**
+ * Returns true if the options include a client.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the client option
+ * is used with any other option.
+ */
 export declare const isSeamHttpOptionsWithClient: (options: SeamHttpOptions) => options is SeamHttpOptionsWithClient;
+/**
+ * Options for creating a SeamHttp client authenticated with an API key.
+ */
 export interface SeamHttpOptionsWithApiKey extends SeamHttpCommonOptions {
     apiKey: string;
 }
+/**
+ * Returns true if the options include an apiKey.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the apiKey option
+ * is used with another authentication option.
+ */
 export declare const isSeamHttpOptionsWithApiKey: (options: SeamHttpOptions) => options is SeamHttpOptionsWithApiKey;
+/**
+ * Options for creating a SeamHttp client authenticated with a client session token.
+ */
 export interface SeamHttpOptionsWithClientSessionToken extends SeamHttpCommonOptions {
     clientSessionToken: string;
 }
+/**
+ * Returns true if the options include a clientSessionToken.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the clientSessionToken option
+ * is used with another authentication option.
+ */
 export declare const isSeamHttpOptionsWithClientSessionToken: (options: SeamHttpOptions) => options is SeamHttpOptionsWithClientSessionToken;
+/**
+ * Options for creating a SeamHttpWithoutWorkspace client
+ * authenticated with a console session token.
+ */
 export interface SeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken extends SeamHttpCommonOptions {
     consoleSessionToken: string;
 }
+/**
+ * Returns true if the options include a consoleSessionToken.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the consoleSessionToken option
+ * is used with another authentication option.
+ */
 export declare const isSeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken: (options: SeamHttpOptions) => options is SeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken;
+/**
+ * Options for creating a SeamHttp client
+ * authenticated with a console session token and scoped to a workspace.
+ */
 export interface SeamHttpOptionsWithConsoleSessionToken extends SeamHttpCommonOptions {
     consoleSessionToken: string;
     workspaceId: string;
 }
+/**
+ * Returns true if the options include a consoleSessionToken and a workspaceId.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the consoleSessionToken option
+ * is used with another authentication option or without the workspaceId option.
+ */
 export declare const isSeamHttpOptionsWithConsoleSessionToken: (options: SeamHttpOptions) => options is SeamHttpOptionsWithConsoleSessionToken;
+/**
+ * Options for creating a SeamHttpWithoutWorkspace client
+ * authenticated with a personal access token.
+ */
 export interface SeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken extends SeamHttpCommonOptions {
     personalAccessToken: string;
 }
+/**
+ * Returns true if the options include a personalAccessToken.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the personalAccessToken option
+ * is used with another authentication option.
+ */
 export declare const isSeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken: (options: SeamHttpOptions) => options is SeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken;
+/**
+ * Options for creating a SeamHttp client
+ * authenticated with a personal access token and scoped to a workspace.
+ */
 export interface SeamHttpOptionsWithPersonalAccessToken extends SeamHttpCommonOptions {
     personalAccessToken: string;
     workspaceId: string;
 }
+/**
+ * Returns true if the options include a personalAccessToken and a workspaceId.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the personalAccessToken option
+ * is used with another authentication option or without the workspaceId option.
+ */
 export declare const isSeamHttpOptionsWithPersonalAccessToken: (options: SeamHttpOptions) => options is SeamHttpOptionsWithPersonalAccessToken;
+/**
+ * Error thrown when a SeamHttp client is created with invalid options.
+ */
 export declare class SeamHttpInvalidOptionsError extends Error {
     constructor(message: string);
 }
+/**
+ * Error thrown when a SeamHttpWithoutWorkspace client is created with invalid options.
+ */
 export declare class SeamHttpWithoutWorkspaceInvalidOptionsError extends Error {
     constructor(message: string);
 }

package/lib/options.js

@@ -1,5 +1,17 @@
 import { isSeamHttpRequestOption, } from './request-options.js';
+/**
+ * Returns true if the options include a client.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the client option
+ * is used with any other option.
+ */
 export const isSeamHttpWithoutWorkspaceOptionsWithClient = (options) => isSeamHttpOptionsWithClient(options);
+/**
+ * Returns true if the options include a client.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the client option
+ * is used with any other option.
+ */
 export const isSeamHttpOptionsWithClient = (options) => {
     if (!('client' in options))
         return false;
@@ -11,6 +23,12 @@ export const isSeamHttpOptionsWithClient = (options) => {
     }
     return true;
 };
+/**
+ * Returns true if the options include an apiKey.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the apiKey option
+ * is used with another authentication option.
+ */
 export const isSeamHttpOptionsWithApiKey = (options) => {
     if (!('apiKey' in options))
         return false;
@@ -27,6 +45,12 @@ export const isSeamHttpOptionsWithApiKey = (options) => {
     }
     return true;
 };
+/**
+ * Returns true if the options include a clientSessionToken.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the clientSessionToken option
+ * is used with another authentication option.
+ */
 export const isSeamHttpOptionsWithClientSessionToken = (options) => {
     if (!('clientSessionToken' in options))
         return false;
@@ -43,6 +67,12 @@ export const isSeamHttpOptionsWithClientSessionToken = (options) => {
     }
     return true;
 };
+/**
+ * Returns true if the options include a consoleSessionToken.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the consoleSessionToken option
+ * is used with another authentication option.
+ */
 export const isSeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken = (options) => {
     if (!('consoleSessionToken' in options))
         return false;
@@ -59,6 +89,12 @@ export const isSeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken = (options
     }
     return true;
 };
+/**
+ * Returns true if the options include a consoleSessionToken and a workspaceId.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the consoleSessionToken option
+ * is used with another authentication option or without the workspaceId option.
+ */
 export const isSeamHttpOptionsWithConsoleSessionToken = (options) => {
     if (!isSeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken(options)) {
         return false;
@@ -68,6 +104,12 @@ export const isSeamHttpOptionsWithConsoleSessionToken = (options) => {
     }
     return true;
 };
+/**
+ * Returns true if the options include a personalAccessToken.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the personalAccessToken option
+ * is used with another authentication option.
+ */
 export const isSeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken = (options) => {
     if (!('personalAccessToken' in options))
         return false;
@@ -84,6 +126,12 @@ export const isSeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken = (options
     }
     return true;
 };
+/**
+ * Returns true if the options include a personalAccessToken and a workspaceId.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the personalAccessToken option
+ * is used with another authentication option or without the workspaceId option.
+ */
 export const isSeamHttpOptionsWithPersonalAccessToken = (options) => {
     if (!isSeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken(options)) {
         return false;
@@ -93,12 +141,18 @@ export const isSeamHttpOptionsWithPersonalAccessToken = (options) => {
     }
     return true;
 };
+/**
+ * Error thrown when a SeamHttp client is created with invalid options.
+ */
 export class SeamHttpInvalidOptionsError extends Error {
     constructor(message) {
         super(`SeamHttp received invalid options: ${message}`);
         this.name = this.constructor.name;
     }
 }
+/**
+ * Error thrown when a SeamHttpWithoutWorkspace client is created with invalid options.
+ */
 export class SeamHttpWithoutWorkspaceInvalidOptionsError extends Error {
     constructor(message) {
         super(`SeamHttpWithoutWorkspace received invalid options: ${message}`);

package/lib/options.js.map

@@ -1 +1 @@
-{"version":3,"file":"options.js","sourceRoot":"","sources":["../src/lib/options.ts"],"names":[],"mappings":"AACA,OAAO,EACL,uBAAuB,GAExB,MAAM,sBAAsB,CAAA;AAgC7B,MAAM,CAAC,MAAM,2CAA2C,GAAG,CACzD,OAAwB,EAC8B,EAAE,CACxD,2BAA2B,CAAC,OAAO,CAAC,CAAA;AAMtC,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,OAAwB,EACc,EAAE;IACxC,IAAI,CAAC,CAAC,QAAQ,IAAI,OAAO,CAAC;QAAE,OAAO,KAAK,CAAA;IACxC,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI;QAAE,OAAO,KAAK,CAAA;IAExC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAA;IAC/D,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/D,MAAM,IAAI,2BAA2B,CACnC,yEAAyE,IAAI,CAAC,IAAI,CAChF,IAAI,CACL,EAAE,CACJ,CAAA;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAMD,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,OAAwB,EACc,EAAE;IACxC,IAAI,CAAC,CAAC,QAAQ,IAAI,OAAO,CAAC;QAAE,OAAO,KAAK,CAAA;IACxC,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI;QAAE,OAAO,KAAK,CAAA;IAExC,IAAI,oBAAoB,IAAI,OAAO,IAAI,OAAO,CAAC,kBAAkB,IAAI,IAAI,EAAE,CAAC;QAC1E,MAAM,IAAI,2BAA2B,CACnC,qEAAqE,CACtE,CAAA;IACH,CAAC;IAED,IAAI,qBAAqB,IAAI,OAAO,IAAI,OAAO,CAAC,mBAAmB,IAAI,IAAI,EAAE,CAAC;QAC5E,MAAM,IAAI,2BAA2B,CACnC,sEAAsE,CACvE,CAAA;IACH,CAAC;IAED,IAAI,qBAAqB,IAAI,OAAO,IAAI,OAAO,CAAC,mBAAmB,IAAI,IAAI,EAAE,CAAC;QAC5E,MAAM,IAAI,2BAA2B,CACnC,sEAAsE,CACvE,CAAA;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAMD,MAAM,CAAC,MAAM,uCAAuC,GAAG,CACrD,OAAwB,EAC0B,EAAE;IACpD,IAAI,CAAC,CAAC,oBAAoB,IAAI,OAAO,CAAC;QAAE,OAAO,KAAK,CAAA;IACpD,IAAI,OAAO,CAAC,kBAAkB,IAAI,IAAI;QAAE,OAAO,KAAK,CAAA;IAEpD,IAAI,QAAQ,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;QAClD,MAAM,IAAI,2BAA2B,CACnC,qEAAqE,CACtE,CAAA;IACH,CAAC;IAED,IAAI,qBAAqB,IAAI,OAAO,IAAI,OAAO,CAAC,mBAAmB,IAAI,IAAI,EAAE,CAAC;QAC5E,MAAM,IAAI,2BAA2B,CACnC,kFAAkF,CACnF,CAAA;IACH,CAAC;IAED,IAAI,qBAAqB,IAAI,OAAO,IAAI,OAAO,CAAC,mBAAmB,IAAI,IAAI,EAAE,CAAC;QAC5E,MAAM,IAAI,2BAA2B,CACnC,kFAAkF,CACnF,CAAA;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAMD,MAAM,CAAC,MAAM,wDAAwD,GAAG,CACtE,OAAwB,EAC2C,EAAE;IACrE,IAAI,CAAC,CAAC,qBAAqB,IAAI,OAAO,CAAC;QAAE,OAAO,KAAK,CAAA;IACrD,IAAI,OAAO,CAAC,mBAAmB,IAAI,IAAI;QAAE,OAAO,KAAK,CAAA;IAErD,IAAI,QAAQ,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;QAClD,MAAM,IAAI,2BAA2B,CACnC,sEAAsE,CACvE,CAAA;IACH,CAAC;IAED,IAAI,oBAAoB,IAAI,OAAO,IAAI,OAAO,CAAC,kBAAkB,IAAI,IAAI,EAAE,CAAC;QAC1E,MAAM,IAAI,2BAA2B,CACnC,kFAAkF,CACnF,CAAA;IACH,CAAC;IAED,IAAI,qBAAqB,IAAI,OAAO,IAAI,OAAO,CAAC,mBAAmB,IAAI,IAAI,EAAE,CAAC;QAC5E,MAAM,IAAI,2BAA2B,CACnC,mFAAmF,CACpF,CAAA;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAOD,MAAM,CAAC,MAAM,wCAAwC,GAAG,CACtD,OAAwB,EAC2B,EAAE;IACrD,IAAI,CAAC,wDAAwD,CAAC,OAAO,CAAC,EAAE,CAAC;QACvE,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,CAAC,CAAC,aAAa,IAAI,OAAO,CAAC,IAAI,OAAO,CAAC,WAAW,IAAI,IAAI,EAAE,CAAC;QAC/D,MAAM,IAAI,2BAA2B,CACnC,0DAA0D,CAC3D,CAAA;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAMD,MAAM,CAAC,MAAM,wDAAwD,GAAG,CACtE,OAAwB,EAC2C,EAAE;IACrE,IAAI,CAAC,CAAC,qBAAqB,IAAI,OAAO,CAAC;QAAE,OAAO,KAAK,CAAA;IACrD,IAAI,OAAO,CAAC,mBAAmB,IAAI,IAAI;QAAE,OAAO,KAAK,CAAA;IAErD,IAAI,QAAQ,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;QAClD,MAAM,IAAI,2BAA2B,CACnC,sEAAsE,CACvE,CAAA;IACH,CAAC;IAED,IAAI,oBAAoB,IAAI,OAAO,IAAI,OAAO,CAAC,kBAAkB,IAAI,IAAI,EAAE,CAAC;QAC1E,MAAM,IAAI,2BAA2B,CACnC,kFAAkF,CACnF,CAAA;IACH,CAAC;IAED,IAAI,qBAAqB,IAAI,OAAO,IAAI,OAAO,CAAC,mBAAmB,IAAI,IAAI,EAAE,CAAC;QAC5E,MAAM,IAAI,2BAA2B,CACnC,mFAAmF,CACpF,CAAA;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAOD,MAAM,CAAC,MAAM,wCAAwC,GAAG,CACtD,OAAwB,EAC2B,EAAE;IACrD,IAAI,CAAC,wDAAwD,CAAC,OAAO,CAAC,EAAE,CAAC;QACvE,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,CAAC,CAAC,aAAa,IAAI,OAAO,CAAC,IAAI,OAAO,CAAC,WAAW,IAAI,IAAI,EAAE,CAAC;QAC/D,MAAM,IAAI,2BAA2B,CACnC,0DAA0D,CAC3D,CAAA;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAED,MAAM,OAAO,2BAA4B,SAAQ,KAAK;IACpD,YAAY,OAAe;QACzB,KAAK,CAAC,sCAAsC,OAAO,EAAE,CAAC,CAAA;QACtD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;IACnC,CAAC;CACF;AAED,MAAM,OAAO,2CAA4C,SAAQ,KAAK;IACpE,YAAY,OAAe;QACzB,KAAK,CAAC,sDAAsD,OAAO,EAAE,CAAC,CAAA;QACtE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;IACnC,CAAC;CACF"}
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../src/lib/options.ts"],"names":[],"mappings":"AACA,OAAO,EACL,uBAAuB,GAExB,MAAM,sBAAsB,CAAA;AA0D7B;;;;;GAKG;AACH,MAAM,CAAC,MAAM,2CAA2C,GAAG,CACzD,OAAwB,EAC8B,EAAE,CACxD,2BAA2B,CAAC,OAAO,CAAC,CAAA;AAStC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,OAAwB,EACc,EAAE;IACxC,IAAI,CAAC,CAAC,QAAQ,IAAI,OAAO,CAAC;QAAE,OAAO,KAAK,CAAA;IACxC,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI;QAAE,OAAO,KAAK,CAAA;IAExC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAA;IAC/D,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/D,MAAM,IAAI,2BAA2B,CACnC,yEAAyE,IAAI,CAAC,IAAI,CAChF,IAAI,CACL,EAAE,CACJ,CAAA;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AASD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,OAAwB,EACc,EAAE;IACxC,IAAI,CAAC,CAAC,QAAQ,IAAI,OAAO,CAAC;QAAE,OAAO,KAAK,CAAA;IACxC,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI;QAAE,OAAO,KAAK,CAAA;IAExC,IAAI,oBAAoB,IAAI,OAAO,IAAI,OAAO,CAAC,kBAAkB,IAAI,IAAI,EAAE,CAAC;QAC1E,MAAM,IAAI,2BAA2B,CACnC,qEAAqE,CACtE,CAAA;IACH,CAAC;IAED,IAAI,qBAAqB,IAAI,OAAO,IAAI,OAAO,CAAC,mBAAmB,IAAI,IAAI,EAAE,CAAC;QAC5E,MAAM,IAAI,2BAA2B,CACnC,sEAAsE,CACvE,CAAA;IACH,CAAC;IAED,IAAI,qBAAqB,IAAI,OAAO,IAAI,OAAO,CAAC,mBAAmB,IAAI,IAAI,EAAE,CAAC;QAC5E,MAAM,IAAI,2BAA2B,CACnC,sEAAsE,CACvE,CAAA;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AASD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uCAAuC,GAAG,CACrD,OAAwB,EAC0B,EAAE;IACpD,IAAI,CAAC,CAAC,oBAAoB,IAAI,OAAO,CAAC;QAAE,OAAO,KAAK,CAAA;IACpD,IAAI,OAAO,CAAC,kBAAkB,IAAI,IAAI;QAAE,OAAO,KAAK,CAAA;IAEpD,IAAI,QAAQ,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;QAClD,MAAM,IAAI,2BAA2B,CACnC,qEAAqE,CACtE,CAAA;IACH,CAAC;IAED,IAAI,qBAAqB,IAAI,OAAO,IAAI,OAAO,CAAC,mBAAmB,IAAI,IAAI,EAAE,CAAC;QAC5E,MAAM,IAAI,2BAA2B,CACnC,kFAAkF,CACnF,CAAA;IACH,CAAC;IAED,IAAI,qBAAqB,IAAI,OAAO,IAAI,OAAO,CAAC,mBAAmB,IAAI,IAAI,EAAE,CAAC;QAC5E,MAAM,IAAI,2BAA2B,CACnC,kFAAkF,CACnF,CAAA;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAUD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,wDAAwD,GAAG,CACtE,OAAwB,EAC2C,EAAE;IACrE,IAAI,CAAC,CAAC,qBAAqB,IAAI,OAAO,CAAC;QAAE,OAAO,KAAK,CAAA;IACrD,IAAI,OAAO,CAAC,mBAAmB,IAAI,IAAI;QAAE,OAAO,KAAK,CAAA;IAErD,IAAI,QAAQ,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;QAClD,MAAM,IAAI,2BAA2B,CACnC,sEAAsE,CACvE,CAAA;IACH,CAAC;IAED,IAAI,oBAAoB,IAAI,OAAO,IAAI,OAAO,CAAC,kBAAkB,IAAI,IAAI,EAAE,CAAC;QAC1E,MAAM,IAAI,2BAA2B,CACnC,kFAAkF,CACnF,CAAA;IACH,CAAC;IAED,IAAI,qBAAqB,IAAI,OAAO,IAAI,OAAO,CAAC,mBAAmB,IAAI,IAAI,EAAE,CAAC;QAC5E,MAAM,IAAI,2BAA2B,CACnC,mFAAmF,CACpF,CAAA;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAWD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,wCAAwC,GAAG,CACtD,OAAwB,EAC2B,EAAE;IACrD,IAAI,CAAC,wDAAwD,CAAC,OAAO,CAAC,EAAE,CAAC;QACvE,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,CAAC,CAAC,aAAa,IAAI,OAAO,CAAC,IAAI,OAAO,CAAC,WAAW,IAAI,IAAI,EAAE,CAAC;QAC/D,MAAM,IAAI,2BAA2B,CACnC,0DAA0D,CAC3D,CAAA;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAUD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,wDAAwD,GAAG,CACtE,OAAwB,EAC2C,EAAE;IACrE,IAAI,CAAC,CAAC,qBAAqB,IAAI,OAAO,CAAC;QAAE,OAAO,KAAK,CAAA;IACrD,IAAI,OAAO,CAAC,mBAAmB,IAAI,IAAI;QAAE,OAAO,KAAK,CAAA;IAErD,IAAI,QAAQ,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;QAClD,MAAM,IAAI,2BAA2B,CACnC,sEAAsE,CACvE,CAAA;IACH,CAAC;IAED,IAAI,oBAAoB,IAAI,OAAO,IAAI,OAAO,CAAC,kBAAkB,IAAI,IAAI,EAAE,CAAC;QAC1E,MAAM,IAAI,2BAA2B,CACnC,kFAAkF,CACnF,CAAA;IACH,CAAC;IAED,IAAI,qBAAqB,IAAI,OAAO,IAAI,OAAO,CAAC,mBAAmB,IAAI,IAAI,EAAE,CAAC;QAC5E,MAAM,IAAI,2BAA2B,CACnC,mFAAmF,CACpF,CAAA;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAWD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,wCAAwC,GAAG,CACtD,OAAwB,EAC2B,EAAE;IACrD,IAAI,CAAC,wDAAwD,CAAC,OAAO,CAAC,EAAE,CAAC;QACvE,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,CAAC,CAAC,aAAa,IAAI,OAAO,CAAC,IAAI,OAAO,CAAC,WAAW,IAAI,IAAI,EAAE,CAAC;QAC/D,MAAM,IAAI,2BAA2B,CACnC,0DAA0D,CAC3D,CAAA;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,OAAO,2BAA4B,SAAQ,KAAK;IACpD,YAAY,OAAe;QACzB,KAAK,CAAC,sCAAsC,OAAO,EAAE,CAAC,CAAA;QACtD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;IACnC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,2CAA4C,SAAQ,KAAK;IACpE,YAAY,OAAe;QACzB,KAAK,CAAC,sDAAsD,OAAO,EAAE,CAAC,CAAA;QACtE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;IACnC,CAAC;CACF"}

package/lib/request-options.d.ts

@@ -1,5 +1,18 @@
 import type { ResolveActionAttemptOptions } from './resolve-action-attempt.js';
+/**
+ * Options for how a {@link SeamHttpRequest} is executed.
+ */
 export interface SeamHttpRequestOptions {
+    /**
+     * Controls whether to wait for the action attempt to resolve
+     * when a request returns an action attempt.
+     * Pass a boolean to toggle waiting,
+     * or {@link ResolveActionAttemptOptions} to also configure
+     * the timeout and polling interval.
+     */
     waitForActionAttempt?: boolean | ResolveActionAttemptOptions;
 }
+/**
+ * Returns true if the key is the name of a {@link SeamHttpRequestOptions} property.
+ */
 export declare const isSeamHttpRequestOption: (key: string) => key is keyof SeamHttpRequestOptions;

package/lib/request-options.js

@@ -1,3 +1,6 @@
+/**
+ * Returns true if the key is the name of a {@link SeamHttpRequestOptions} property.
+ */
 export const isSeamHttpRequestOption = (key) => {
     const keys = {
         waitForActionAttempt: true,

package/lib/request-options.js.map

@@ -1 +1 @@
-{"version":3,"file":"request-options.js","sourceRoot":"","sources":["../src/lib/request-options.ts"],"names":[],"mappings":"AAMA,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,GAAW,EAC0B,EAAE;IACvC,MAAM,IAAI,GAA+C;QACvD,oBAAoB,EAAE,IAAI;KAC3B,CAAA;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;AACxC,CAAC,CAAA"}
+{"version":3,"file":"request-options.js","sourceRoot":"","sources":["../src/lib/request-options.ts"],"names":[],"mappings":"AAgBA;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,GAAW,EAC0B,EAAE;IACvC,MAAM,IAAI,GAA+C;QACvD,oBAAoB,EAAE,IAAI;KAC3B,CAAA;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;AACxC,CAAC,CAAA"}

package/lib/resolve-action-attempt.d.ts

@@ -1,31 +1,78 @@
 import type { ActionAttempt } from './resources/action-attempt.js';
+/**
+ * Client used to poll action attempts by id, e.g., `SeamHttpActionAttempts`.
+ */
 export interface ActionAttemptsClient {
     get(parameters: {
         action_attempt_id: string;
     }): PromiseLike<ActionAttempt>;
 }
+/**
+ * Options for waiting until an action attempt resolves.
+ */
 export interface ResolveActionAttemptOptions {
+    /**
+     * Maximum time in milliseconds to wait for the action attempt to resolve.
+     */
     timeout?: number;
+    /**
+     * Time in milliseconds to wait between polls of the action attempt.
+     */
     pollingInterval?: number;
 }
+/**
+ * Polls a pending action attempt until it succeeds, fails, or times out.
+ *
+ * @returns The succeeded action attempt.
+ * @throws {@link SeamActionAttemptFailedError} if the action attempt fails.
+ * @throws {@link SeamActionAttemptTimeoutError} if the action attempt
+ * does not resolve within the timeout.
+ */
 export declare const resolveActionAttempt: <T extends ActionAttempt>(actionAttempt: T, actionAttempts: ActionAttemptsClient, { timeout, pollingInterval }: ResolveActionAttemptOptions) => Promise<SucceededActionAttempt<T>>;
+/**
+ * Returns true if the error is a {@link SeamActionAttemptError}.
+ */
 export declare const isSeamActionAttemptError: <T extends ActionAttempt>(error: unknown) => error is SeamActionAttemptError<T>;
+/**
+ * Error relating to an action attempt.
+ */
 export declare class SeamActionAttemptError<T extends ActionAttempt> extends Error {
     actionAttempt: T;
     constructor(message: string, actionAttempt: T);
 }
+/**
+ * Returns true if the error is a {@link SeamActionAttemptFailedError}.
+ */
 export declare const isSeamActionAttemptFailedError: <T extends ActionAttempt>(error: unknown) => error is SeamActionAttemptFailedError<T>;
+/**
+ * Error thrown when an action attempt fails.
+ */
 export declare class SeamActionAttemptFailedError<T extends ActionAttempt> extends SeamActionAttemptError<T> {
+    /**
+     * Error type returned by the Seam API for the failed action attempt.
+     */
     code: string;
     constructor(actionAttempt: FailedActionAttempt<T>);
 }
+/**
+ * Returns true if the error is a {@link SeamActionAttemptTimeoutError}.
+ */
 export declare const isSeamActionAttemptTimeoutError: <T extends ActionAttempt>(error: unknown) => error is SeamActionAttemptTimeoutError<T>;
+/**
+ * Error thrown when an action attempt does not resolve within the timeout.
+ */
 export declare class SeamActionAttemptTimeoutError<T extends ActionAttempt> extends SeamActionAttemptError<T> {
     constructor(actionAttempt: T, timeout: number);
 }
+/**
+ * An action attempt that has succeeded.
+ */
 export type SucceededActionAttempt<T extends ActionAttempt> = T & {
     status: 'success';
 };
+/**
+ * An action attempt that has failed.
+ */
 export type FailedActionAttempt<T extends ActionAttempt> = T & {
     status: 'error';
 };

package/lib/resolve-action-attempt.js

@@ -1,3 +1,11 @@
+/**
+ * Polls a pending action attempt until it succeeds, fails, or times out.
+ *
+ * @returns The succeeded action attempt.
+ * @throws {@link SeamActionAttemptFailedError} if the action attempt fails.
+ * @throws {@link SeamActionAttemptTimeoutError} if the action attempt
+ * does not resolve within the timeout.
+ */
 export const resolveActionAttempt = async (actionAttempt, actionAttempts, { timeout = 10_000, pollingInterval = 1_000 }) => {
     let timeoutRef;
     const timeoutPromise = new Promise((_resolve, reject) => {
@@ -29,9 +37,15 @@ const pollActionAttempt = async (actionAttempt, actionAttempts, options) => {
     });
     return await pollActionAttempt(nextActionAttempt, actionAttempts, options);
 };
+/**
+ * Returns true if the error is a {@link SeamActionAttemptError}.
+ */
 export const isSeamActionAttemptError = (error) => {
     return error instanceof SeamActionAttemptError;
 };
+/**
+ * Error relating to an action attempt.
+ */
 export class SeamActionAttemptError extends Error {
     actionAttempt;
     constructor(message, actionAttempt) {
@@ -40,10 +54,19 @@ export class SeamActionAttemptError extends Error {
         this.actionAttempt = actionAttempt;
     }
 }
+/**
+ * Returns true if the error is a {@link SeamActionAttemptFailedError}.
+ */
 export const isSeamActionAttemptFailedError = (error) => {
     return error instanceof SeamActionAttemptFailedError;
 };
+/**
+ * Error thrown when an action attempt fails.
+ */
 export class SeamActionAttemptFailedError extends SeamActionAttemptError {
+    /**
+     * Error type returned by the Seam API for the failed action attempt.
+     */
     code;
     constructor(actionAttempt) {
         super(actionAttempt.error.message, actionAttempt);
@@ -51,9 +74,15 @@ export class SeamActionAttemptFailedError extends SeamActionAttemptError {
         this.code = actionAttempt.error.type;
     }
 }
+/**
+ * Returns true if the error is a {@link SeamActionAttemptTimeoutError}.
+ */
 export const isSeamActionAttemptTimeoutError = (error) => {
     return error instanceof SeamActionAttemptTimeoutError;
 };
+/**
+ * Error thrown when an action attempt does not resolve within the timeout.
+ */
 export class SeamActionAttemptTimeoutError extends SeamActionAttemptError {
     constructor(actionAttempt, timeout) {
         super(`Timed out waiting for action action attempt after ${timeout}ms`, actionAttempt);

package/lib/resolve-action-attempt.js.map

@@ -1 +1 @@
-{"version":3,"file":"resolve-action-attempt.js","sourceRoot":"","sources":["../src/lib/resolve-action-attempt.ts"],"names":[],"mappings":"AAWA,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,EACvC,aAAgB,EAChB,cAAoC,EACpC,EAAE,OAAO,GAAG,MAAM,EAAE,eAAe,GAAG,KAAK,EAA+B,EACtC,EAAE;IACtC,IAAI,UAAU,CAAA;IACd,MAAM,cAAc,GAAG,IAAI,OAAO,CAChC,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE;QACnB,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC,GAAG,EAAE;YACtC,MAAM,CAAC,IAAI,6BAA6B,CAAI,aAAa,EAAE,OAAO,CAAC,CAAC,CAAA;QACtE,CAAC,EAAE,OAAO,CAAC,CAAA;IACb,CAAC,CACF,CAAA;IAED,IAAI,CAAC;QACH,OAAO,MAAM,OAAO,CAAC,IAAI,CAAC;YACxB,iBAAiB,CAAI,aAAa,EAAE,cAAc,EAAE,EAAE,eAAe,EAAE,CAAC;YACxE,cAAc;SACf,CAAC,CAAA;IACJ,CAAC;YAAS,CAAC;QACT,IAAI,UAAU,IAAI,IAAI;YAAE,UAAU,CAAC,YAAY,CAAC,UAAU,CAAC,CAAA;IAC7D,CAAC;AACH,CAAC,CAAA;AAED,MAAM,iBAAiB,GAAG,KAAK,EAC7B,aAAgB,EAChB,cAAoC,EACpC,OAA6D,EACzB,EAAE;IACtC,IAAI,yBAAyB,CAAC,aAAa,CAAC,EAAE,CAAC;QAC7C,OAAO,aAAa,CAAA;IACtB,CAAC;IAED,IAAI,qBAAqB,CAAC,aAAa,CAAC,EAAE,CAAC;QACzC,MAAM,IAAI,4BAA4B,CAAC,aAAa,CAAC,CAAA;IACvD,CAAC;IAED,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC,CAAA;IAE5E,MAAM,iBAAiB,GAAG,MAAM,cAAc,CAAC,GAAG,CAAC;QACjD,iBAAiB,EAAE,aAAa,CAAC,iBAAiB;KACnD,CAAC,CAAA;IAEF,OAAO,MAAM,iBAAiB,CAC5B,iBAAiC,EACjC,cAAc,EACd,OAAO,CACR,CAAA;AACH,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,KAAc,EACsB,EAAE;IACtC,OAAO,KAAK,YAAY,sBAAsB,CAAA;AAChD,CAAC,CAAA;AAED,MAAM,OAAO,sBAAgD,SAAQ,KAAK;IACxE,aAAa,CAAG;IAEhB,YAAY,OAAe,EAAE,aAAgB;QAC3C,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;QACjC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;IACpC,CAAC;CACF;AAED,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAC5C,KAAc,EAC4B,EAAE;IAC5C,OAAO,KAAK,YAAY,4BAA4B,CAAA;AACtD,CAAC,CAAA;AAED,MAAM,OAAO,4BAEX,SAAQ,sBAAyB;IACjC,IAAI,CAAQ;IAEZ,YAAY,aAAqC;QAC/C,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,OAAO,EAAE,aAAa,CAAC,CAAA;QACjD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;QACjC,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,CAAA;IACtC,CAAC;CACF;AAED,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAC7C,KAAc,EAC6B,EAAE;IAC7C,OAAO,KAAK,YAAY,6BAA6B,CAAA;AACvD,CAAC,CAAA;AAED,MAAM,OAAO,6BAEX,SAAQ,sBAAyB;IACjC,YAAY,aAAgB,EAAE,OAAe;QAC3C,KAAK,CACH,qDAAqD,OAAO,IAAI,EAChE,aAAa,CACd,CAAA;QACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;IACnC,CAAC;CACF;AAED,MAAM,yBAAyB,GAAG,CAChC,aAAgB,EAC4B,EAAE,CAC9C,aAAa,CAAC,MAAM,KAAK,SAAS,CAAA;AAEpC,MAAM,qBAAqB,GAAG,CAC5B,aAAgB,EACyB,EAAE,CAAC,aAAa,CAAC,MAAM,KAAK,OAAO,CAAA"}
+{"version":3,"file":"resolve-action-attempt.js","sourceRoot":"","sources":["../src/lib/resolve-action-attempt.ts"],"names":[],"mappings":"AAwBA;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,EACvC,aAAgB,EAChB,cAAoC,EACpC,EAAE,OAAO,GAAG,MAAM,EAAE,eAAe,GAAG,KAAK,EAA+B,EACtC,EAAE;IACtC,IAAI,UAAU,CAAA;IACd,MAAM,cAAc,GAAG,IAAI,OAAO,CAChC,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE;QACnB,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC,GAAG,EAAE;YACtC,MAAM,CAAC,IAAI,6BAA6B,CAAI,aAAa,EAAE,OAAO,CAAC,CAAC,CAAA;QACtE,CAAC,EAAE,OAAO,CAAC,CAAA;IACb,CAAC,CACF,CAAA;IAED,IAAI,CAAC;QACH,OAAO,MAAM,OAAO,CAAC,IAAI,CAAC;YACxB,iBAAiB,CAAI,aAAa,EAAE,cAAc,EAAE,EAAE,eAAe,EAAE,CAAC;YACxE,cAAc;SACf,CAAC,CAAA;IACJ,CAAC;YAAS,CAAC;QACT,IAAI,UAAU,IAAI,IAAI;YAAE,UAAU,CAAC,YAAY,CAAC,UAAU,CAAC,CAAA;IAC7D,CAAC;AACH,CAAC,CAAA;AAED,MAAM,iBAAiB,GAAG,KAAK,EAC7B,aAAgB,EAChB,cAAoC,EACpC,OAA6D,EACzB,EAAE;IACtC,IAAI,yBAAyB,CAAC,aAAa,CAAC,EAAE,CAAC;QAC7C,OAAO,aAAa,CAAA;IACtB,CAAC;IAED,IAAI,qBAAqB,CAAC,aAAa,CAAC,EAAE,CAAC;QACzC,MAAM,IAAI,4BAA4B,CAAC,aAAa,CAAC,CAAA;IACvD,CAAC;IAED,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC,CAAA;IAE5E,MAAM,iBAAiB,GAAG,MAAM,cAAc,CAAC,GAAG,CAAC;QACjD,iBAAiB,EAAE,aAAa,CAAC,iBAAiB;KACnD,CAAC,CAAA;IAEF,OAAO,MAAM,iBAAiB,CAC5B,iBAAiC,EACjC,cAAc,EACd,OAAO,CACR,CAAA;AACH,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,KAAc,EACsB,EAAE;IACtC,OAAO,KAAK,YAAY,sBAAsB,CAAA;AAChD,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,OAAO,sBAAgD,SAAQ,KAAK;IACxE,aAAa,CAAG;IAEhB,YAAY,OAAe,EAAE,aAAgB;QAC3C,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;QACjC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;IACpC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAC5C,KAAc,EAC4B,EAAE;IAC5C,OAAO,KAAK,YAAY,4BAA4B,CAAA;AACtD,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,OAAO,4BAEX,SAAQ,sBAAyB;IACjC;;OAEG;IACH,IAAI,CAAQ;IAEZ,YAAY,aAAqC;QAC/C,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,OAAO,EAAE,aAAa,CAAC,CAAA;QACjD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;QACjC,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,CAAA;IACtC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAC7C,KAAc,EAC6B,EAAE;IAC7C,OAAO,KAAK,YAAY,6BAA6B,CAAA;AACvD,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,OAAO,6BAEX,SAAQ,sBAAyB;IACjC,YAAY,aAAgB,EAAE,OAAe;QAC3C,KAAK,CACH,qDAAqD,OAAO,IAAI,EAChE,aAAa,CACd,CAAA;QACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;IACnC,CAAC;CACF;AAED,MAAM,yBAAyB,GAAG,CAChC,aAAgB,EAC4B,EAAE,CAC9C,aAAa,CAAC,MAAM,KAAK,SAAS,CAAA;AAEpC,MAAM,qBAAqB,GAAG,CAC5B,aAAgB,EACyB,EAAE,CAAC,aAAa,CAAC,MAAM,KAAK,OAAO,CAAA"}

package/lib/resources/device.d.ts

@@ -1492,18 +1492,6 @@ export type Device = {
              * Set to true when the device does not support the /dual-setpoints API endpoint.
              */
             dual_setpoints_not_supported?: boolean | undefined;
-            /**
-             * Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error.
-             */
-            enforced_cooling_setpoint_range_celsius?: Array<number> | undefined;
-            /**
-             * Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error.
-             */
-            enforced_heating_setpoint_range_celsius?: Array<number> | undefined;
-            /**
-             * Legacy combined enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. Read as a fallback for the per-mode ranges below; no longer written.
-             */
-            enforced_setpoint_range_celsius?: Array<number> | undefined;
             /**
              * Product type for a Sensi device.
              */

package/lib/seam-http-error.d.ts

@@ -1,22 +1,56 @@
 import type { ApiError } from './api-error-types.js';
+/**
+ * Error thrown when the Seam API returns an error response.
+ */
 export declare class SeamHttpApiError extends Error {
+    /**
+     * Error type returned by the Seam API, e.g., `invalid_input`.
+     */
     code: string;
     statusCode: number;
+    /**
+     * Unique identifier of the request that failed.
+     * Provide this to Seam support when reporting an issue.
+     */
     requestId: string;
+    /**
+     * Additional error-specific data returned by the Seam API, if any.
+     */
     data?: unknown;
     constructor(error: ApiError, statusCode: number, requestId: string);
 }
+/**
+ * Returns true if the error is a {@link SeamHttpApiError}.
+ */
 export declare const isSeamHttpApiError: (error: unknown) => error is SeamHttpApiError;
+/**
+ * Error thrown when the Seam API returns a 401 Unauthorized error response.
+ */
 export declare class SeamHttpUnauthorizedError extends SeamHttpApiError {
     code: 'unauthorized';
     statusCode: 401;
     constructor(requestId: string);
 }
+/**
+ * Returns true if the error is a {@link SeamHttpUnauthorizedError}.
+ */
 export declare const isSeamHttpUnauthorizedError: (error: unknown) => error is SeamHttpUnauthorizedError;
+/**
+ * Error thrown when the Seam API returns an `invalid_input` error response.
+ */
 export declare class SeamHttpInvalidInputError extends SeamHttpApiError {
     #private;
     code: 'invalid_input';
     constructor(error: ApiError, statusCode: number, requestId: string);
+    /**
+     * Returns the validation error messages for the request parameter,
+     * or an empty array if the parameter had no validation errors.
+     *
+     * @param paramName - Name of the request parameter.
+     */
     getValidationErrorMessages(paramName: string): string[];
 }
+/**
+ * Returns true if the error is a {@link SeamHttpInvalidInputError}.
+ */
 export declare const isSeamHttpInvalidInputError: (error: unknown) => error is SeamHttpInvalidInputError;