Skip to content

Updated spec to match documentations #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jeremy-postmates wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updated spec to match documentations #98

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions lib/shopify/resource.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ defmodule Shopify.Resource do
iex> Shopify.session |> Shopify.Product.find(id)
{:ok, %Shopify.Response{}}
"""
@spec find(%Shopify.Session{}, map) ::
{:ok, Shopify.Response.t()} | {:error, Shopify.Error.t()}
def find(session, id, params \\ %{}) do
session
|> Request.new(find_url(id), params, singular_resource())
Expand All @@ -41,6 +43,8 @@ defmodule Shopify.Resource do
iex> Shopify.session |> Shopify.Product.all
{:ok, %Shopify.Response{}}
"""
@spec all(%Shopify.Session{}, map) ::
{:ok, Shopify.Response.t()} | {:error, Shopify.Error.t()}
def all(session, params \\ %{}) do
session
|> Request.new(all_url(), params, plural_resource())
Expand All @@ -62,6 +66,8 @@ defmodule Shopify.Resource do
iex> Shopify.session |> Shopify.Product.count
{:ok, %Shopify.Response{}}
"""
@spec count(%Shopify.Session{}, map) ::
{:ok, Shopify.Response.t()} | {:error, Shopify.Error.t()}
def count(session, params \\ %{}) do
session
|> Request.new(count_url(), params, nil)
Expand All @@ -83,7 +89,8 @@ defmodule Shopify.Resource do
iex> Shopify.session |> Shopify.Product.search
{:ok, %Shopify.Response{}}
"""
@spec search(%Shopify.Session{}, map) :: {:ok, list} | {:error, map}
@spec search(%Shopify.Session{}, map) ::
{:ok, Shopify.Response.t()} | {:error, Shopify.Error.t()}
def search(session, params \\ %{}) do
session
|> Request.new(search_url(), params, plural_resource())
Expand All @@ -105,7 +112,8 @@ defmodule Shopify.Resource do
iex> Shopify.session |> Shopify.Product.create(%Shopify.Product{})
{:ok, %Shopify.Response{}}
"""
@spec create(%Shopify.Session{}, map) :: {:ok, list} | {:error, map}
@spec create(%Shopify.Session{}, map) ::
{:ok, Shopify.Response.t()} | {:error, Shopify.Error.t()}
def create(session, new_resource) do
body = new_resource |> to_json

Expand All @@ -130,6 +138,8 @@ defmodule Shopify.Resource do
iex> Shopify.session |> Shopify.Product.update(id, %Shopify.Product{})
{:ok, %Shopify.Response{}}
"""
@spec update(%Shopify.Session{}, String.t(), map) ::
{:ok, Shopify.Response.t()} | {:error, Shopify.Error.t()}
def update(session, id, updated_resource) do
body = updated_resource |> to_json

Expand All @@ -153,6 +163,8 @@ defmodule Shopify.Resource do
iex> Shopify.session |> Shopify.Product.delete(id)
{:ok, %Shopify.Response{}}
"""
@spec delete(%Shopify.Session{}, String.t()) ::
{:ok, Shopify.Response.t()} | {:error, Shopify.Error.t()}
def delete(session, id) do
session
|> Request.new(find_url(id), %{}, nil)
Expand Down