Merchant.Customers (Merchant v0.6.0)

View Source

Module for customers.

Summary

Types

create_params()
update_params()

Functions

create(params)

Create a Merchant.Customer object.

delete(id)

Delete a Merchant.Customer object.

retrieve(id)

Retrieve a Merchant.Customer object.

update(id, params)

Update a Merchant.Customer object.

Types

create_params()

@type create_params() :: %{
  optional(:full_name) => String.t(),
  optional(:business_name) => String.t(),
  optional(:email) => String.t(),
  optional(:phone) => String.t(),
  optional(:date_of_birth) => Date.t()
}

update_params()

@type update_params() :: create_params()

Functions

create(params)

@spec create(create_params()) ::
  {:ok, Merchant.Customer.t()} | Merchant.Client.error()

Create a Merchant.Customer object.

delete(id)

@spec delete(String.t()) :: {:ok, Merchant.Customer.t()} | Merchant.Client.error()

Delete a Merchant.Customer object.

retrieve(id)

@spec retrieve(String.t()) :: {:ok, Merchant.Customer.t()} | Merchant.Client.error()

Retrieve a Merchant.Customer object.

update(id, params)

@spec update(String.t(), update_params()) ::
  {:ok, Merchant.Customer.t()} | Merchant.Client.error()

Update a Merchant.Customer object.