Inttegro.Customers.Page (inttegro v0.2.0)

Copy Markdown View Source

Represents Page 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 page value.

Functions

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

Types

t()

@type t() :: %Inttegro.Customers.Page{
  customers: [Inttegro.Customers.Customer.t()],
  number: integer(),
  size: integer()
}

The decoded page value.

Functions

new!(attrs \\ %{})

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

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