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
Functions
Create a reusable customer profile for orders and saved payment methods.
Look up a customer
Retrieve a page of customers for the authenticated application.
Replace any supplied customer profile fields while leaving omitted fields unchanged.
Functions
@spec create(Inttegro.Client.t(), Inttegro.Customers.CreateRequest.t(), keyword()) :: {:ok, Inttegro.Customers.Customer.t()} | {:error, Exception.t()}
Create a reusable customer profile for orders and saved payment methods.
Parameters
client— an authenticatedInttegro.Client.request— aInttegro.Customers.CreateRequestcontaining the operation input.options— request options such as:idempotency_keyand additional:headers.
Returns
Returns {:ok, Inttegro.Customers.Customer.t()} when Inttegro accepts and decodes the operation. Returns
{:error, exception} for API, transport, or decoding failures. A successful API response can
still describe an asynchronous resource that has not reached its terminal state.
Example
request = Inttegro.Customers.CreateRequest.new!(request_attributes)
case Inttegro.Customers.create(client, request) do
{:ok, result} -> result
{:error, error} -> {:error, error}
end@spec lookup(Inttegro.Client.t(), Inttegro.Customers.LookupRequest.t(), keyword()) :: {:ok, Inttegro.Customers.Customer.t()} | {:error, Exception.t()}
Look up a customer
Parameters
client— an authenticatedInttegro.Client.request— aInttegro.Customers.LookupRequestcontaining the operation input.options— request options such as:idempotency_keyand additional:headers.
Returns
Returns {:ok, Inttegro.Customers.Customer.t()} when Inttegro accepts and decodes the operation. Returns
{:error, exception} for API, transport, or decoding failures. A successful API response can
still describe an asynchronous resource that has not reached its terminal state.
Example
request = Inttegro.Customers.LookupRequest.new!(request_attributes)
case Inttegro.Customers.lookup(client, request) do
{:ok, result} -> result
{:error, error} -> {:error, error}
end@spec page(Inttegro.Client.t(), Inttegro.Customers.PageRequest.t(), keyword()) :: {:ok, Inttegro.Customers.Page.t()} | {:error, Exception.t()}
Retrieve a page of customers for the authenticated application.
Parameters
client— an authenticatedInttegro.Client.request— aInttegro.Customers.PageRequestcontaining the operation input.options— request options such as:idempotency_keyand additional:headers.
Returns
Returns {:ok, Inttegro.Customers.Page.t()} when Inttegro accepts and decodes the operation. Returns
{:error, exception} for API, transport, or decoding failures. A successful API response can
still describe an asynchronous resource that has not reached its terminal state.
Example
request = Inttegro.Customers.PageRequest.new!(request_attributes)
case Inttegro.Customers.page(client, request) do
{:ok, result} -> result
{:error, error} -> {:error, error}
end@spec update(Inttegro.Client.t(), Inttegro.Customers.UpdateRequest.t(), keyword()) :: {:ok, Inttegro.Customers.Customer.t()} | {:error, Exception.t()}
Replace any supplied customer profile fields while leaving omitted fields unchanged.
Parameters
client— an authenticatedInttegro.Client.request— aInttegro.Customers.UpdateRequestcontaining the operation input.options— request options such as:idempotency_keyand additional:headers.
Returns
Returns {:ok, Inttegro.Customers.Customer.t()} when Inttegro accepts and decodes the operation. Returns
{:error, exception} for API, transport, or decoding failures. A successful API response can
still describe an asynchronous resource that has not reached its terminal state.
Example
request = Inttegro.Customers.UpdateRequest.new!(request_attributes)
case Inttegro.Customers.update(client, request) do
{:ok, result} -> result
{:error, error} -> {:error, error}
end