starkbank v0.2.0 StarkBank.Transfer.Log View Source
Groups Transfer.Log related functions
Link to this section Summary
Functions
Every time a Transfer entity is modified, a corresponding Transfer.Log is generated for the entity. This log is never generated by the user.
Receive a single Log struct previously created by the Stark Bank API by passing its id
Same as get(), but it will unwrap the error tuple and raise in case of errors.
Receive a stream of Log structs previously created in the Stark Bank API
Same as query(), but it will unwrap the error tuple and raise in case of errors.
Link to this section Types
Link to this section Functions
Every time a Transfer entity is modified, a corresponding Transfer.Log is generated for the entity. This log is never generated by the user.
Attributes:
:id
[string]: unique id returned when the log is created. ex: "5656565656565656":transfer
[Transfer]: Transfer entity to which the log refers to.:errors
[list of strings]: list of errors linked to this BoletoPayment event.:type
[string]: type of the Transfer event which triggered the log creation. ex: "processing" or "success":created
[DateTime]: creation datetime for the transfer. ex: ~U[2020-03-26 19:32:35.418698Z]
get(id, options \\ [])
View Sourceget(binary(), [{:user, StarkBank.User.Project.t() | nil}]) :: {:ok, StarkBank.Transfer.Log.t()} | {:error, [%StarkBank.Error{code: term(), message: term()}]}
Receive a single Log struct previously created by the Stark Bank API by passing its id
Parameters (required):
id
[string]: struct unique id. ex: "5656565656565656"
Options:
:user
[Project]: Project struct returned from StarkBank.project(). Only necessary if default project has not been set in configs.
Return:
- Log struct with updated attributes
get!(id, options \\ [])
View Sourceget!(binary(), [{:user, StarkBank.User.Project.t() | nil}]) :: StarkBank.Transfer.Log.t()
Same as get(), but it will unwrap the error tuple and raise in case of errors.
Receive a stream of Log structs previously created in the Stark Bank API
Options:
:limit
[integer, default nil]: maximum number of structs to be retrieved. Unlimited if nil. ex: 35:after
[Date | string, default nil]: date filter for structs created only after specified date. ex: Date(2020, 3, 10):before
[Date | string, default nil]: date filter for structs only before specified date. ex: Date(2020, 3, 10):types
[list of strings, default nil]: filter retrieved structs by types. ex: "success" or "failed":transfer_ids
[list of strings, default nil]: list of Transfer ids to filter retrieved structs. ex: ["5656565656565656", "4545454545454545"]:user
[Project]: Project struct returned from StarkBank.project(). Only necessary if default project has not been set in configs.
Return:
- stream of Log structs with updated attributes
Same as query(), but it will unwrap the error tuple and raise in case of errors.