Shopifex.PaymentGuard behaviour (Shopifex v2.1.20) View Source

Context behaviour responsible for fetching and using payment grants.

Link to this section Summary

Callbacks

After payment has been accepted, this function is meant to persist the payment. Default behaviour is to create a grant schema record. charge_id is the external id for the Shopify charge record.

get_plan(plan_id)

Gets a plan with a given identifier

grant_for_guard(arg1, guard)

Returns a payment record which grants access to the payment guard. Default behaviour filters where remaining_usages is greater than 0 or has a nil value (unlimited usage). You can also provide a list of grants in place of the first parameter in order to avoid a trip to the database.

grants_for_shop(shop)

Returns a list of valid grants which are associated with the store.

list_available_plans_for_guard(shop, guard)

Get a list of plans for shop based on provided guard

use_grant(shop, grant)

Updates the grant to reflect the usage of it in some way. Defaults to decrementing the remaining_usages property if it's not nil. If it is nil, the grant has unlimited usages

Link to this section Types

grant()

Specs

grant() :: %{
  charge_id: pos_integer(),
  grants: [String.t()],
  remaining_usages: pos_integer(),
  total_usages: pos_integer()
}

guard()

Specs

guard() :: String.t()

plan()

Specs

plan() :: %{
  id: String.t() | pos_integer(),
  name: String.t(),
  price: String.t(),
  type: String.t(),
  test: boolean()
}

shop()

Specs

shop() :: %{access_token: String.t(), scope: String.t(), url: String.t()}

Link to this section Callbacks

create_grant(shop, plan, charge_id)

(optional)

Specs

create_grant(shop :: shop(), plan :: plan(), charge_id :: pos_integer()) ::
  {:ok, any()}

After payment has been accepted, this function is meant to persist the payment. Default behaviour is to create a grant schema record. charge_id is the external id for the Shopify charge record.

get_plan(plan_id)

(optional)

Specs

get_plan(plan_id :: String.t() | pos_integer()) :: plan()

Gets a plan with a given identifier

grant_for_guard(arg1, guard)

(optional)

Specs

grant_for_guard(shop() | [grant()], guard()) :: grant() | boolean()

grants_for_shop(shop)

Specs

grants_for_shop(shop()) :: [grant()]

Returns a list of valid grants which are associated with the store.

list_available_plans_for_guard(shop, guard)

(optional)

Specs

list_available_plans_for_guard(shop :: shop(), guard :: guard()) :: [plan()]

Get a list of plans for shop based on provided guard

use_grant(shop, grant)

(optional)

Specs

use_grant(shop(), grant()) :: grant()

Updates the grant to reflect the usage of it in some way. Defaults to decrementing the remaining_usages property if it's not nil. If it is nil, the grant has unlimited usages