client
Classes
| Class | Description |
|---|---|
| AuthenticationError | Thrown on HTTP 401: the API token is invalid or missing, or the API denied the action for this token. |
| 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). |
| NetworkError | Thrown when a transport-level failure occurs before a response is received — a DNS failure, a refused/reset connection, or an otherwise failed fetch. Has no HTTP status because no response was produced. |
| 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. |
| TimeoutError | Thrown when a request exceeds the configured request timeout and is aborted by the SDK. Has no HTTP status because no response was produced. |
| UpstreamError | Thrown when the carrier or terminal upstream API is unavailable (HTTP 5xx). |
| ValidationError | Thrown for invalid SDK filter inputs or server validation failures (HTTP 400/422). |
Interfaces
| Interface | Description |
|---|---|
| CustomFieldDefinitionListFilters | Filters accepted by customFieldDefinitions.list. |
| CustomFieldDefinitionListOptions | Options for customFieldDefinitions.list. |
| CustomFieldListFilters | Filters accepted by customFields.list. |
| Terminal49ClientConfig | Configuration for Terminal49Client. |
| TriggerWebhookParams | Parameters for Terminal49Client.triggerWebhook. |
| VesselFuturePositionsParams | Parameters for Terminal49Client.getVesselFuturePositions. |
| VesselFuturePositionsWithCoordsParams | Parameters for Terminal49Client.getVesselFuturePositionsWithCoords. |
| WebhookNotificationGetOptions | Options for Terminal49Client.getWebhookNotification. |
| WebhookNotificationListOptions | Options for Terminal49Client.listWebhookNotifications. |
Type Aliases
| Type Alias | Description |
|---|---|
| PartyAttributes | Party attributes for parties.create and parties.update. |
| WebhookEvent | A webhook event name accepted by webhookNotifications.examples. |