ExShopify v0.2.0 ExShopify.ApplicationCharge
A one-time charge to a shop.
Summary
Functions
Activate a previously accepted one-time application charge
Create a new one-time application charge
Retrieve one-time application charge
All charges that have been requested are retrieved by this request
Types
Functions
activate(session, id)
activate(%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) :: application_charge_singular | ExShopify.Resource.error
Activate a previously accepted one-time application charge.
Examples
iex> ExShopify.ApplicationChrage.activate(session, 1240375)
{:ok, application_charge, meta}
create(session, params)
create(%ExShopify.Session{access_token: term, api_key: term, domain: term, port: term, protocol: term, secret: term, shop_name: term, shop_url: term}, map) :: application_charge_singular | ExShopify.Resource.error
Create a new one-time application charge.
Examples
iex> params = %ExShopify.ApplicationCharge{
...> name: "Super Duper Expensive action",
...> price: 100.0,
...> return_url: "http://super-duper.shopifyapps.com"
...> }
iex> ExShopify.ApplicationCharge.create(session, params)
{:ok, application_charge, meta}
find(session, 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) :: application_charge_singular | ExShopify.Resource.error
find(session, 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, map) :: application_charge_singular | ExShopify.Resource.error
Retrieve one-time application charge.
Examples
iex> ExShopify.ApplicationCharge.find(session, 675931192)
{:ok, application_charge, meta}
list(session)
list(%ExShopify.Session{access_token: term, api_key: term, domain: term, port: term, protocol: term, secret: term, shop_name: term, shop_url: term}) :: application_charge_plural | ExShopify.Resource.error
list(session, params)
list(%ExShopify.Session{access_token: term, api_key: term, domain: term, port: term, protocol: term, secret: term, shop_name: term, shop_url: term}, map) :: application_charge_plural | ExShopify.Resource.error
All charges that have been requested are retrieved by this request.
Examples
iex> ExShopify.ApplicationCharge.list
{:ok, application_charges, meta}