AccountAddressRequest

public struct AccountAddressRequest : AddressModel, Codable, Sendable

Address request model.

  • The unique identifier of the address in your own system.

    Declaration

    Swift

    public let externalId: String?

  • The description of the address.

    Declaration

    Swift

    public let label: String?

  • Address line 1 (e.g., street, PO Box, or company name).

    Note

    newline characters are not accepted.

    Declaration

    Swift

    public let lineOne: String

  • Address line 2 (e.g., apartment, suite, unit, or building).

    Note

    newline characters are not accepted.

    Declaration

    Swift

    public let lineTwo: String?

  • ZIP or postal code.

    Declaration

    Swift

    public let postalCode: String

  • City, district, suburb, town, or village.

    Declaration

    Swift

    public let city: String

  • State, county, province, or region.

    Declaration

    Swift

    public let state: String?

  • Three-letter country code (ISO 3166-1 alpha-3). The keys can be mapped from Country if you want type safety.

    Declaration

    Swift

    public let country: String

  • Auxiliary constructor

    Declaration

    Swift

    public init(lineOne: String,
            postalCode: String,
            city: String,
            country: String,
            state: String? = nil,
            lineTwo: String? = nil,
            label: String? = nil,
            externalId: String? = nil)

    Parameters

    lineOne

    Address line 1 (e.g., street, PO Box, or company name).
    lineTwo

    Address line 2 (e.g., apartment, suite, unit, or building).
    postalCode

    ZIP or postal code.
    city

    City, district, suburb, town, or village.
    state

    State, county, province, or region.
    country

    Three-letter country code (ISO 3166-1 alpha-3). The keys can be mapped from Country if you want type safety.