Marqeta.BulkCardOrders (marqeta v1.0.0)

Copy Markdown View Source

Order physical cards in bulk. Bulk orders share a single card product and fulfillment configuration.

Summary

Functions

Creates a new bulk card order.

Creates a new bulk card order. Raises Marqeta.Error on failure.

Retrieves a bulk card order by token.

Retrieves a bulk card order by token. Raises Marqeta.Error on failure.

Lists bulk card order resources.

Lists bulk card order resources. Raises Marqeta.Error on failure.

Lists cards generated by a bulk order.

Returns a lazy Stream that auto-paginates bulk card order resources.

Functions

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

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

Creates a new bulk card order.

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

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

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

Creates a new bulk card order. Raises Marqeta.Error on failure.

get(token, opts \\ [])

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

Retrieves a bulk card order by token.

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

get!(token, opts \\ [])

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

Retrieves a bulk card order by token. Raises Marqeta.Error on failure.

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

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

Lists bulk card order 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 bulk card order resources. Raises Marqeta.Error on failure.

list_cards(token, params \\ %{}, opts \\ [])

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

Lists cards generated by a bulk order.

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

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

Returns a lazy Stream that auto-paginates bulk card order resources.