conekta_ex v1.0.1 ConektaEx.Order
Link to this section Summary
Functions
Captures an order with order_id
Creates an order
Creates a charge for an order with order_id
Creates a discount line for an order with order_id
Creates a line item for an order with order_id
Creates a shipping line for an order with order_id
Creates a tax line for an order with order_id
Deletes a discount line for an order with order_id and line_id
Deletes a line item for an order with order_id and line_id
Deletes a shipping line for an order with order_id and line_id
Deletes a tax line for an order with order_id and line_id
Retrieves a list of orders
Gets a ConektaEx.StructList with ‘data’ as a list of
ConektaEx.Order.
See ConektaEx.StructList.request_next/2
for examples
Gets a ConektaEx.StructList with ‘data’ as a list of
ConektaEx.Order.
See ConektaEx.StructList.request_previous/2
for examples
Refunds an order with order_id, adding reason and amount if provided
Retrieves an order with order_id
Updates an order with order_id and Map attrs
Updates a discount line for an order with order_id and line_id
Updates a line item for an order with order_id and line_id
Updates a shipping line for an order with order_id and line_id
Updates a tax line for an order with order_id and line_id
Link to this section Types
t() :: %ConektaEx.Order{ amount: term(), amount_refunded: term(), charges: term(), created_at: term(), currency: term(), customer_info: term(), discount_lines: term(), id: term(), line_items: term(), livemode: term(), metadata: term(), object: term(), payment_status: term(), shipping_contact: term(), shipping_lines: term(), tax_lines: term(), updated_at: term() }
Link to this section Functions
capture(binary()) :: {:ok, t()} | {:error, ConektaEx.Error.t()}
Captures an order with order_id
Examples
iex> capture(ok_order_id)
{:ok, %ConektaEx.Order{}}
iex> capture(bad_order_id)
{:error, %ConektaEx.Error{}}
Creates an order.
Examples
iex> create(%{name: ok_name, email: ok_email})
{:ok, %ConektaEx.Order{}}
iex> create(%{email: bad_email})
{:error, %ConektaEx.Error{}}
create_charge(binary(), map()) :: {:ok, ConektaEx.Charge.t()} | {:error, ConektaEx.Error.t()}
Creates a charge for an order with order_id
Examples
iex> create_charge(order_id, ok_attrs)
{:ok, %ConektaEx.Charge{}}
iex> create_charge(order_id, bad_attrs)
{:error, %ConektaEx.Error{}}
create_discount_line(binary(), map()) :: {:ok, ConektaEx.DiscountLine.t()} | {:error, ConektaEx.Error.t()}
Creates a discount line for an order with order_id
Examples
iex> create_discount_line(order_id, ok_attrs)
{:ok, %ConektaEx.DiscountLine{}}
iex> create_discount_line(order_id, bad_attrs)
{:error, %ConektaEx.Error{}}
create_line_item(binary(), map()) :: {:ok, ConektaEx.LineItem.t()} | {:error, ConektaEx.Error.t()}
Creates a line item for an order with order_id
Examples
iex> create_line_item(order_id, ok_attrs)
{:ok, %ConektaEx.LineItem{}}
iex> create_line_item(order_id, bad_attrs)
{:error, %ConektaEx.Error{}}
create_shipping_line(binary(), map()) :: {:ok, ConektaEx.ShippingLine.t()} | {:error, ConektaEx.Error.t()}
Creates a shipping line for an order with order_id
Examples
iex> create_shipping_line(order_id, ok_attrs)
{:ok, %ConektaEx.ShippingLine{}}
iex> create_shipping_line(order_id, bad_attrs)
{:error, %ConektaEx.Error{}}
create_tax_line(binary(), map()) :: {:ok, ConektaEx.TaxLine.t()} | {:error, ConektaEx.Error.t()}
Creates a tax line for an order with order_id
Examples
iex> create_tax_line(order_id, ok_attrs)
{:ok, %ConektaEx.TaxLine{}}
iex> create_tax_line(order_id, bad_attrs)
{:error, %ConektaEx.Error{}}
delete_discount_line(binary(), binary()) :: {:ok, ConektaEx.DiscountLine.t()} | {:error, ConektaEx.Error.t()}
Deletes a discount line for an order with order_id and line_id
Examples
iex> delete_discount_line(order_id, line_id)
{:ok, %ConektaEx.DiscountLine{}}
iex> delete_discount_line(order_id, bad_line_id)
{:error, %ConektaEx.Error{}}
delete_line_item(binary(), binary()) :: {:ok, ConektaEx.LineItem.t()} | {:error, ConektaEx.Error.t()}
Deletes a line item for an order with order_id and line_id
Examples
iex> delete_line_item(order_id, line_id)
{:ok, %ConektaEx.LineItem{}}
iex> delete_line_item(order_id, bad_line_id)
{:error, %ConektaEx.Error{}}
delete_shipping_line(binary(), binary()) :: {:ok, ConektaEx.ShippingLine.t()} | {:error, ConektaEx.Error.t()}
Deletes a shipping line for an order with order_id and line_id
Examples
iex> delete_shipping_line(order_id, line_id)
{:ok, %ConektaEx.ShippingLine{}}
iex> delete_shipping_line(order_id, bad_line_id)
{:error, %ConektaEx.Error{}}
delete_tax_line(binary(), binary()) :: {:ok, ConektaEx.TaxLine.t()} | {:error, ConektaEx.Error.t()}
Deletes a tax line for an order with order_id and line_id
Examples
iex> delete_tax_line(order_id, line_id)
{:ok, %ConektaEx.TaxLine{}}
iex> delete_tax_line(order_id, bad_line_id)
{:error, %ConektaEx.Error{}}
list() :: {:ok, ConektaEx.StructList.t()} | {:error, ConektaEx.Error.t()}
Retrieves a list of orders.
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.Order.
See ConektaEx.StructList.request_next/2
for examples.
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.Order.
See ConektaEx.StructList.request_previous/2
for examples.
refund(binary(), any(), any() | nil) :: {:ok, t()} | {:error, ConektaEx.Error.t()}
Refunds an order with order_id, adding reason and amount if provided
Examples
iex> refund(ok_order_id, "ugh")
{:ok, %ConektaEx.Order{}}
iex> refund(bad_order_id, "ugh")
{:error, %ConektaEx.Error{}}
retrieve(binary()) :: {:ok, t()} | {:error, ConektaEx.Error.t()}
Retrieves an order with order_id
Examples
iex> retrieve(ok_order_id)
{:ok, %ConektaEx.Order{}}
iex> retrieve(bad_order_id)
{:error, %ConektaEx.Error{}}
update(binary(), map()) :: {:ok, t()} | {:error, ConektaEx.Error.t()}
Updates an order with order_id and Map attrs
Examples
iex> update(ok_order_id, ok_attrs)
{:ok, %ConektaEx.Order{}}
iex> update(bad_order_id, ok_attrs)
{:error, %ConektaEx.Error{}}
update_discount_line(binary(), binary(), map()) :: {:ok, ConektaEx.DiscountLine.t()} | {:error, ConektaEx.Error.t()}
Updates a discount line for an order with order_id and line_id
Examples
iex> update_discount_line(order_id, line_id, ok_attrs)
{:ok, %ConektaEx.DiscountLine{}}
iex> update_discount_line(order_id, line_id, bad_attrs)
{:error, %ConektaEx.Error{}}
update_line_item(binary(), binary(), map()) :: {:ok, ConektaEx.LineItem.t()} | {:error, ConektaEx.Error.t()}
Updates a line item for an order with order_id and line_id
Examples
iex> update_line_item(order_id, line_id, ok_attrs)
{:ok, %ConektaEx.LineItem{}}
iex> update_line_item(order_id, line_id, bad_attrs)
{:error, %ConektaEx.Error{}}
update_shipping_line(binary(), binary(), map()) :: {:ok, ConektaEx.ShippingLine.t()} | {:error, ConektaEx.Error.t()}
Updates a shipping line for an order with order_id and line_id
Examples
iex> update_shipping_line(order_id, line_id, ok_attrs)
{:ok, %ConektaEx.ShippingLine{}}
iex> update_shipping_line(order_id, line_id, bad_attrs)
{:error, %ConektaEx.Error{}}
update_tax_line(binary(), binary(), map()) :: {:ok, ConektaEx.TaxLine.t()} | {:error, ConektaEx.Error.t()}
Updates a tax line for an order with order_id and line_id
Examples
iex> update_tax_line(order_id, line_id, ok_attrs)
{:ok, %ConektaEx.TaxLine{}}
iex> update_tax_line(order_id, line_id, bad_attrs)
{:error, %ConektaEx.Error{}}