diff --git a/docs/sdk/reference/client/classes/AuthenticationError.mdx b/docs/sdk/reference/client/classes/AuthenticationError.mdx index cf4078ad..1c7a240a 100644 --- a/docs/sdk/reference/client/classes/AuthenticationError.mdx +++ b/docs/sdk/reference/client/classes/AuthenticationError.mdx @@ -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 diff --git a/docs/sdk/reference/client/classes/AuthorizationError.mdx b/docs/sdk/reference/client/classes/AuthorizationError.mdx index e833ed5b..15cde084 100644 --- a/docs/sdk/reference/client/classes/AuthorizationError.mdx +++ b/docs/sdk/reference/client/classes/AuthorizationError.mdx @@ -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 diff --git a/docs/sdk/reference/client/classes/FeatureNotEnabledError.mdx b/docs/sdk/reference/client/classes/FeatureNotEnabledError.mdx index 972d7fe3..ac1593e7 100644 --- a/docs/sdk/reference/client/classes/FeatureNotEnabledError.mdx +++ b/docs/sdk/reference/client/classes/FeatureNotEnabledError.mdx @@ -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 diff --git a/docs/sdk/reference/client/classes/NotFoundError.mdx b/docs/sdk/reference/client/classes/NotFoundError.mdx index aec79b81..d4cbe8cf 100644 --- a/docs/sdk/reference/client/classes/NotFoundError.mdx +++ b/docs/sdk/reference/client/classes/NotFoundError.mdx @@ -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 diff --git a/docs/sdk/reference/client/classes/RateLimitError.mdx b/docs/sdk/reference/client/classes/RateLimitError.mdx index 9c950702..5e777c12 100644 --- a/docs/sdk/reference/client/classes/RateLimitError.mdx +++ b/docs/sdk/reference/client/classes/RateLimitError.mdx @@ -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 diff --git a/docs/sdk/reference/client/classes/Terminal49Client.mdx b/docs/sdk/reference/client/classes/Terminal49Client.mdx index 805311d0..80bcdaed 100644 --- a/docs/sdk/reference/client/classes/Terminal49Client.mdx +++ b/docs/sdk/reference/client/classes/Terminal49Client.mdx @@ -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 diff --git a/docs/sdk/reference/client/classes/Terminal49Error.mdx b/docs/sdk/reference/client/classes/Terminal49Error.mdx index 30320a6c..d331d54d 100644 --- a/docs/sdk/reference/client/classes/Terminal49Error.mdx +++ b/docs/sdk/reference/client/classes/Terminal49Error.mdx @@ -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 diff --git a/docs/sdk/reference/client/classes/UpstreamError.mdx b/docs/sdk/reference/client/classes/UpstreamError.mdx index d48d6576..2cb363b5 100644 --- a/docs/sdk/reference/client/classes/UpstreamError.mdx +++ b/docs/sdk/reference/client/classes/UpstreamError.mdx @@ -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 diff --git a/docs/sdk/reference/client/classes/ValidationError.mdx b/docs/sdk/reference/client/classes/ValidationError.mdx index b450900f..2e49952b 100644 --- a/docs/sdk/reference/client/classes/ValidationError.mdx +++ b/docs/sdk/reference/client/classes/ValidationError.mdx @@ -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 diff --git a/docs/sdk/reference/client/index.mdx b/docs/sdk/reference/client/index.mdx index 458fe862..da37ad1b 100644 --- a/docs/sdk/reference/client/index.mdx +++ b/docs/sdk/reference/client/index.mdx @@ -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 diff --git a/docs/sdk/reference/client/interceptors/classes/AuthInterceptor.mdx b/docs/sdk/reference/client/interceptors/classes/AuthInterceptor.mdx index a13e5b4f..c10c130f 100644 --- a/docs/sdk/reference/client/interceptors/classes/AuthInterceptor.mdx +++ b/docs/sdk/reference/client/interceptors/classes/AuthInterceptor.mdx @@ -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 diff --git a/docs/sdk/reference/client/interceptors/classes/ErrorMappingInterceptor.mdx b/docs/sdk/reference/client/interceptors/classes/ErrorMappingInterceptor.mdx index 338fc806..1ccadff2 100644 --- a/docs/sdk/reference/client/interceptors/classes/ErrorMappingInterceptor.mdx +++ b/docs/sdk/reference/client/interceptors/classes/ErrorMappingInterceptor.mdx @@ -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 diff --git a/docs/sdk/reference/client/interceptors/classes/RetryInterceptor.mdx b/docs/sdk/reference/client/interceptors/classes/RetryInterceptor.mdx index cd243361..4110124b 100644 --- a/docs/sdk/reference/client/interceptors/classes/RetryInterceptor.mdx +++ b/docs/sdk/reference/client/interceptors/classes/RetryInterceptor.mdx @@ -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 diff --git a/docs/sdk/reference/client/interceptors/index.mdx b/docs/sdk/reference/client/interceptors/index.mdx index f2f2c394..c1a51720 100644 --- a/docs/sdk/reference/client/interceptors/index.mdx +++ b/docs/sdk/reference/client/interceptors/index.mdx @@ -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 diff --git a/docs/sdk/reference/client/interceptors/type-aliases/Interceptor.mdx b/docs/sdk/reference/client/interceptors/type-aliases/Interceptor.mdx index 9c355f7e..55df22f6 100644 --- a/docs/sdk/reference/client/interceptors/type-aliases/Interceptor.mdx +++ b/docs/sdk/reference/client/interceptors/type-aliases/Interceptor.mdx @@ -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 diff --git a/docs/sdk/reference/client/interfaces/Terminal49ClientConfig.mdx b/docs/sdk/reference/client/interfaces/Terminal49ClientConfig.mdx index 81ce4116..ef0d060f 100644 --- a/docs/sdk/reference/client/interfaces/Terminal49ClientConfig.mdx +++ b/docs/sdk/reference/client/interfaces/Terminal49ClientConfig.mdx @@ -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 diff --git a/docs/sdk/reference/client/managers/classes/BaseManager.mdx b/docs/sdk/reference/client/managers/classes/BaseManager.mdx index b60cad6c..b1966719 100644 --- a/docs/sdk/reference/client/managers/classes/BaseManager.mdx +++ b/docs/sdk/reference/client/managers/classes/BaseManager.mdx @@ -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 diff --git a/docs/sdk/reference/client/managers/classes/ContainerManager.mdx b/docs/sdk/reference/client/managers/classes/ContainerManager.mdx index 6a787bc2..b19ee3c7 100644 --- a/docs/sdk/reference/client/managers/classes/ContainerManager.mdx +++ b/docs/sdk/reference/client/managers/classes/ContainerManager.mdx @@ -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 diff --git a/docs/sdk/reference/client/managers/classes/ShipmentManager.mdx b/docs/sdk/reference/client/managers/classes/ShipmentManager.mdx index 1612ec2c..c65a548c 100644 --- a/docs/sdk/reference/client/managers/classes/ShipmentManager.mdx +++ b/docs/sdk/reference/client/managers/classes/ShipmentManager.mdx @@ -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 diff --git a/docs/sdk/reference/client/managers/classes/ShippingLineManager.mdx b/docs/sdk/reference/client/managers/classes/ShippingLineManager.mdx index 9d3e84fb..fef039d6 100644 --- a/docs/sdk/reference/client/managers/classes/ShippingLineManager.mdx +++ b/docs/sdk/reference/client/managers/classes/ShippingLineManager.mdx @@ -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 diff --git a/docs/sdk/reference/client/managers/classes/TrackingRequestManager.mdx b/docs/sdk/reference/client/managers/classes/TrackingRequestManager.mdx index 33fa02af..d883bff9 100644 --- a/docs/sdk/reference/client/managers/classes/TrackingRequestManager.mdx +++ b/docs/sdk/reference/client/managers/classes/TrackingRequestManager.mdx @@ -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 diff --git a/docs/sdk/reference/client/managers/index.mdx b/docs/sdk/reference/client/managers/index.mdx index eda98114..ea07b392 100644 --- a/docs/sdk/reference/client/managers/index.mdx +++ b/docs/sdk/reference/client/managers/index.mdx @@ -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 diff --git a/docs/sdk/reference/client/managers/interfaces/CreateTrackingRequestFromInferOptions.mdx b/docs/sdk/reference/client/managers/interfaces/CreateTrackingRequestFromInferOptions.mdx index cf9e137a..268f3e05 100644 --- a/docs/sdk/reference/client/managers/interfaces/CreateTrackingRequestFromInferOptions.mdx +++ b/docs/sdk/reference/client/managers/interfaces/CreateTrackingRequestFromInferOptions.mdx @@ -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 diff --git a/docs/sdk/reference/client/managers/interfaces/TrackingRequestListFilters.mdx b/docs/sdk/reference/client/managers/interfaces/TrackingRequestListFilters.mdx index af2c3d9f..ced7f4c7 100644 --- a/docs/sdk/reference/client/managers/interfaces/TrackingRequestListFilters.mdx +++ b/docs/sdk/reference/client/managers/interfaces/TrackingRequestListFilters.mdx @@ -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 diff --git a/docs/sdk/reference/client/managers/type-aliases/TrackingRequestType.mdx b/docs/sdk/reference/client/managers/type-aliases/TrackingRequestType.mdx index e5c03c03..2e7e47a6 100644 --- a/docs/sdk/reference/client/managers/type-aliases/TrackingRequestType.mdx +++ b/docs/sdk/reference/client/managers/type-aliases/TrackingRequestType.mdx @@ -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 diff --git a/docs/sdk/reference/client/transport/classes/Transport.mdx b/docs/sdk/reference/client/transport/classes/Transport.mdx index 3a193615..2efe9ed2 100644 --- a/docs/sdk/reference/client/transport/classes/Transport.mdx +++ b/docs/sdk/reference/client/transport/classes/Transport.mdx @@ -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 diff --git a/docs/sdk/reference/client/transport/index.mdx b/docs/sdk/reference/client/transport/index.mdx index 6e513108..9c463e56 100644 --- a/docs/sdk/reference/client/transport/index.mdx +++ b/docs/sdk/reference/client/transport/index.mdx @@ -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 diff --git a/docs/sdk/reference/client/transport/interfaces/TransportConfig.mdx b/docs/sdk/reference/client/transport/interfaces/TransportConfig.mdx index 415b081d..601ec1bc 100644 --- a/docs/sdk/reference/client/transport/interfaces/TransportConfig.mdx +++ b/docs/sdk/reference/client/transport/interfaces/TransportConfig.mdx @@ -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 diff --git a/docs/sdk/reference/client/transport/type-aliases/ApiClient.mdx b/docs/sdk/reference/client/transport/type-aliases/ApiClient.mdx index 5512473a..b57608d0 100644 --- a/docs/sdk/reference/client/transport/type-aliases/ApiClient.mdx +++ b/docs/sdk/reference/client/transport/type-aliases/ApiClient.mdx @@ -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 diff --git a/docs/sdk/reference/index.mdx b/docs/sdk/reference/index.mdx index 6ee73ed6..609ad2bf 100644 --- a/docs/sdk/reference/index.mdx +++ b/docs/sdk/reference/index.mdx @@ -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 diff --git a/docs/sdk/reference/types/models/index.mdx b/docs/sdk/reference/types/models/index.mdx index ac671374..f37dc6a5 100644 --- a/docs/sdk/reference/types/models/index.mdx +++ b/docs/sdk/reference/types/models/index.mdx @@ -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 diff --git a/docs/sdk/reference/types/models/interfaces/Container.mdx b/docs/sdk/reference/types/models/interfaces/Container.mdx index d4d2e1e8..8e1d4e6c 100644 --- a/docs/sdk/reference/types/models/interfaces/Container.mdx +++ b/docs/sdk/reference/types/models/interfaces/Container.mdx @@ -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 diff --git a/docs/sdk/reference/types/models/interfaces/PaginatedResult.mdx b/docs/sdk/reference/types/models/interfaces/PaginatedResult.mdx index 2b2d8209..eee137ba 100644 --- a/docs/sdk/reference/types/models/interfaces/PaginatedResult.mdx +++ b/docs/sdk/reference/types/models/interfaces/PaginatedResult.mdx @@ -1,5 +1,6 @@ --- -title: "Interface: PaginatedResult" +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\ diff --git a/docs/sdk/reference/types/models/interfaces/PaginationLinks.mdx b/docs/sdk/reference/types/models/interfaces/PaginationLinks.mdx index c1fa52b6..58eeea95 100644 --- a/docs/sdk/reference/types/models/interfaces/PaginationLinks.mdx +++ b/docs/sdk/reference/types/models/interfaces/PaginationLinks.mdx @@ -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 diff --git a/docs/sdk/reference/types/models/interfaces/Route.mdx b/docs/sdk/reference/types/models/interfaces/Route.mdx index c4d7f2ed..ad336313 100644 --- a/docs/sdk/reference/types/models/interfaces/Route.mdx +++ b/docs/sdk/reference/types/models/interfaces/Route.mdx @@ -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 diff --git a/docs/sdk/reference/types/models/interfaces/Shipment.mdx b/docs/sdk/reference/types/models/interfaces/Shipment.mdx index 950b6253..0e42adba 100644 --- a/docs/sdk/reference/types/models/interfaces/Shipment.mdx +++ b/docs/sdk/reference/types/models/interfaces/Shipment.mdx @@ -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 diff --git a/docs/sdk/reference/types/models/interfaces/ShippingLine.mdx b/docs/sdk/reference/types/models/interfaces/ShippingLine.mdx index d9254613..7f99b2c7 100644 --- a/docs/sdk/reference/types/models/interfaces/ShippingLine.mdx +++ b/docs/sdk/reference/types/models/interfaces/ShippingLine.mdx @@ -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 diff --git a/docs/sdk/reference/types/models/interfaces/TrackingRequest.mdx b/docs/sdk/reference/types/models/interfaces/TrackingRequest.mdx index 9a528d4c..8eb08304 100644 --- a/docs/sdk/reference/types/models/interfaces/TrackingRequest.mdx +++ b/docs/sdk/reference/types/models/interfaces/TrackingRequest.mdx @@ -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 diff --git a/docs/sdk/reference/types/options/index.mdx b/docs/sdk/reference/types/options/index.mdx index 0bfb5152..cd46926f 100644 --- a/docs/sdk/reference/types/options/index.mdx +++ b/docs/sdk/reference/types/options/index.mdx @@ -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 diff --git a/docs/sdk/reference/types/options/interfaces/CallOptions.mdx b/docs/sdk/reference/types/options/interfaces/CallOptions.mdx index ec7d3d52..1a242450 100644 --- a/docs/sdk/reference/types/options/interfaces/CallOptions.mdx +++ b/docs/sdk/reference/types/options/interfaces/CallOptions.mdx @@ -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 diff --git a/docs/sdk/reference/types/options/interfaces/ListOptions.mdx b/docs/sdk/reference/types/options/interfaces/ListOptions.mdx index a59ee181..2023c1f5 100644 --- a/docs/sdk/reference/types/options/interfaces/ListOptions.mdx +++ b/docs/sdk/reference/types/options/interfaces/ListOptions.mdx @@ -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 diff --git a/docs/sdk/reference/types/options/type-aliases/ContainerInclude.mdx b/docs/sdk/reference/types/options/type-aliases/ContainerInclude.mdx index 84105882..d6806c28 100644 --- a/docs/sdk/reference/types/options/type-aliases/ContainerInclude.mdx +++ b/docs/sdk/reference/types/options/type-aliases/ContainerInclude.mdx @@ -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 diff --git a/docs/sdk/reference/types/options/type-aliases/IncludeParam.mdx b/docs/sdk/reference/types/options/type-aliases/IncludeParam.mdx index bec2b22b..9cb7c79c 100644 --- a/docs/sdk/reference/types/options/type-aliases/IncludeParam.mdx +++ b/docs/sdk/reference/types/options/type-aliases/IncludeParam.mdx @@ -1,5 +1,6 @@ --- -title: "Type Alias: IncludeParam" +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\ diff --git a/docs/sdk/reference/types/options/type-aliases/ResponseFormat.mdx b/docs/sdk/reference/types/options/type-aliases/ResponseFormat.mdx index c9818301..558a2164 100644 --- a/docs/sdk/reference/types/options/type-aliases/ResponseFormat.mdx +++ b/docs/sdk/reference/types/options/type-aliases/ResponseFormat.mdx @@ -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 diff --git a/docs/sdk/reference/types/options/type-aliases/ShipmentInclude.mdx b/docs/sdk/reference/types/options/type-aliases/ShipmentInclude.mdx index e82218d9..d4179f32 100644 --- a/docs/sdk/reference/types/options/type-aliases/ShipmentInclude.mdx +++ b/docs/sdk/reference/types/options/type-aliases/ShipmentInclude.mdx @@ -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 diff --git a/docs/sdk/reference/types/options/type-aliases/TrackingRequestInclude.mdx b/docs/sdk/reference/types/options/type-aliases/TrackingRequestInclude.mdx index 886fd75f..aff0018d 100644 --- a/docs/sdk/reference/types/options/type-aliases/TrackingRequestInclude.mdx +++ b/docs/sdk/reference/types/options/type-aliases/TrackingRequestInclude.mdx @@ -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