ExShopify v0.2.0 ExShopify.Redirect

Request to charge a shop a recurring fee.

Summary

Functions

Receive a count of all redirects

Create a new redirect

Delete a redirect from the database

Receive a single redirect

Receive a list of all redirects

Modify an existing redirect

Types

redirect_plural()
redirect_plural() :: {:ok, [%ExShopify.Redirect{id: term, path: term, target: term}], %ExShopify.Meta{api_call_limit: term}}
redirect_singular()
redirect_singular() :: {:ok, %ExShopify.Redirect{id: term, path: term, target: 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 redirects.

Examples

iex> ExShopify.Redirect.count(session)
{:ok, count, meta}
create(session, params)
create(%ExShopify.Session{access_token: term, api_key: term, domain: term, port: term, protocol: term, secret: term, shop_name: term, shop_url: term}, map) ::
  redirect_singular |
  ExShopify.Resource.error

Create a new redirect.

Examples

iex> params = %{
...>   path: "/ipod",
...>   target: "/pages/itunes"
...> }

iex> ExShopify.Redirect.create(session, params)
{:ok, redirect, meta}
delete(session, 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) ::
  ExShopify.Resource.meta_only |
  ExShopify.Resource.error

Delete a redirect from the database.

Examples

iex> ExShopify.Redirect.delete(session, 668809255)
{:ok, 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) ::
  redirect_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) ::
  redirect_singular |
  ExShopify.Resource.error

Receive a single redirect.

Examples

iex> ExShopify.Redirect.find(session, 668809255)
{:ok, redirect, 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}) ::
  redirect_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) ::
  redirect_plural |
  ExShopify.Resource.error

Receive a list of all redirects.

Examples

iex> ExShopify.Redirect.list(session)
{:ok, redirects, meta}
update(session, 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, map) ::
  redirect_singular |
  ExShopify.Resource.error

Modify an existing redirect.

Examples

iex> params = %{path: "/tiger"}

iex> ExShopify.Redirect.update(session, 668809255, params)
{:ok, redirect, meta}