Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/sdk/reference/client/classes/AuthenticationError.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Class: AuthenticationError"
title: "AuthenticationError class reference"
description: "Reference for AuthenticationError, thrown by the Terminal49 SDK when the API token is missing or invalid and the request returns HTTP 401."
---

# Class: AuthenticationError
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/reference/client/classes/AuthorizationError.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Class: AuthorizationError"
title: "AuthorizationError class reference"
description: "Reference for AuthorizationError, thrown by the Terminal49 SDK when the API token lacks permission for a request and the response is HTTP 403."
---

# Class: AuthorizationError
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/reference/client/classes/FeatureNotEnabledError.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Class: FeatureNotEnabledError"
title: "FeatureNotEnabledError class reference"
description: "Reference for FeatureNotEnabledError, thrown by the Terminal49 SDK when the requested feature requires a plan upgrade and returns HTTP 403."
---

# Class: FeatureNotEnabledError
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/reference/client/classes/NotFoundError.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Class: NotFoundError"
title: "NotFoundError class reference"
description: "Reference for NotFoundError, thrown by the Terminal49 SDK when the requested resource does not exist and the API response is HTTP 404."
---

# Class: NotFoundError
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/reference/client/classes/RateLimitError.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Class: RateLimitError"
title: "RateLimitError class reference"
description: "Reference for RateLimitError, thrown by the Terminal49 SDK after exhausting automatic retries when the API rate limit returns HTTP 429."
---

# Class: RateLimitError
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/reference/client/classes/Terminal49Client.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Class: Terminal49Client"
title: "Terminal49Client class reference"
description: "API reference for Terminal49Client, the main entry point for the Node.js SDK to create tracking requests and fetch shipments and containers."
---

# Class: Terminal49Client
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/reference/client/classes/Terminal49Error.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Class: Terminal49Error"
title: "Terminal49Error base class reference"
description: "Reference for Terminal49Error, the base class extended by every typed error the Terminal49 TypeScript SDK throws for API failures."
---

# Class: Terminal49Error
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/reference/client/classes/UpstreamError.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Class: UpstreamError"
title: "UpstreamError class reference"
description: "Reference for UpstreamError, thrown by the Terminal49 SDK when a carrier or terminal upstream API is unavailable and returns an HTTP 5xx status."
---

# Class: UpstreamError
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/reference/client/classes/ValidationError.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Class: ValidationError"
title: "ValidationError class reference"
description: "Reference for ValidationError, thrown by the Terminal49 SDK when the request payload fails server-side validation with HTTP 400 or 422."
---

# Class: ValidationError
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/reference/client/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Client Module"
title: "Client module reference"
description: "API reference for the Terminal49 SDK client module: Terminal49Client, configuration interface, and the typed error classes thrown by the SDK."
---

# client
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Class: AuthInterceptor"
title: "AuthInterceptor class reference"
description: "Reference for AuthInterceptor, the SDK request interceptor that attaches the bearer token authorization header to every outbound API request."
---

# Class: AuthInterceptor
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Class: ErrorMappingInterceptor"
title: "ErrorMappingInterceptor class reference"
description: "Reference for ErrorMappingInterceptor, the SDK interceptor that converts API error responses into typed Terminal49Error subclasses on rejection."
---

# Class: ErrorMappingInterceptor
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Class: RetryInterceptor"
title: "RetryInterceptor class reference"
description: "Reference for RetryInterceptor, the SDK interceptor that retries failed requests with exponential backoff on rate limit and transient errors."
---

# Class: RetryInterceptor
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/reference/client/interceptors/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "client/interceptors"
title: "Client interceptors reference"
description: "Reference for SDK interceptors that wrap HTTP requests: authentication header injection, automatic retries, and error response mapping."
---

# client/interceptors
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: Interceptor"
title: "Interceptor type alias reference"
description: "Reference for the Interceptor type alias used by the Terminal49 SDK to compose request and response middleware around HTTP transport calls."
---

# Type Alias: Interceptor
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: Terminal49ClientConfig"
title: "Terminal49ClientConfig interface reference"
description: "Reference for Terminal49ClientConfig, the configuration object accepted by Terminal49Client, including API token, base URL, and retry settings."
---

# Interface: Terminal49ClientConfig
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/reference/client/managers/classes/BaseManager.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Class: BaseManager"
title: "BaseManager class reference"
description: "Reference for BaseManager, the shared parent class for SDK resource managers that handles transport, response mapping, and default options."
---

# Class: BaseManager
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Class: ContainerManager"
title: "ContainerManager class reference"
description: "Reference for ContainerManager, the SDK resource manager used to fetch, list, and refresh containers and their transport events from the API."
---

# Class: ContainerManager
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Class: ShipmentManager"
title: "ShipmentManager class reference"
description: "Reference for ShipmentManager, the SDK resource manager used to list, fetch, and update shipments returned by the Terminal49 tracking API."
---

# Class: ShipmentManager
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Class: ShippingLineManager"
title: "ShippingLineManager class reference"
description: "Reference for ShippingLineManager, the SDK resource manager used to list and fetch supported ocean carriers and their SCAC codes from the API."
---

# Class: ShippingLineManager
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Class: TrackingRequestManager"
title: "TrackingRequestManager class reference"
description: "Reference for TrackingRequestManager, the SDK manager used to create, list, and inspect tracking requests for bills of lading and containers."
---

# Class: TrackingRequestManager
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/reference/client/managers/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "client/managers"
title: "Client managers reference"
description: "Reference for SDK resource managers that group methods for shipments, containers, tracking requests, shipping lines, and shared base behavior."
---

# client/managers
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: CreateTrackingRequestFromInferOptions"
title: "CreateTrackingRequestFromInferOptions reference"
description: "Reference for the options interface used to create a tracking request with auto-detected carrier inference from a bill of lading or booking number."
---

# Interface: CreateTrackingRequestFromInferOptions
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: TrackingRequestListFilters"
title: "TrackingRequestListFilters interface reference"
description: "Reference for TrackingRequestListFilters, the options used to filter tracking request list results by status, carrier SCAC, request number, and more."
---

# Interface: TrackingRequestListFilters
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: TrackingRequestType"
title: "TrackingRequestType type alias reference"
description: "Reference for TrackingRequestType, the literal union identifying tracking request types such as bill of lading, booking number, and container number."
---

# Type Alias: TrackingRequestType
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/reference/client/transport/classes/Transport.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Class: Transport"
title: "Transport class reference"
description: "Reference for the Transport class, the low-level HTTP layer used by the Terminal49 SDK to dispatch requests through interceptors and the API client."
---

# Class: Transport
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/reference/client/transport/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "client/transport"
title: "Client transport layer reference"
description: "Reference for the SDK transport layer: the Transport class, ApiClient type alias, and TransportConfig used for low-level HTTP requests."
---

# client/transport
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: TransportConfig"
title: "TransportConfig interface reference"
description: "Reference for TransportConfig, the configuration interface for the SDK transport layer, including base URL, default timeout, and interceptors."
---

# Interface: TransportConfig
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: ApiClient"
title: "ApiClient type alias reference"
description: "Reference for the ApiClient type alias, the minimal HTTP client contract the SDK transport accepts so you can plug in axios, fetch, or a custom client."
---

# Type Alias: ApiClient
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/reference/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "TypeScript SDK API Reference"
title: "TypeScript SDK API reference"
description: "Complete API reference for the Terminal49 TypeScript SDK, covering the client, managers, interceptors, transport layer, and type definitions."
---

# TypeScript SDK API Reference
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/reference/types/models/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Models"
title: "SDK model types reference"
description: "Reference for simplified SDK model interfaces: Container, Shipment, Route, ShippingLine, TrackingRequest, PaginatedResult, and PaginationLinks."
---

# types/models
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/reference/types/models/interfaces/Container.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: Container"
title: "Container model interface reference"
description: "Reference for the Container interface, the simplified container model returned by mapped SDK responses, including demurrage, equipment, and location."
---

# Interface: Container
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: PaginatedResult<T>"
title: "PaginatedResult generic interface reference"
description: "Reference for the PaginatedResult generic interface returned by SDK list methods, wrapping records together with pagination links and metadata."
---

# Interface: PaginatedResult\<T\>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: PaginationLinks"
title: "PaginationLinks interface reference"
description: "Reference for the PaginationLinks interface returned alongside SDK list responses, containing next, previous, first, and last page navigation URLs."
---

# Interface: PaginationLinks
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/reference/types/models/interfaces/Route.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: Route"
title: "Route model interface reference"
description: "Reference for the Route interface, the simplified container route model returned by mapped SDK responses with origin, destination, and milestones."
---

# Interface: Route
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/reference/types/models/interfaces/Shipment.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: Shipment"
title: "Shipment model interface reference"
description: "Reference for the Shipment interface, the simplified shipment model returned by mapped SDK responses for bill of lading and booking-level tracking."
---

# Interface: Shipment
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/reference/types/models/interfaces/ShippingLine.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: ShippingLine"
title: "ShippingLine model interface reference"
description: "Reference for the ShippingLine interface, the simplified ocean carrier model returned by the SDK that includes name, SCAC code, and supported features."
---

# Interface: ShippingLine
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: TrackingRequest"
title: "TrackingRequest model interface reference"
description: "Reference for the TrackingRequest interface returned by the SDK, including request type, identifier, status, failure reason, and related shipment links."
---

# Interface: TrackingRequest
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/reference/types/options/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Options"
title: "SDK call and list options reference"
description: "Reference for SDK request option types: CallOptions, ListOptions, include parameter aliases, and response format selection for typed responses."
---

# types/options
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/reference/types/options/interfaces/CallOptions.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: CallOptions"
title: "CallOptions interface reference"
description: "Reference for CallOptions, the per-call options accepted by single-resource SDK methods such as get and refresh, including includes and response format."
---

# Interface: CallOptions
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/reference/types/options/interfaces/ListOptions.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: ListOptions"
title: "ListOptions interface reference"
description: "Reference for ListOptions, the per-call options accepted by SDK list methods, including pagination cursors, filters, includes, and response format."
---

# Interface: ListOptions
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: ContainerInclude"
title: "ContainerInclude type alias reference"
description: "Reference for ContainerInclude, the union of related resource names that can be requested via the include parameter on container SDK methods."
---

# Type Alias: ContainerInclude
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: IncludeParam<TInclude>"
title: "IncludeParam generic type alias reference"
description: "Reference for IncludeParam, the generic type alias that lets SDK methods accept either an array of include names or a comma-separated include string."
---

# Type Alias: IncludeParam\<TInclude\>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: ResponseFormat"
title: "ResponseFormat type alias reference"
description: "Reference for ResponseFormat, the literal union that selects between raw JSON:API and mapped simplified response shapes for Terminal49 SDK methods."
---

# Type Alias: ResponseFormat
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: ShipmentInclude"
title: "ShipmentInclude type alias reference"
description: "Reference for ShipmentInclude, the union of related resource names that can be requested via the include parameter on shipment SDK methods."
---

# Type Alias: ShipmentInclude
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: TrackingRequestInclude"
title: "TrackingRequestInclude type alias reference"
description: "Reference for TrackingRequestInclude, the union of related resources you can request via the include parameter on tracking request SDK methods."
---

# Type Alias: TrackingRequestInclude
Expand Down
Loading