Inttegro.Customers.CreateRequest (inttegro v0.2.0)

Parameters for Create Request in the Customers API.

Build this struct with new!/1 and pass it to the corresponding function on Inttegro.Customers. Required keys are enforced immediately; optional values left as nil are omitted from the request sent to Inttegro.

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()

A validated create request request.

Functions

new!(attrs \\ %{})

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

Types

t()

@type t() :: %Inttegro.Customers.CreateRequest{
  billing_address: Inttegro.Customers.AddressInput.t() | nil,
  custom_data: %{optional(String.t()) => term()} | nil,
  email_address: String.t() | nil,
  name: String.t(),
  phone_number: String.t() | nil,
  reference: String.t() | nil,
  shipping_address: Inttegro.Customers.AddressInput.t() | nil,
  title: String.t() | nil
}

A validated create request request.

Functions

new!(attrs \\ %{})

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

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