Marqeta.Credit.Policies (marqeta v1.0.0)

Copy Markdown View Source

Manage policy configurations: documents, APRs, fees, and rewards. Policies are attached to bundles which are then attached to accounts.

Summary

Functions

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

Creates a new credit policy.

create!(params \\ %{}, opts \\ [])

Creates a new credit policy. Raises Marqeta.Error on failure.

create_apr_policy(params, opts \\ [])

Creates an APR policy.

create_document_policy(params, opts \\ [])

Creates a document policy.

create_fee_policy(params, opts \\ [])

Creates a fee policy.

create_product_policy(params, opts \\ [])

Creates a credit product policy.

create_reward_policy(params, opts \\ [])

Creates a reward policy.

get(token, opts \\ [])

Retrieves a credit policy by token.

get!(token, opts \\ [])

Retrieves a credit policy by token. Raises Marqeta.Error on failure.

get_apr_policy(token, opts \\ [])

Retrieves an APR policy.

get_document_policy(token, opts \\ [])

Retrieves a document policy.

get_fee_policy(token, opts \\ [])

Retrieves a fee policy.

get_product_policy(token, opts \\ [])

Retrieves a credit product policy.

get_reward_policy(token, opts \\ [])

Retrieves a reward policy.

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

Lists credit policy resources.

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

Lists credit policy resources. Raises Marqeta.Error on failure.

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

Lists APR policies.

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

Lists document policies.

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

Lists fee policies.

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

Lists reward policies.

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

Returns a lazy Stream that auto-paginates credit policy resources.

update(token, params, opts \\ [])

Updates an existing credit policy.

update!(token, params, opts \\ [])

Updates an existing credit policy. Raises Marqeta.Error on failure.

update_apr_policy(token, params, opts \\ [])

Updates an APR policy.

update_document_policy(token, params, opts \\ [])

Updates a document policy.

update_fee_policy(token, params, opts \\ [])

Updates a fee policy.

update_product_policy(token, params, opts \\ [])

Updates a credit product policy.

update_reward_policy(token, params, opts \\ [])

Updates a reward policy.

Functions

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

@spec create(
  map(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Creates a new credit policy.

Returns {:ok, map()} on success, {:error, %Marqeta.Error{}} on failure.

create!(params \\ %{}, opts \\ [])

@spec create!(
  map(),
  keyword()
) :: map()

Creates a new credit policy. Raises Marqeta.Error on failure.

create_apr_policy(params, opts \\ [])

@spec create_apr_policy(
  map(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Creates an APR policy.

create_document_policy(params, opts \\ [])

@spec create_document_policy(
  map(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Creates a document policy.

create_fee_policy(params, opts \\ [])

@spec create_fee_policy(
  map(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Creates a fee policy.

create_product_policy(params, opts \\ [])

@spec create_product_policy(
  map(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Creates a credit product policy.

create_reward_policy(params, opts \\ [])

@spec create_reward_policy(
  map(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Creates a reward policy.

get(token, opts \\ [])

@spec get(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Retrieves a credit policy by token.

Returns {:ok, map()} on success, {:error, %Marqeta.Error{}} on failure.

get!(token, opts \\ [])

@spec get!(
  String.t(),
  keyword()
) :: map()

Retrieves a credit policy by token. Raises Marqeta.Error on failure.

get_apr_policy(token, opts \\ [])

@spec get_apr_policy(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Retrieves an APR policy.

get_document_policy(token, opts \\ [])

@spec get_document_policy(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Retrieves a document policy.

get_fee_policy(token, opts \\ [])

@spec get_fee_policy(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Retrieves a fee policy.

get_product_policy(token, opts \\ [])

@spec get_product_policy(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Retrieves a credit product policy.

get_reward_policy(token, opts \\ [])

@spec get_reward_policy(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Retrieves a reward policy.

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

@spec list(
  map(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Lists credit policy resources.

Accepts standard Marqeta pagination params: count, start_index, sort_by, sort_order, fields.

Use stream/2 to lazily iterate all pages automatically.

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

@spec list!(
  map(),
  keyword()
) :: map()

Lists credit policy resources. Raises Marqeta.Error on failure.

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

@spec list_apr_policies(
  map(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Lists APR policies.

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

@spec list_document_policies(
  map(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Lists document policies.

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

@spec list_fee_policies(
  map(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Lists fee policies.

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

@spec list_reward_policies(
  map(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Lists reward policies.

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

@spec stream(
  map(),
  keyword()
) :: Enumerable.t()

Returns a lazy Stream that auto-paginates credit policy resources.

update(token, params, opts \\ [])

@spec update(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, Marqeta.Error.t()}

Updates an existing credit policy.

Returns {:ok, map()} on success, {:error, %Marqeta.Error{}} on failure.

update!(token, params, opts \\ [])

@spec update!(String.t(), map(), keyword()) :: map()

Updates an existing credit policy. Raises Marqeta.Error on failure.

update_apr_policy(token, params, opts \\ [])

@spec update_apr_policy(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, Marqeta.Error.t()}

Updates an APR policy.

update_document_policy(token, params, opts \\ [])

@spec update_document_policy(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, Marqeta.Error.t()}

Updates a document policy.

update_fee_policy(token, params, opts \\ [])

@spec update_fee_policy(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, Marqeta.Error.t()}

Updates a fee policy.

update_product_policy(token, params, opts \\ [])

@spec update_product_policy(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, Marqeta.Error.t()}

Updates a credit product policy.

update_reward_policy(token, params, opts \\ [])

@spec update_reward_policy(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, Marqeta.Error.t()}

Updates a reward policy.