@seamapi/http - v2.18.0
    Preparing search index...

    Interface SeamHttpOptionsWithApiKey

    Options for creating a SeamHttp client authenticated with an API key.

    interface SeamHttpOptionsWithApiKey {
        apiKey: string;
        axiosOptions?: AxiosRequestConfig<any, any>;
        axiosRetryOptions?: IAxiosRetryConfig;
        endpoint?: string;
        timeout?: number;
        waitForActionAttempt?: boolean | ResolveActionAttemptOptions;
    }

    Hierarchy

    • SeamHttpCommonOptions
      • SeamHttpOptionsWithApiKey
    Index
    apiKey axiosOptions? axiosRetryOptions? endpoint? timeout? waitForActionAttempt?
    apiKey: string
    axiosOptions?: AxiosRequestConfig<any, any>

    Options passed to the underlying Axios client.

    axiosRetryOptions?: IAxiosRetryConfig

    Options passed to axios-retry, which retries idempotent requests that fail because of a transport error, timeout, or HTTP 429 response.

    endpoint?: string

    The Seam API endpoint, e.g., https://connect.getseam.com. Defaults to the SEAM_ENDPOINT or SEAM_API_URL environment variable, if set.

    timeout?: number

    Request timeout in milliseconds, applied per attempt. Set to 0 to disable the timeout. Defaults to 30 seconds.

    waitForActionAttempt?: boolean | ResolveActionAttemptOptions

    Controls whether to wait for the action attempt to resolve when a request returns an action attempt. Pass a boolean to toggle waiting, or ResolveActionAttemptOptions to also configure the timeout and polling interval.

    Settings
    Member Visibility

    On This Page
    Properties