shopify

v0.4.0

shopify v0.4.0 Shopify.RecurringApplicationCharge

Link to this section Summary

Functions

activate(session, id)

Requests to activate the recurring charge

all(session, params \\ %{})

Requests all resources

create(session, new_resource)

Requests to create a new resource

delete(session, id)

Requests to delete a resource by id

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

Requests a resource by id

Link to this section Functions

Link to this function activate(session, id)

Requests to activate the recurring 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{}}
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 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 delete(session, id)

Requests to delete a resource by id.

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.Product.delete(id)
{: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{}}