starkbank v2.3.0 StarkBank.BoletoHolmes.Log View Source
Groups BoletoHolmes.Log related functions
Link to this section Summary
Functions
Every time a BoletoHolmes entity is updated, a corresponding BoletoHolmes.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 BoletoHolmes.
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 BoletoHolmes entity is updated, a corresponding BoletoHolmes.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 BoletoHolmes.
Attributes:
:id
[string]: unique id returned when the log is created. ex: "5656565656565656":holmes
[BoletoHolmes]: BoletoHolmes entity to which the log refers to.:type
[string]: type of the BoletoHolmes event which triggered the log creation. ex: "solving" or "solved":created
[DateTime]: creation datetime for the log. ex: ~U[2020-03-26 19:32:35.418698Z]
get(id, options \\ [])
View Sourceget(binary(), [ {:user, StarkBank.User.Project.t() | StarkBank.User.Organization.t() | nil} ]) :: {:ok, StarkBank.BoletoHolmes.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
[Organization/Project]: Organization or Project struct returned from StarkBank.project(). Only necessary if default project or organization has not been set in configs.
Return:
- Log struct with updated attributes
get!(id, options \\ [])
View Sourceget!(binary(), [ {:user, StarkBank.User.Project.t() | StarkBank.User.Organization.t() | nil} ]) :: StarkBank.BoletoHolmes.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() | binary(), before: Date.t() | binary(), types: [binary()], holmes_ids: [binary()], user: StarkBank.User.Project.t() | StarkBank.User.Organization.t() ) :: ({:cont, {:ok, [StarkBank.BoletoHolmes.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 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: "paid" or "registered":holmes_ids
[list of strings, default nil]: list of BoletoHolmes ids to filter logs. ex: ["5656565656565656", "4545454545454545"]:user
[Organization/Project]: Organization or Project struct returned from StarkBank.project(). Only necessary if default project or organization 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.