# Shared

## Domain Types

### API Error

- `api_error: object { code, message, details }`

  A direct mapping of tonic::Status, for use in HTTP responses.

  - `code: number`

    The error code is used to identify the nature of the error. It corresponds
    to an HTTP status code.

  - `message: string`

    A human-readable message providing more details about the error.

  - `details: optional array of map[unknown]`

    Additional error details, if any. This can include structured information
    such as field violations or error metadata.

### Base Response

- `base_response: object { metadata, error }`

  - `metadata: object { request_id, next_page_token, page_number, 3 more }`

    Response metadata, including the request ID and optional pagination info.

    - `request_id: string`

      A unique ID for this request, generated upon ingestion of the request.

    - `next_page_token: optional string`

      Base64URL-encoded pagination token containing limit and offset

    - `page_number: optional number`

      Pagination. Included if this was a GET (list) response

    - `previous_page_token: optional string`

      Base64URL-encoded pagination token containing limit and offset

    - `total_items: optional number`

      Total number of items available (not just in this page).

    - `total_pages: optional number`

      Total number of pages available.

  - `error: optional object { code, message, details }`

    Structured error details when the request is unsuccessful.

    - `code: number`

      The error code is used to identify the nature of the error. It corresponds
      to an HTTP status code.

    - `message: string`

      A human-readable message providing more details about the error.

    - `details: optional array of map[unknown]`

      Additional error details, if any. This can include structured information
      such as field violations or error metadata.

### Response Metadata

- `response_metadata: object { request_id, next_page_token, page_number, 3 more }`

  Metadata for the response. This will always contain a request ID which can be used to identify
  the request to Clear Street for tracing, and optionally may include pagination data.

  - `request_id: string`

    A unique ID for this request, generated upon ingestion of the request.

  - `next_page_token: optional string`

    Base64URL-encoded pagination token containing limit and offset

  - `page_number: optional number`

    Pagination. Included if this was a GET (list) response

  - `previous_page_token: optional string`

    Base64URL-encoded pagination token containing limit and offset

  - `total_items: optional number`

    Total number of items available (not just in this page).

  - `total_pages: optional number`

    Total number of pages available.