Inttegro.Customers.Address (inttegro v0.2.0)

Represents Address data in the Customers API.

Inttegro decodes API responses into this struct. Required fields are always present; optional fields are nil when they do not apply or were not returned. Follow the linked types in t/0 for nested domain values.

Creates and maintains customer records owned by an Inttegro application.

Customers connect contact information, addresses, orders, and saved payment methods. Use a stable customer ID for repeat relationships and keep application-specific identifiers in custom_data rather than overloading personal fields.

Summary

Types

t()

The decoded address value.

Functions

new!(attrs \\ %{})

Builds a Inttegro.Customers.Address and raises KeyError when a required field is missing.

Types

t()

@type t() :: %Inttegro.Customers.Address{
  city: String.t() | nil,
  country: String.t(),
  line1: String.t() | nil,
  line2: String.t() | nil,
  name: String.t() | nil,
  phone_number: String.t() | nil,
  post_code: String.t() | nil,
  region: String.t() | nil
}

The decoded address value.

Functions

new!(attrs \\ %{})

@spec new!(map() | keyword()) :: t()

Builds a Inttegro.Customers.Address and raises KeyError when a required field is missing.