shopify v0.1.3 Shopify.RecurringApplicationCharge
Summary
Functions
Requests to activate the reucrring charge
Requests all resources
Requests to create a new resource
Requests to delete a resource by id
Requests a resource by id
Functions
Requests to activate the reucrring charge.
Returns {:ok, resource}
or {:error, %Shopify.Error{}}
Parameters
- session: A
%Shopify.Session{}
struct. - id: The id of the resource.
Examples
iex> Shopify.session |> Shopify.RecurringApplicationCharge.activate(id)
{:ok, %Shopify.RecurringApplicationCharge{}}
Requests all resources.
Returns {:ok, [resources]}
or {:error, %Shopify.Error{}}
Parameters
- session: A
%Shopify.Session{}
struct. - params: Any additional query params.
Examples
iex> Shopify.session |> Shopify.Product.all
{:ok, [%Shopify.Product{}]}
Requests to create a new resource.
Returns {:ok, resource}
or {:error, %Shopify.Error{}}
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.Product{}}
Requests to delete a resource by id.
Returns {:ok, resource}
or {:error, %Shopify.Error{}}
Parameters
- session: A
%Shopify.Session{}
struct. - id: The id of the resource.
Examples
iex> Shopify.session |> Shopify.Product.delete(id)
{:ok, nil}