starkbank v2.4.0 StarkBank.BoletoHolmes View Source
Groups BoletoHolmes related functions
Link to this section Summary
Functions
When you initialize a BoletoHolmes, the entity will not be automatically created in the Stark Bank API. The 'create' function sends the objects to the Stark Bank API and returns the list of created objects.
Send a list of BoletoHolmes objects for creation in the Stark Bank API
Same as create(), but it will unwrap the error tuple and raise in case of errors.
Receive a single BoletoHolmes struct previously created in 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 BoletoHolmes 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
When you initialize a BoletoHolmes, the entity will not be automatically created in the Stark Bank API. The 'create' function sends the objects to the Stark Bank API and returns the list of created objects.
Parameters (required):
:boleto_id
[string]: unique id of the investigated boleto. ex: "5656565656565656"
Parameters (optional):
:tags
[list of strings]: list of strings for tagging
Attributes (return-only):
:id
[string, default nil]: unique id returned when BoletoHolmes is created. ex: "5656565656565656":status
[string, default nil]: current BoletoHolmes status. ex: "solving" or "solved":result
[string, default nil]: result of boleto status investigation. ex: "paid" or "registered":created
[DateTime, default nil]: creation datetime for the BoletoHolmes. ex: ~U[2020-03-26 19:32:35.418698Z]:updated
[DateTime, default nil]: latest updated datetime for the BoletoHolmes. ex: ~U[2020-03-26 19:32:35.418698Z]
create(holmes, options \\ [])
View Sourcecreate([StarkBank.BoletoHolmes.t() | map()], [ {:user, StarkBank.User.Project.t() | StarkBank.User.Organization.t() | nil} ]) :: {:ok, [StarkBank.BoletoHolmes.t()]} | {:error, [StarkBank.Error.t()]}
Send a list of BoletoHolmes objects for creation in the Stark Bank API
Parameters (required):
holmes
[list of BoletoHolmes structs]: list of BoletoHolmes structs to be created in the API
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:
- list of BoletoHolmes structs with updated attributes
create!(holmes, options \\ [])
View Sourcecreate!([StarkBank.BoletoHolmes.t() | map()], [ {:user, StarkBank.User.Project.t() | StarkBank.User.Organization.t() | nil} ]) :: any()
Same as create(), but it will unwrap the error tuple and raise in case of errors.
get(id, options \\ [])
View Sourceget(binary(), [ {:user, StarkBank.User.Project.t() | StarkBank.User.Organization.t() | nil} ]) :: {:ok, StarkBank.BoletoHolmes.t()} | {:error, [%StarkBank.Error{code: term(), message: term()}]}
Receive a single BoletoHolmes struct previously created in 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:
- BoletoHolmes struct with updated attributes
get!(id, options \\ [])
View Sourceget!(binary(), [ {:user, StarkBank.User.Project.t() | StarkBank.User.Organization.t() | nil} ]) :: StarkBank.BoletoHolmes.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(), status: binary(), tags: [binary()], ids: [binary()], boleto_id: binary(), user: StarkBank.User.Project.t() | StarkBank.User.Organization.t() ) :: ({:cont, {:ok, [StarkBank.BoletoHolmes.t()]}} | {:error, [StarkBank.Error.t()]} | {:halt, any()} | {:suspend, any()}, any() -> any())
Receive a stream of BoletoHolmes 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]:status
[string, default nil]: filter for status of retrieved structs. ex: "solving" or "solved":tags
[list of strings, default nil]: tags to filter retrieved structs. ex: ["tony", "stark"]:ids
[list of strings, default nil]: list of ids to filter retrieved structs. ex: ["5656565656565656", "4545454545454545"]:boleto_id
[string, default nil]: filter for holmes that investigate a specific boleto by its ID. ex: "5656565656565656":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 BoletoHolmes structs with updated attributes
query!(options \\ [])
View Sourcequery!( limit: integer(), after: Date.t() | binary(), before: Date.t() | binary(), status: binary(), tags: [binary()], ids: [binary()], boleto_id: binary(), user: StarkBank.User.Project.t() | StarkBank.User.Organization.t() ) :: ({:cont, [StarkBank.BoletoHolmes.t()]} | {:halt, any()} | {:suspend, any()}, any() -> any())
Same as query(), but it will unwrap the error tuple and raise in case of errors.