`IUserAddressDeleteResponse`

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

IUserAddressDeleteResponse

page_data is either null or an object with another_default.

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

TypeScript

export interface IUserAddressDeleteResponse {
  // Field errors or __all__ errors; null on success.
  form_errors: Record<string, ApiFormError[]> | null;
  // Success message; null on failure.
  success_message: string | null;
  // `page_data` is either `null` or an object with `another_default`.
  page_data: {
    // ID of the replacement shipping default, returned only when the deleted
    // address was the default and another address was selected. Otherwise
    // `page_data` is `null`.
    another_default: number;
  } | null;
}