`IAddressRegionSearchResponse`

The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.

IAddressRegionSearchResponse

Region search response envelope with results or API errors.

src/lib/interfaces/orionplace/address/IAddressRegionSearch.ts

TypeScript

export interface IAddressRegionSearchResponse {
  // Field error arrays, or null. General errors use the __all__ key.
  form_errors: Record<string, ApiFormError[]> | null;
  // Localized success message, or null on failure.
  success_message: string | null;
  // Matching regions on success, including an empty array; null on failure.
  page_data: IAddressRegion[] | null;
  // Endpoint name, added when the backend begins processing the request.
  url_name?: 'address_hints_region_search';
}