ExShopify v0.2.0 ExShopify.User

Administrative user for a shop.

Summary

Functions

Get the current logged-in user

Receive a single user

Receive a list of all users

Types

user_plural()
user_plural() :: {:ok, [%ExShopify.User{account_owner: term, bio: term, email: term, first_name: term, id: term, im: term, last_name: term, permissions: term, phone: term, pin: term, receive_announcements: term, screen_name: term, url: term, user_type: term}], %ExShopify.Meta{api_call_limit: term}}
user_singular()
user_singular() :: {:ok, %ExShopify.User{account_owner: term, bio: term, email: term, first_name: term, id: term, im: term, last_name: term, permissions: term, phone: term, pin: term, receive_announcements: term, screen_name: term, url: term, user_type: term}, %ExShopify.Meta{api_call_limit: term}}

Functions

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

Get the current logged-in user.

Examples

iex> ExShopify.User.current(session)
{:ok, user, 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) ::
  user_singular |
  ExShopify.Resource.error

Receive a single user.

Examples

iex> ExShopify.User.find(session, 799407056)
{:ok, user, 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}) ::
  user_plural |
  ExShopify.Resource.error

Receive a list of all users.

Examples

iex> ExShopify.User.list(session)
{:ok, users, meta}