`IAddressLocationSuggestionResponse`

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

IAddressLocationSuggestionResponse

Address lookup response envelope with suggestions or API errors.

app/interfaces/orionplace/address/IAddressLocationSuggestion.ts

TypeScript

export interface IAddressLocationSuggestionResponse {
  // Field and general error arrays, or null. General errors use __all__.
  form_errors: Record<string, ApiFormError[]> | null;
  // Success message, or null when the request fails validation.
  success_message: string | null;
  // Address suggestions; an empty array is possible. Null on validation
  // failure.
  page_data: IAddressLocationSuggestion[] | null;
  // Endpoint name, when included in the response.
  url_name?: 'address_hints_suggest_location';
}