shopify

v0.4.0

shopify v0.4.0 Shopify.Comment

Link to this section Summary

Functions

all(session, params \\ %{})

Requests all resources

approve(session, id)

Requests to approve a comment that is currently pending unapproved so that it will be published on the site

count(session, params \\ %{})

Requests the resource count

create(session, new_resource)

Requests to create a new resource

find(session, id, params \\ %{})

Requests a resource by id

not_spam(session, id)

Requests to mark a comment as not spam

remove(session, id)

Requests to remove a comment

restore(session, id)

Requests to restore a comment

spam(session, id)

Requests to mark a comment as spam

update(session, id, updated_resource)

Requests to update a resource by id

Link to this section Functions

Link to this function all(session, params \\ %{})

Requests all resources.

Returns {:ok, %Shopify.Response{}} or {:error, %Shopify.Response{}}

Parameters

  • session: A %Shopify.Session{} struct.
  • params: Any additional query params.

Examples 

iex> Shopify.session |> Shopify.Product.all
{:ok, %Shopify.Response{}}
Link to this function approve(session, id) 
approve(
  %Shopify.Session{
    access_token: term(),
    api_key: term(),
    api_version: term(),
    client_id: term(),
    client_secret: term(),
    password: term(),
    req_opts: term(),
    shop_name: term(),
    type: term()
  },
  integer()
) ::
  {:ok,
   %Shopify.Comment{
     article_id: term(),
     author: term(),
     blog_id: term(),
     body: term(),
     body_html: term(),
     created_at: term(),
     email: term(),
     id: term(),
     ip: term(),
     published_at: term(),
     status: term(),
     updated_at: term(),
     user_agent: term()
   }}
  | {:error, map()}

Requests to approve a comment that is currently pending unapproved so that it will be published on the site.

Returns {:ok, %Shopify.Response{}} or {:error, %Shopify.Response{}}

Parameters

  • session: A %Shopify.Session{} struct.
  • id: The id of the resource.

Examples 

iex> Shopify.session |> Shopify.Comment.approve(1)
{:ok, %Shopify.Response{}}
Link to this function count(session, params \\ %{})

Requests the resource count.

Returns {:ok, %Shopify.Response{}} or {:error, %Shopify.Response{}}

Parameters

  • session: A %Shopify.Session{} struct.
  • params: Any additional query params.

Examples 

iex> Shopify.session |> Shopify.Product.count
{:ok, %Shopify.Response{}}
Link to this function create(session, new_resource) 
create(
  %Shopify.Session{
    access_token: term(),
    api_key: term(),
    api_version: term(),
    client_id: term(),
    client_secret: term(),
    password: term(),
    req_opts: term(),
    shop_name: term(),
    type: term()
  },
  map()
) :: {:ok, list()} | {:error, map()}

Requests to create a new resource.

Returns {:ok, %Shopify.Response{}} or {:error, %Shopify.Response{}}

Parameters

  • session: A %Shopify.Session{} struct.
  • new_resource: A struct of the resource being created.

Examples 

iex> Shopify.session |> Shopify.Product.create(%Shopify.Product{})
{:ok, %Shopify.Response{}}
Link to this function find(session, id, params \\ %{})

Requests a resource by id.

Returns {:ok, %Shopify.Response{}} or {:error, %Shopify.Response{}}

Parameters

  • session: A %Shopify.Session{} struct.
  • id: The id of the resource.
  • params: Any additional query params.

Examples 

iex> Shopify.session |> Shopify.Product.find(id)
{:ok, %Shopify.Response{}}
Link to this function not_spam(session, id) 
not_spam(
  %Shopify.Session{
    access_token: term(),
    api_key: term(),
    api_version: term(),
    client_id: term(),
    client_secret: term(),
    password: term(),
    req_opts: term(),
    shop_name: term(),
    type: term()
  },
  integer()
) ::
  {:ok,
   %Shopify.Comment{
     article_id: term(),
     author: term(),
     blog_id: term(),
     body: term(),
     body_html: term(),
     created_at: term(),
     email: term(),
     id: term(),
     ip: term(),
     published_at: term(),
     status: term(),
     updated_at: term(),
     user_agent: term()
   }}
  | {:error, map()}

Requests to mark a comment as not spam.

Returns {:ok, %Shopify.Response{}} or {:error, %Shopify.Response{}}

Parameters

  • session: A %Shopify.Session{} struct.
  • id: The id of the resource.

Examples 

iex> Shopify.session |> Shopify.Comment.not_spam(1)
{:ok, %Shopify.Response{}}
Link to this function remove(session, id) 
remove(
  %Shopify.Session{
    access_token: term(),
    api_key: term(),
    api_version: term(),
    client_id: term(),
    client_secret: term(),
    password: term(),
    req_opts: term(),
    shop_name: term(),
    type: term()
  },
  integer()
) ::
  {:ok,
   %Shopify.Comment{
     article_id: term(),
     author: term(),
     blog_id: term(),
     body: term(),
     body_html: term(),
     created_at: term(),
     email: term(),
     id: term(),
     ip: term(),
     published_at: term(),
     status: term(),
     updated_at: term(),
     user_agent: term()
   }}
  | {:error, map()}

Requests to remove a comment.

Returns {:ok, %Shopify.Response{}} or {:error, %Shopify.Response{}}

Parameters

  • session: A %Shopify.Session{} struct.
  • id: The id of the resource.

Examples 

iex> Shopify.session |> Shopify.Comment.remove(1)
{:ok, %Shopify.Response{}}
Link to this function restore(session, id) 
restore(
  %Shopify.Session{
    access_token: term(),
    api_key: term(),
    api_version: term(),
    client_id: term(),
    client_secret: term(),
    password: term(),
    req_opts: term(),
    shop_name: term(),
    type: term()
  },
  integer()
) ::
  {:ok,
   %Shopify.Comment{
     article_id: term(),
     author: term(),
     blog_id: term(),
     body: term(),
     body_html: term(),
     created_at: term(),
     email: term(),
     id: term(),
     ip: term(),
     published_at: term(),
     status: term(),
     updated_at: term(),
     user_agent: term()
   }}
  | {:error, map()}

Requests to restore a comment.

Returns {:ok, %Shopify.Response{}} or {:error, %Shopify.Response{}}

Parameters

  • session: A %Shopify.Session{} struct.
  • id: The id of the resource.

Examples 

iex> Shopify.session |> Shopify.Comment.restore(1)
{:ok, %Shopify.Response{}}
Link to this function spam(session, id) 
spam(
  %Shopify.Session{
    access_token: term(),
    api_key: term(),
    api_version: term(),
    client_id: term(),
    client_secret: term(),
    password: term(),
    req_opts: term(),
    shop_name: term(),
    type: term()
  },
  integer()
) ::
  {:ok,
   %Shopify.Comment{
     article_id: term(),
     author: term(),
     blog_id: term(),
     body: term(),
     body_html: term(),
     created_at: term(),
     email: term(),
     id: term(),
     ip: term(),
     published_at: term(),
     status: term(),
     updated_at: term(),
     user_agent: term()
   }}
  | {:error, map()}

Requests to mark a comment as spam.

Returns {:ok, %Shopify.Response{}} or {:error, %Shopify.Response{}}

Parameters

  • session: A %Shopify.Session{} struct.
  • id: The id of the resource.

Examples 

iex> Shopify.session |> Shopify.Comment.spam(1)
{:ok, %Shopify.Response{}}
Link to this function update(session, id, updated_resource)

Requests to update a resource by id.

Returns {:ok, %Shopify.Response{}} or {:error, %Shopify.Response{}}

Parameters

  • session: A %Shopify.Session{} struct.
  • id: The id of the resource.
  • updated_resource: A struct of the resource being updated.

Examples 

iex> Shopify.session |> Shopify.Product.update(id, %Shopify.Product{})
{:ok, %Shopify.Response{}}