ExShopify v0.2.0 ExShopify.Transaction

Created for every order that results in an exchange of money.

Summary

Functions

Receive a count of all transactions

Create a new transaction

Receive a single transaction

Receive a list of all transactions

Types

transaction_plural()
transaction_plural() :: {:ok, [%ExShopify.Transaction{amount: term, authorization: term, created_at: term, currency: term, device_id: term, error_code: term, gateway: term, id: term, kind: term, order_id: term, payment_details: term, receipt: term, source_name: term, status: term, test: term, user_id: term}], %ExShopify.Meta{api_call_limit: term}}
transaction_singular()
transaction_singular() :: {:ok, %ExShopify.Transaction{amount: term, authorization: term, created_at: term, currency: term, device_id: term, error_code: term, gateway: term, id: term, kind: term, order_id: term, payment_details: term, receipt: term, source_name: term, status: term, test: term, user_id: term}, %ExShopify.Meta{api_call_limit: term}}

Functions

count(session, order_id)
count(%ExShopify.Session{access_token: term, api_key: term, domain: term, port: term, protocol: term, secret: term, shop_name: term, shop_url: term}, integer | String.t) ::
  ExShopify.Resource.count |
  ExShopify.Resource.error

Receive a count of all transactions.

Examples

iex> ExShopify.Transaction.count(session, 450789469)
{:ok, count, meta}
create(session, order_id, params)
create(%ExShopify.Session{access_token: term, api_key: term, domain: term, port: term, protocol: term, secret: term, shop_name: term, shop_url: term}, integer | String.t, map) ::
  transaction_singular |
  ExShopify.Resource.error

Create a new transaction.

Examples

Capture a previously authorized order for the full amount

iex> params = %{
...>   kind: "capture"
...> }

iex> ExShopify.Transaction.create(session, 450789469, params)
{:ok, transaction, meta}

Capture a specified amount on a previously authorized order

iex> params = %{
...>   amount: "10.00"
...>   kind: "capture"
...> }

iex> ExShopify.Transaction.create(session, 450789469, params)
{:ok, transaction, meta}
find(session, id, order_id)
find(%ExShopify.Session{access_token: term, api_key: term, domain: term, port: term, protocol: term, secret: term, shop_name: term, shop_url: term}, integer | String.t, integer | String.t) ::
  transaction_singular |
  ExShopify.Resource.error
find(session, id, order_id, params)
find(%ExShopify.Session{access_token: term, api_key: term, domain: term, port: term, protocol: term, secret: term, shop_name: term, shop_url: term}, integer | String.t, integer | String.t, map) ::
  transaction_singular |
  ExShopify.Resource.error

Receive a single transaction.

Examples

iex> ExShopify.Transaction.find(session, 389404469, 450789469)
{:ok, transaction, meta}
list(session, order_id)
list(%ExShopify.Session{access_token: term, api_key: term, domain: term, port: term, protocol: term, secret: term, shop_name: term, shop_url: term}, integer | String.t) ::
  transaction_plural |
  ExShopify.Resource.error
list(session, order_id, params)
list(%ExShopify.Session{access_token: term, api_key: term, domain: term, port: term, protocol: term, secret: term, shop_name: term, shop_url: term}, integer | String.t, map) ::
  transaction_plural |
  ExShopify.Resource.error

Receive a list of all transactions.

Examples

iex> ExShopify.Transaction.list(session, 450789469)
{:ok, transactions, meta}