ExShopify v0.2.0 ExShopify.Event

Generated by specific Shopify resources when specific things happen, such as the creation of an article, the placement or fulfillment of an order, the addition or deletion of a product,

Summary

Types

event_plural()
event_plural() :: {:ok, [%ExShopify.Event{arguments: term, body: term, created_at: term, description: term, id: term, message: term, path: term, subject_id: term, subject_type: term, verb: term}], %ExShopify.Meta{api_call_limit: term}}
event_singular()
event_singular() :: {:ok, %ExShopify.Event{arguments: term, body: term, created_at: term, description: term, id: term, message: term, path: term, subject_id: term, subject_type: term, verb: term}, %ExShopify.Meta{api_call_limit: term}}

Functions

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

Receive a count of all events.

Examples

iex> ExShopify.Event.count(session)
{:ok, count, 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) ::
  event_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) ::
  event_singular |
  ExShopify.Resource.error

Receive a single event.

Examples

iex> ExShopify.Event.find(session, 677313116)
{:ok, event, 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}) ::
  event_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) ::
  event_plural |
  ExShopify.Resource.error

Receive a list of all events.

Examples

List all events

iex> ExShopify.Event.list(session)
{:ok, events, meta}

Only get events related to Products or Orders

iex> ExShopify.Event.list(session, %{filter: “Product,Order”})

Only get events related to Products that were deleted

iex> ExShopify.Event.list(session, %{filter: "Product", verb: "destroy"})
{:ok, events, meta}

The created_at_min and created_at_max parameters are interpreted using the shop’s timezone

iex> ExShopify.Event.list(session, %{created_at_min: "2008-01-10 08:00:00"})
{:ok, events, meta}

Get all the events after the specified ID

iex> ExShopify.Event.list(session, %{since_id: 164748010})
{:ok, events, meta}
list_from_order(session, order_id)
list_from_order(%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) ::
  event_plural |
  ExShopify.Resource.error
list_from_order(session, order_id, params)
list_from_order(%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) ::
  event_plural |
  ExShopify.Resource.error

Get all the events from a particular order.

Examples

iex> ExShopify.Event.list_from_order(session, 164748010)
{:ok, events, meta}
list_from_product(session, product_id)
list_from_product(%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) ::
  event_plural |
  ExShopify.Resource.error
list_from_product(session, product_id, params)
list_from_product(%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) ::
  event_plural |
  ExShopify.Resource.error

Get all the events from a particular product.

Examples

iex> ExShopify.Event.list_from_product(session, 164748010)
{:ok, events, meta}