Context behaviour responsible for fetching and using payment grants.
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.
Gets a plan with a given identifier
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.
Returns a list of valid grants which are associated with the store.
Get a list of plans for shop based on provided guard
Updates the grant to reflect the usage of it in some way. Defaults to atomically
decrementing the remaining_usages property if it's not nil, and incrementing
total_usages. If it is nil, the grant has unlimited usages and only total_usages
is incremented. Returns the updated grant, or nil if 0 rows were updated.
Types
@type grant() :: %{ charge_id: pos_integer(), grants: [String.t()], remaining_usages: pos_integer(), total_usages: pos_integer() }
@type guard() :: String.t()
Callbacks
@callback create_grant(shop :: shop(), plan :: plan(), charge_id :: pos_integer()) :: {:ok, any()} | {:error, 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.
@callback get_plan(plan_id :: String.t() | pos_integer()) :: plan()
Gets a plan with a given identifier
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.
Returns a list of valid grants which are associated with the store.
Get a list of plans for shop based on provided guard
Updates the grant to reflect the usage of it in some way. Defaults to atomically
decrementing the remaining_usages property if it's not nil, and incrementing
total_usages. If it is nil, the grant has unlimited usages and only total_usages
is incremented. Returns the updated grant, or nil if 0 rows were updated.