View Source ExChargebee.Gift (ex_chargebee v0.4.5)

An interface for Interacting with gifts

For More information see Chargebee gift Documentation

Summary

Functions

cancel(resource_id, params \\ %{}, opts \\ [])

Perform a cancel on individual gift.

claim(resource_id, params \\ %{}, opts \\ [])

Perform a claim on individual gift.

create_for_items(params, opts \\ [])

Perform a gift create_for_items.

list(params \\ %{}, opts \\ [])

Returns a list of gifts. Pagination is handled automatically unless the opt paginate is set to false.

operations()
operations(group)
retrieve(resource_id, opts \\ [])
stream_list(params \\ %{}, opts \\ [])

Returns a stream of gifts. Pagination is handled automatically as the stream is consumed.

update_gift(resource_id, params \\ %{}, opts \\ [])

Perform a update_gift on individual gift.

Functions

Link to this function

cancel(resource_id, params \\ %{}, opts \\ [])

View Source 
@spec cancel(String.t(), map(), keyword()) :: map() | nil

Perform a cancel on individual gift.

Find more information in the Chargebee Documentation

Link to this function

claim(resource_id, params \\ %{}, opts \\ [])

View Source 
@spec claim(String.t(), map(), keyword()) :: map() | nil

Perform a claim on individual gift.

Find more information in the Chargebee Documentation

Link to this function

create_for_items(params, opts \\ [])

View Source 
@spec create_for_items(
  map(),
  keyword()
) :: map() | nil

Perform a gift create_for_items.

Find more information in the Chargebee Documentation

Link to this function

list(params \\ %{}, opts \\ [])

View Source 
@spec list(
  map(),
  keyword()
) :: [map()] | nil

Returns a list of gifts. Pagination is handled automatically unless the opt paginate is set to false.

opts:

  • site: the site to use for the request. Defaults to the default site.
  • paginate: whether to paginate the results. Defaults to false. If false, all results will be returned.
Link to this function

operations()

View Source 
@spec operations() :: Keyword.t()
Link to this function

operations(group)

View Source
Link to this function

retrieve(resource_id, opts \\ [])

View Source 
@spec retrieve(
  String.t(),
  keyword()
) :: map() | nil
Link to this function

stream_list(params \\ %{}, opts \\ [])

View Source 
@spec stream_list(
  map(),
  keyword()
) :: Enumerable.t()

Returns a stream of gifts. Pagination is handled automatically as the stream is consumed.

Link to this function

update_gift(resource_id, params \\ %{}, opts \\ [])

View Source 
@spec update_gift(String.t(), map(), keyword()) :: map() | nil

Perform a update_gift on individual gift.

Find more information in the Chargebee Documentation