`IUserAddressRequest`

Физическое объявление TypeScript из стартового проекта Nuxt со связанными типами и комментариями к полям.

IUserAddressRequest

Поля для создания и полного обновления адреса.

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

TypeScript

export interface IUserAddressRequest {
  // Обязательно, 3–32 символа. Название должно быть уникальным среди адресов в
  // аккаунте пользователя.
  address_label: string;
  // Обязательная улица или строка адреса, 2–128 символов.
  line1: string;
  // Дополнительная строка адреса, до 128 символов. Необязательно.
  line2?: string;
  // Обязательное название города, до 128 символов.
  city: string;
  // Обязательный ID региона из `fUserAddress.state`. Выберите регион указанной
  // страны.
  state: number;
  // Почтовый индекс по правилам выбранной страны, до 64 символов.
  postcode?: string;
  // Обязательный ID страны из `fUserAddress.country`. Форма принимает
  // включённые страны; возможность доставки — отдельное свойство страны.
  country: number;
  // Обязательный номер дома в виде строки, до 20 символов; допускаются буквы.
  house_number: string;
  // Подъезд, до 20 символов. Необязательно.
  entrance?: string;
  // Код домофона, до 20 символов. Необязательно.
  intercom?: string;
  // Этаж в виде строки, до 20 символов. Необязательно.
  floor?: string;
  // Квартира или офис, до 20 символов. Необязательно.
  apt_number?: string;
  // `true` назначает этот адрес основным для доставки и снимает отметку с
  // других адресов. В переданной форме пропуск означает `false`.
  is_default_for_shipping?: boolean;
}