View Source StarkInfra.IssuingPurchase.Log (starkinfra v0.1.0)

# IssuingPurchase.Log struct

Link to this section Summary

Functions

Every time an IssuingPurchase entity is updated, a corresponding IssuingPurchase.Log is generated for the entity. This log is never generated by the user, but it can be retrieved to check additional information on the IssuingPurchase.

Same as get(), but it will unwrap the error tuple and raise in case of errors.

Receive a single IssuingPurchase.Log struct previously created by the Stark Infra API by its id

Same as page(), but it will unwrap the error tuple and raise in case of errors.

Receive a list of up to 100 IssuingPurchase.Log structs previously created in the Stark Infra API and the cursor to the next page. Use this function instead of query if you want to manually page your requests.

Same as query(), but it will unwrap the error tuple and raise in case of errors.

Receive a stream of IssuingPurchase.Log structs previously created in the Stark Infra API

Link to this section Types

@type t() :: %StarkInfra.IssuingPurchase.Log{
  created: term(),
  errors: term(),
  id: term(),
  issuing_transaction_id: term(),
  purchase: term(),
  type: term()
}

Link to this section Functions

Link to this function

%StarkInfra.IssuingPurchase.Log{}

View Source (struct)

Every time an IssuingPurchase entity is updated, a corresponding IssuingPurchase.Log is generated for the entity. This log is never generated by the user, but it can be retrieved to check additional information on the IssuingPurchase.

attributes

Attributes:

  • :id [string]: unique id returned when the log is created. ex: "5656565656565656"
  • :purchase [IssuingPurchase]: IssuingPurchase entity to which the log refers to.
  • :issuing_transaction_id [string]: transaction ID related to the IssuingCard.
  • :errors [list of strings]: list of errors linked to this IssuingPurchase event
  • :type [string]: type of the IssuingPurchase event which triggered the log creation. ex: "approved", "canceled", "confirmed", "denied", "reversed", "voided".
  • :created [DateTime]: creation datetime for the log. ex: ~U[2020-03-10 10:30:0:0]

Same as get(), but it will unwrap the error tuple and raise in case of errors.

Receive a single IssuingPurchase.Log struct previously created by the Stark Infra API by its id

parameters-required

Parameters (required):

  • :id [string]: struct unique id. ex: "5656565656565656"

options

Options:

  • :user [Organization/Project, default nil]: Organization or Project struct returned from StarkInfra.project(). Only necessary if default project or organization has not been set in configs.

return

Return:

  • IssuingPurchase.Log struct with updated attributes
@spec page!(
  cursor: binary(),
  ids: [binary()],
  limit: integer(),
  after: Date.t() | binary(),
  before: Date.t() | binary(),
  types: [binary()],
  purchase_ids: [binary()],
  user: StarkInfra.User.Project.t() | StarkInfra.User.Organization.t() | nil
) :: any()

Same as page(), but it will unwrap the error tuple and raise in case of errors.

@spec page(
  cursor: binary(),
  ids: [binary()],
  limit: integer(),
  after: Date.t() | binary(),
  before: Date.t() | binary(),
  types: [binary()],
  purchase_ids: [binary()],
  user: StarkInfra.User.Project.t() | StarkInfra.User.Organization.t() | nil
) :: {:ok, {binary(), [t()]}} | {:error, [StarkInfra.Error.t()]}

Receive a list of up to 100 IssuingPurchase.Log structs previously created in the Stark Infra API and the cursor to the next page. Use this function instead of query if you want to manually page your requests.

options

Options:

  • :cursor [string, default nil]: cursor returned on the previous page function call
  • :ids [list of strings, default nil]: list of IssuingPurchase ids to filter logs. ex: ["5656565656565656", "4545454545454545"]
  • :limit [integer, default 100]: maximum number of structs to be retrieved. Unlimited if nil. ex: 35
  • :after [Date or string, default nil]: date filter for structs created only after specified date. ex: ~D[2020-03-25]
  • :before [Date or string, default nil]: date filter for structs created only before specified date. ex: ~D[2020-03-25]
  • :types [list of strings, default nil]: filter for log event types. ex: ["approved", "canceled", "confirmed", "denied", "reversed", "voided"]
  • :purchase_ids [list of strings, default nil]: list of Purchase ids to filter logs. ex: ["5656565656565656", "4545454545454545"]
  • :user [Organization/Project, default nil]: Organization or Project struct returned from StarkInfra.project(). Only necessary if default project or organization has not been set in configs.

return

Return:

  • list of IssuingPurchase.Log structs with updated attributes
  • cursor to retrieve the next page of IssuingPurchase.Log structs
@spec query!(
  ids: [binary()],
  limit: integer(),
  after: Date.t() | binary(),
  before: Date.t() | binary(),
  types: [binary()],
  purchase_ids: [binary()],
  user: StarkInfra.User.Project.t() | StarkInfra.User.Organization.t() | nil
) :: any()

Same as query(), but it will unwrap the error tuple and raise in case of errors.

@spec query(
  ids: [binary()],
  limit: integer(),
  after: Date.t() | binary(),
  before: Date.t() | binary(),
  types: [binary()],
  purchase_ids: [binary()],
  user: StarkInfra.User.Project.t() | StarkInfra.User.Organization.t() | nil
) :: {:ok, {binary(), [t()]}} | {:error, [StarkInfra.Error.t()]}

Receive a stream of IssuingPurchase.Log structs previously created in the Stark Infra API

options

Options:

  • :ids [list of strings, default nil]: list of IssuingPurchase ids to filter logs. ex: ["5656565656565656", "4545454545454545"]
  • :limit [integer, default nil]: maximum number of structs to be retrieved. Unlimited if nil. ex: 35
  • :after [Date or string, default nil]: date filter for structs created only after specified date. ex: ~D[2020-03-25]
  • :before [Date or string, default nil]: date filter for structs created only before specified date. ex: ~D[2020-03-25]
  • :types [list of strings, default nil]: filter for log event types. ex: ["approved", "canceled", "confirmed", "denied", "reversed", "voided"]
  • :purchase_ids [list of strings, default nil]: list of Purchase ids to filter logs. ex: ["5656565656565656", "4545454545454545"]
  • :user [Organization/Project, default nil]: Organization or Project struct returned from StarkInfra.project(). Only necessary if default project or organization has not been set in configs.

return

Return:

  • stream of IssuingPurchase.Log structs with updated attributes