conekta_ex v1.0.1 ConektaEx.Customer

Link to this section Summary

Functions

Cancels a subscription with subscription_id for a customer_id

Creates a customer

Creates a payment source for a customer with a customer_id

Creates a shipping contact for a customer with customer_id

Creates a subscription for a customer with customer_id, plan_id and card_id if proivded

Deletes a customer with customer_id

Deletes a payment source for a customer with a customer_id

Deletes a shipping contact for a customer with customer_id and contact_id

Retrieves a list of customers

Gets a ConektaEx.StructList with ‘data’ as a list of ConektaEx.Customer. See ConektaEx.StructList.request_next/2 for examples

Pauses a subscription with subscription_id for a customer_id

Gets a ConektaEx.StructList with ‘data’ as a list of ConektaEx.Customer. See ConektaEx.StructList.request_previous/2 for examples

Resumes a subscription with subscription_id for a customer_id

Retrieves a customer with customer_id

Updates a customer with customer_id and Map attrs

Updates a payment source for a customer with a customer_id

Updates a shipping contact for a customer with customer_id and contact_id

Examples

Updates a subscription for a customer with customer_id, plan_id and card_id if proivded

Link to this section Types

Link to this type t()
t() :: %ConektaEx.Customer{
  corporate: term(),
  default_payment_source_id: term(),
  default_shipping_contact_id: term(),
  email: term(),
  id: term(),
  livemode: term(),
  name: term(),
  object: term(),
  payment_sources: term(),
  phone: term(),
  plan_id: term(),
  shipping_contacts: term(),
  subscription: term()
}

Link to this section Functions

Link to this function cancel_subscription(customer_id, subscription_id)
cancel_subscription(binary(), binary()) ::
  {:ok, ConektaEx.Subscription.t()} | {:error, ConektaEx.Error.t()}

Cancels a subscription with subscription_id for a customer_id

Examples

iex> cancel_subscription(customer_id, ok_subscription_id)
{:ok, %ConektaEx.Subscription{}}

iex> cancel_subscription(customer_id, bad_subscription_id)
{:error, %ConektaEx.Error{}}
Link to this function create(attrs)
create(map()) :: {:ok, t()} | {:error, ConektaEx.Error.t()}

Creates a customer.

Examples

iex> create(%{name: ok_name, email: ok_email})
{:ok, %ConektaEx.Customer{}}

iex> create(%{email: bad_email})
{:error, %ConektaEx.Error{}}
Link to this function create_payment_source(customer_id, type, token_id)
create_payment_source(binary(), any(), any()) ::
  {:ok, ConektaEx.PaymentSource.t()} | {:error, ConektaEx.Error.t()}

Creates a payment source for a customer with a customer_id.

Examples

iex> create_payment_source(customer_id, "card", ok_token)
{:ok, %ConektaEx.PaymentSource{}}

iex> create_payment_source(customer_id, "card", bad_token)
{:error, %ConektaEx.Error{}}
Link to this function create_shipping_contact(customer_id, attrs)
create_shipping_contact(binary(), map()) ::
  {:ok, ConektaEx.ShippingContact.t()} | {:error, ConektaEx.Error.t()}

Creates a shipping contact for a customer with customer_id

Examples

iex> create_shipping_contact(customer_id, ok_attrs)
{:ok, %ConektaEx.ShippingContact{}}

iex> create_shipping_contact(customer_id, bad_attrs)
{:error, %ConektaEx.Error{}}
Link to this function create_subscription(customer_id, plan_id, card_id \\ nil)
create_subscription(binary(), binary(), binary() | nil) ::
  {:ok, ConektaEx.Subscription.t()} | {:error, ConektaEx.Error.t()}

Creates a subscription for a customer with customer_id, plan_id and card_id if proivded.

Examples

iex> create_subscription(customer_id, ok_plan_id)
{:ok, %ConektaEx.Subscription{}}

iex> create_subscription(customer_id, bad_plan_id)
{:error, %ConektaEx.Error{}}
Link to this function delete(customer_id)
delete(binary()) :: {:ok, t()} | {:error, ConektaEx.Error.t()}

Deletes a customer with customer_id

Examples

iex> delete(ok_customer_id)
{:ok, %ConektaEx.Customer{}}

iex> delete(bad_customer_id)
{:error, %ConektaEx.Error{}}
Link to this function delete_payment_source(customer_id, source_id)
delete_payment_source(binary(), binary()) ::
  {:ok, ConektaEx.PaymentSource.t()} | {:error, ConektaEx.Error.t()}

Deletes a payment source for a customer with a customer_id.

Examples

iex> delete(customer_id, ok_source_id)
{:ok, %ConektaEx.PaymentSource{}}

iex> delete(customer_id, bad_source_id)
{:error, %ConektaEx.Error{}}
Link to this function delete_shipping_contact(customer_id, contact_id)
delete_shipping_contact(binary(), binary()) ::
  {:ok, ConektaEx.ShippingContact.t()} | {:error, ConektaEx.Error.t()}

Deletes a shipping contact for a customer with customer_id and contact_id

Examples

iex> delete_shipping_contact(customer_id, contact_id)
{:ok, %ConektaEx.ShippingContact{}}

iex> delete_shipping_contact(customer_id, bad_line_id)
{:error, %ConektaEx.Error{}}
Link to this function list()
list() :: {:ok, ConektaEx.StructList.t()} | {:error, ConektaEx.Error.t()}

Retrieves a list of customers.

Link to this function next_page(struct_list, limit \\ nil)
next_page(ConektaEx.StructList.t(), any()) ::
  {:ok, ConektaEx.StructList.t()} | {:error, ConektaEx.Error.t()}

Gets a ConektaEx.StructList with ‘data’ as a list of ConektaEx.Customer. See ConektaEx.StructList.request_next/2 for examples.

Link to this function pause_subscription(customer_id, subscription_id)
pause_subscription(binary(), binary()) ::
  {:ok, ConektaEx.Subscription.t()} | {:error, ConektaEx.Error.t()}

Pauses a subscription with subscription_id for a customer_id

Examples

iex> pause_subscription(customer_id, ok_subscription_id)
{:ok, %ConektaEx.Subscription{}}

iex> pause_subscription(customer_id, bad_subscription_id)
{:error, %ConektaEx.Error{}}
Link to this function previous_page(struct_list, limit \\ nil)
previous_page(ConektaEx.StructList.t(), any()) ::
  {:ok, ConektaEx.StructList.t()} | {:error, ConektaEx.Error.t()}

Gets a ConektaEx.StructList with ‘data’ as a list of ConektaEx.Customer. See ConektaEx.StructList.request_previous/2 for examples.

Link to this function resume_subscription(customer_id, subscription_id)
resume_subscription(binary(), binary()) ::
  {:ok, ConektaEx.Subscription.t()} | {:error, ConektaEx.Error.t()}

Resumes a subscription with subscription_id for a customer_id

Examples

iex> resume_subscription(customer_id, ok_subscription_id)
{:ok, %ConektaEx.Subscription{}}

iex> resume_subscription(customer_id, bad_subscription_id)
{:error, %ConektaEx.Error{}}
Link to this function retrieve(customer_id)
retrieve(binary()) :: {:ok, t()} | {:error, ConektaEx.Error.t()}

Retrieves a customer with customer_id

Examples

iex> retrieve(ok_customer_id)
{:ok, %ConektaEx.Customer{}}

iex> retrieve(bad_customer_id)
{:error, %ConektaEx.Error{}}
Link to this function update(customer_id, attrs)
update(binary(), map()) :: {:ok, t()} | {:error, ConektaEx.Error.t()}

Updates a customer with customer_id and Map attrs

Examples

iex> update(ok_customer_id, ok_attrs)
{:ok, %ConektaEx.Customer{}}

iex> update(bad_customer_id, ok_attrs)
{:error, %ConektaEx.Error{}}
Link to this function update_payment_source(customer_id, source_id, attrs)
update_payment_source(binary(), binary(), map()) ::
  {:ok, ConektaEx.PaymentSource.t()} | {:error, ConektaEx.Error.t()}

Updates a payment source for a customer with a customer_id.

Examples

iex> update_payment_source(customer_id, ok_attrs)
{:ok, %ConektaEx.PaymentSource{}}

iex> update_payment_source(customer_id, bad_attrs)
{:error, %ConektaEx.Error{}}
Link to this function update_shipping_contact(customer_id, contact_id, attrs)
update_shipping_contact(binary(), binary(), map()) ::
  {:ok, ConektaEx.ShippingContact.t()} | {:error, ConektaEx.Error.t()}

Updates a shipping contact for a customer with customer_id and contact_id

Examples

iex> update_shipping_contact(customer_id, contact_id, ok_attrs)
{:ok, %ConektaEx.ShippingContact{}}

iex> update_shipping_contact(customer_id, contact_id, bad_attrs)
{:error, %ConektaEx.Error{}}
Link to this function update_subscription(customer_id, plan_id, card_id \\ nil)
update_subscription(binary(), binary(), binary() | nil) ::
  {:ok, ConektaEx.Subscription.t()} | {:error, ConektaEx.Error.t()}

Updates a subscription for a customer with customer_id, plan_id and card_id if proivded.

Examples

iex> update_subscription(customer_id, plan_id, ok_attrs)
{:ok, %ConektaEx.Subscription{}}

iex> update_subscription(customer_id, plan_id, bad_attrs)
{:error, %ConektaEx.Error{}}