Errors and helpers

SDK Reference

Errors and helpers

Exceptions, response wrappers and utility classes for each SDK.

JavaScript / TypeScriptPythonPHP

class

ApiError

Normalized HTTP, validation, rate-limit and network error.

new ApiError(message, options)

class

ProxyRequestError

Base SDK error.

class

PaginationError

Pagination contract error.

class

InvalidSignatureError

Webhook signature verification error.

types

Client options and response types

Public ClientOptions, ClientCommonOptions, RawRequestOptions, RequestControls and ApiResponse types.

ClientOptionsRequestControlsApiResponse<Data>

function

paginate

Iterates all pages returned by a paginated resource method.

paginate(fetchPage, options?): AsyncGenerator<Item>

class

WebhookVerifier

Verifies signed ProxyRequest webhook payloads.

WebhookVerifier.verify(rawBody, signature, secret)WebhookVerifier.verifyOrThrow(rawBody, signature, secret)

class

FileDownload

Binary download with filename and content type metadata.

arrayBuffer()blob()text()

class

ApiError

Normalized API and network error.

class

ProxyRequestError

Base SDK error.

class

PaginationError

Pagination contract error.

class

InvalidSignatureError

Webhook signature verification error.

class

ApiResponse

Decoded data with HTTP response metadata.

class

WebhookVerifier

Verifies signed ProxyRequest webhooks.

verify()verify_or_raise()decode_verified_json()

class

FileDownload

Binary download with filename and content type metadata.

FileDownload.from_response()save(path, *, overwrite=False)

sentinel

UNSET and Unset

Distinguishes an omitted optional value from an explicit null value.

UNSETUnset

class

ApiException

Normalized API and transport exception with response metadata.

class

InvalidSignatureException

Webhook signature verification error.

class

ClientBuilder

Immutable fluent client configuration builder.

withApiKey()withBearerToken()withBaseUri()withLanguage()withTimeout()withHttpClient()withIdempotency()build()

class

Configuration

Low-level generated host, authentication and user-agent configuration.

class

ApiResponse

Decoded data with HTTP response metadata.

etag()idempotencyReplayed()

class

Paginator

Lazy iterator over paginated endpoints.

getIterator(): Traversable

class

WebhookVerifier

Verifies signed ProxyRequest webhooks.

verify()verifyOrFail()decodeVerifiedJson()

class

FileDownload

Binary download with filename and content type metadata.

size()contents()saveTo($path)