Expand description
Shared HTTP client, authentication, rate limiting, and error handling for GOV.UK / Companies House SDK crates.
Product crates should depend only on this crate for HTTP and wire endpoints through
SdkClient::get / SdkClient::post or SdkClient::request.
Structs§
- ApiMessage
- A best-effort capture of Companies House / GOV.UK API error payload fields.
- ChDeprecation
- Deprecation metadata from
CH-Expiry-Date(Companies House). - Method
- Re-export for callers that need a non-default HTTP method via
SdkClient::request. The Request Method (VERB) - Negotiated
Response - SdkClient
- HTTP client with shared auth, optional CH rate limit, and base URL.
- SdkClient
Builder - Build a configured
SdkClient. - SdkRequest
- In-flight request: set headers/body then call
SdkRequest::send_jsonorSdkRequest::send_empty.
Enums§
- Auth
- Credentials applied to every request by
SdkClient. - SdkBuild
Error - SdkError
- Validation
validation=parameter for vendorContent-Typeon Companies House writes.
Constants§
- COMPANIES_
HOUSE_ API_ ROOT - Default base URL for the Companies House REST API.
Functions§
- vendor_
content_ type - Build a Companies House vendor
Content-Typevalue includingversion=andvalidation=.
Type Aliases§
- SdkResult
- Standard result type for SDK operations.