ExShopify v0.2.0 ExShopify.OrderRisk
Indicates to a merchant the fraud checks that have been done on an order.
Summary
Functions
Create a new order risk
Delete an order risk entry
Get a single order risk by its id
Get a list of all order risks
Update an order risk entry
Types
Functions
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) :: order_risk_singular | ExShopify.Resource.error
Create a new order risk.
Examples
iex> params = %ExShopify.OrderRisk{
...> message: "This order came from an anonymous proxy",
...> recommendation: "cancel",
...> score: 1.0,
...> source: "External",
...> cause_cancel: true,
...> display: true
...> }
iex> ExShopify.OrderRisk.create(session, 450789469, params)
{:ok, order_risk, meta}
delete(session, id, order_id)
delete(%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) :: ExShopify.Resource.meta_only | ExShopify.Resource.error
Delete an order risk entry.
Examples
iex> ExShopify.OrderRisk.delete(session, 284138680, 450789469)
{:ok, 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) :: order_risk_singular | ExShopify.Resource.error
Get a single order risk by its id.
Examples
iex> ExShopify.OrderRisk.find(session, 284138680, 450789469)
{:ok, order_risk, 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) :: order_risk_plural | ExShopify.Resource.error
Get a list of all order risks.
Examples
iex> ExShopify.OrderRisk.list(session, 450789469)
{:ok, order_risks, meta}
update(session, id, order_id, params)
update(%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) :: order_risk_singular | ExShopify.Resource.error
Update an order risk entry.
Examples
iex> params = %ExShopify.OrderRisk{
...> message: "After further review, this is a legitimate order",
...> recommendation: "accept",
...> source: "External",
...> cause_cancel: false,
...> score: 0.0
...> }
iex> ExShopify.OrderRisk.update(session, 284138680, 450789469, params)
{:ok, order_risk, meta}