Documentation Index
Fetch the complete documentation index at: https://terminal49.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
client
Classes
| Class | Description |
|---|
| AuthenticationError | Thrown when the API token is invalid or missing (HTTP 401). |
| AuthorizationError | Thrown when the API token is valid but lacks permission for the request (HTTP 403). |
| FeatureNotEnabledError | Thrown when the requested feature requires a plan upgrade (HTTP 403). |
| NotFoundError | Thrown when the requested resource does not exist (HTTP 404). |
| RateLimitError | Thrown when the API rate limit has been exceeded (HTTP 429). The SDK retries automatically. |
| Terminal49Client | Server-side TypeScript client for the Terminal49 JSON:API. |
| Terminal49Error | Base error for all Terminal49 API errors. Subclassed by status-specific errors. |
| UpstreamError | Thrown when the carrier or terminal upstream API is unavailable (HTTP 5xx). |
| ValidationError | Thrown when the request payload fails server-side validation (HTTP 400/422). |
Interfaces
| Interface | Description |
|---|
| CreateTrackingRequestFromInferOptions | Options for creating a tracking request after inferring carrier and number type. |
| Terminal49ClientConfig | Configuration for Terminal49Client. |
Type Aliases
| Type Alias | Description |
|---|
| TrackingRequestType | Supported tracking request number types. |
