BexioApiClient.Contacts.AdditionalAddress (bexio_api_client v2.0.0)

Copy Markdown

Bexio Additional Address Module.

Summary

Types

t()

Bexio Additional Address.

Functions

Create a new additional address

Types

t()

@type t() :: %BexioApiClient.Contacts.AdditionalAddress{
  address: String.t(),
  address_addition: String.t() | nil,
  city: String.t(),
  country_id: integer(),
  description: String.t(),
  house_number: String.t() | nil,
  id: integer(),
  name: String.t(),
  name_addition: String.t() | nil,
  postcode: String.t(),
  street_name: String.t() | nil,
  subject: String.t()
}

Bexio Additional Address.

Fields:

  • :id - automatic id given by bexio
  • :name - name
  • :name_addition - addition to the name
  • :address - street and additional address information
  • :street_name - street name (the :address field is deprecated by bexio in favor of the structured address fields)
  • :house_number - house number
  • :address_addition - additional address information
  • :postcode - postal code / zip
  • :city - city
  • :country_id - reference to a TODO: country object
  • :subject - title for the address
  • :description - full description of the address (internal)

Functions

new(attrs \\ %{})

@spec new(map()) :: t()

Create a new additional address