Manage reward earning rules (e.g. 3x on dining, 1.5x on everything else).
Summary
Functions
Creates a new reward rule.
Creates a new reward rule. Raises Marqeta.Error on failure.
Retrieves a reward rule by token.
Retrieves a reward rule by token. Raises Marqeta.Error on failure.
Lists reward rule resources.
Lists reward rule resources. Raises Marqeta.Error on failure.
Returns a lazy Stream that auto-paginates reward rule resources.
Updates an existing reward rule.
Updates an existing reward rule. Raises Marqeta.Error on failure.
Functions
@spec create( map(), keyword() ) :: {:ok, map()} | {:error, Marqeta.Error.t()}
Creates a new reward rule.
Returns {:ok, map()} on success, {:error, %Marqeta.Error{}} on failure.
Creates a new reward rule. Raises Marqeta.Error on failure.
@spec get( String.t(), keyword() ) :: {:ok, map()} | {:error, Marqeta.Error.t()}
Retrieves a reward rule by token.
Returns {:ok, map()} on success, {:error, %Marqeta.Error{}} on failure.
Retrieves a reward rule by token. Raises Marqeta.Error on failure.
@spec list( map(), keyword() ) :: {:ok, map()} | {:error, Marqeta.Error.t()}
Lists reward rule resources.
Accepts standard Marqeta pagination params:
count, start_index, sort_by, sort_order, fields.
Use stream/2 to lazily iterate all pages automatically.
Lists reward rule resources. Raises Marqeta.Error on failure.
@spec stream( map(), keyword() ) :: Enumerable.t()
Returns a lazy Stream that auto-paginates reward rule resources.
@spec update(String.t(), map(), keyword()) :: {:ok, map()} | {:error, Marqeta.Error.t()}
Updates an existing reward rule.
Returns {:ok, map()} on success, {:error, %Marqeta.Error{}} on failure.
Updates an existing reward rule. Raises Marqeta.Error on failure.