starkbank v0.3.0 StarkBank.BoletoPayment.Log View Source
Groups BoletoPayment.Log related functions
Link to this section Summary
Functions
Every time a BoletoPayment entity is modified, a corresponding BoletoPayment.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 BoletoPayment.
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 BoletoPayment entity is modified, a corresponding BoletoPayment.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 BoletoPayment.
Attributes:
:id
[string]: unique id returned when the log is created. ex: "5656565656565656":payment
[BoletoPayment]: BoletoPayment entity to which the log refers to.:errors
[list of strings]: list of errors linked to this BoletoPayment event.:type
[string]: type of the BoletoPayment event which triggered the log creation. ex: "registered" or "paid":created
[DateTime]: creation datetime for the payment. ex: ~U[2020-03-26 19:32:35.418698Z]
get(id, options \\ [])
View Sourceget(binary(), [{:user, StarkBank.User.Project.t() | nil}]) :: {:ok, StarkBank.BoletoPayment.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.BoletoPayment.Log.t()
Same as get(), but it will unwrap the error tuple and raise in case of errors.
query(options \\ [])
View Sourcequery( limit: integer(), after: Date.t() | DateTime.t() | binary(), before: Date.t() | DateTime.t() | binary(), types: [binary()], payment_ids: [binary()], user: StarkBank.User.Project.t() ) :: ({:cont, {:ok, [StarkBank.BoletoPayment.Log.t()]}} | {:error, [StarkBank.Error.t()]} | {:halt, any()} | {:suspend, any()}, any() -> any())
Receive a stream of Log structs previously created in the Stark Bank API
Options:
:limit
[integer, default nil]: maximum number of entities to be retrieved. Unlimited if nil. ex: 35:after
[Date, DateTime or string, default nil]: date filter for entities created only after specified date. ex: Date(2020, 3, 10):before
[Date, DateTime or string, default nil]: date filter for entities created only before specified date. ex: Date(2020, 3, 10):types
[list of strings, default nil]: filter retrieved entities by event types. ex: "paid" or "registered":payment_ids
[list of strings, default nil]: list of BoletoPayment ids to filter retrieved entities. 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
query!(options \\ [])
View Sourcequery!( limit: integer(), after: Date.t() | DateTime.t() | binary(), before: Date.t() | DateTime.t() | binary(), types: [binary()], payment_ids: [binary()], user: StarkBank.User.Project.t() ) :: ({:cont, [StarkBank.BoletoPayment.Log.t()]} | {:halt, any()} | {:suspend, any()}, any() -> any())
Same as query(), but it will unwrap the error tuple and raise in case of errors.