`IAddressRegion`

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

IAddressRegion

A region with translated names and its country identifiers.

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

TypeScript

export interface IAddressRegion {
  // Region ID.
  id: number;
  // Region names keyed by locale code. Missing translations are empty objects.
  locales: Record<string, IAddressRegionLocale>;
  // Two-letter country code (ISO 3166-1 alpha-2).
  country: string;
  // Country ID accepted by `filters.country`.
  country_id: number;
  // Stored region ISO code. It can be empty; the response preserves the stored
  // text.
  region_iso: string;
}