conekta_ex v1.0.1 ConektaEx.Plan
Link to this section Summary
Functions
Creates a plan
Deletes a plan with plan_id
Retrieves a list of plans
Gets a ConektaEx.StructList with ‘data’ as a list of
ConektaEx.Plan.
See ConektaEx.StructList.request_next/2
for examples
Gets a ConektaEx.StructList with ‘data’ as a list of
ConektaEx.Plan.
See ConektaEx.StructList.request_previous/2
for examples
Retrieves a plan with plan_id
Updates a plan with plan_id and Map attrs
Link to this section Types
Link to this section Functions
Creates a plan.
Examples
iex> create(map_with_valid_params)
{:ok, %ConektaEx.Plan{}}
iex> create(map_with_bad_params)
{:error, %ConektaEx.Error{}}
delete(binary()) :: {:ok, t()} | {:error, ConektaEx.Error.t()}
Deletes a plan with plan_id
Examples
iex> delete(ok_plan_id)
{:ok, %ConektaEx.Plan{}}
iex> delete(bad_plan_id)
{:error, %ConektaEx.Error{}}
list() :: {:ok, ConektaEx.StructList.t()} | {:error, ConektaEx.Error.t()}
Retrieves a list of plans.
next_page(ConektaEx.StructList.t(), any()) :: {:ok, ConektaEx.StructList.t()} | {:error, ConektaEx.Error.t()}
Gets a ConektaEx.StructList with ‘data’ as a list of
ConektaEx.Plan.
See ConektaEx.StructList.request_next/2
for examples.
previous_page(ConektaEx.StructList.t(), any()) :: {:ok, ConektaEx.StructList.t()} | {:error, ConektaEx.Error.t()}
Gets a ConektaEx.StructList with ‘data’ as a list of
ConektaEx.Plan.
See ConektaEx.StructList.request_previous/2
for examples.
retrieve(binary()) :: {:ok, t()} | {:error, ConektaEx.Error.t()}
Retrieves a plan with plan_id
Examples
iex> retrieve(ok_plan_id)
{:ok, %ConektaEx.Plan{}}
iex> retrieve(bad_plan_id)
{:error, %ConektaEx.Error{}}
update(binary(), map()) :: {:ok, t()} | {:error, ConektaEx.Error.t()}
Updates a plan with plan_id and Map attrs
Examples
iex> update(ok_plan_id, ok_attrs)
{:ok, %ConektaEx.Plan{}}
iex> update(bad_plan_id, ok_attrs)
{:error, %ConektaEx.Error{}}