View Source StarkInfra.IssuingWithdrawal (starkinfra v0.1.0)
# IssuingWithdrawal struct
Link to this section Summary
Functions
The IssuingWithdrawal structs created in your Workspace return cash from your Issuing balance to your Banking balance.
Same as create(), but it will unwrap the error tuple and raise in case of errors.
Send a list of IssuingWithdrawal structs for creation in the Stark Infra API
Same as get(), but it will unwrap the error tuple and raise in case of errors.
Receive a single IssuingWithdrawal struct previously created in 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 IssuingWithdrawal structs previously created in the Stark Infra API and the cursor to the next page.
Same as query(), but it will unwrap the error tuple and raise in case of errors.
Receive a stream of IssuingWithdrawal structs previously created in the Stark Infra API
Link to this section Types
Link to this section Functions
The IssuingWithdrawal structs created in your Workspace return cash from your Issuing balance to your Banking balance.
parameters-required
Parameters (required):
:amount
[integer]: IssuingWithdrawal value in cents. Minimum = 0 (any value will be accepted). ex: 1234 (= R$ 12.34):external_id
[string] IssuingWithdrawal external ID. ex: "12345":description
[string]: IssuingWithdrawal description. ex: "sending money back"
parameters-optional
Parameters (optional):
:tags
[list of strings, default []]: list of strings for tagging. ex: ["tony", "stark"]
attributes-return-only
Attributes (return-only):
:id
[string]: unique id returned when IssuingWithdrawal is created. ex: "5656565656565656":transaction_id
[string]: Stark Infra ledger transaction ids linked to this IssuingWithdrawal:issuing_transaction_id
[string]: issuing ledger transaction ids linked to this IssuingWithdrawal:updated
[DateTime]: latest update DateTime for the IssuingWithdrawal. ex: ~U[2020-3-10 10:30:0:0]:created
[DateTime]: creation datetime for the IssuingWithdrawal. ex: ~U[2020-03-10 10:30:0:0]
Same as create(), but it will unwrap the error tuple and raise in case of errors.
Send a list of IssuingWithdrawal structs for creation in the Stark Infra API
parameters-required
Parameters (required):
:withdrawal
[IssuingWithdrawal struct]: IssuingWithdrawal struct to be created in the API.
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:
- IssuingWithdrawal struct with updated attributes
Same as get(), but it will unwrap the error tuple and raise in case of errors.
Receive a single IssuingWithdrawal struct previously created in 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:
- IssuingWithdrawal struct with updated attributes
@spec page!( limit: integer(), external_ids: [binary()] | [], after: Date.t() | binary(), before: Date.t() | binary(), tags: [binary()], user: (StarkInfra.User.Organization.t() | StarkInfra.User.Project.t()) | nil ) :: any()
Same as page(), but it will unwrap the error tuple and raise in case of errors.
@spec page( limit: integer(), external_ids: [binary()] | [], after: Date.t() | binary(), before: Date.t() | binary(), tags: [binary()], user: (StarkInfra.User.Organization.t() | StarkInfra.User.Project.t()) | nil ) :: {:ok, [t()], binary()} | {:error, [StarkInfra.Error.t()]}
Receive a list of IssuingWithdrawal structs previously created in the Stark Infra API and the cursor to the next page.
options
Options:
:limit
[integer, default 100]: maximum number of structs to be retrieved. Unlimited if nil. ex: 35:external_ids
[list of strings, default []]: external IDs. ex: ["5656565656565656", "4545454545454545"]: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]:tags
[list of strings, default nil]: tags to filter retrieved structs. ex: ["tony", "stark"]: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 IssuingWithdrawal structs with updated attributes
- cursor to retrieve the next page of IssuingWithdrawal structs
@spec query!( limit: integer(), external_ids: [binary()] | [], after: Date.t() | binary(), before: Date.t() | binary(), tags: [binary()], user: (StarkInfra.User.Organization.t() | StarkInfra.User.Project.t()) | nil ) :: any()
Same as query(), but it will unwrap the error tuple and raise in case of errors.
@spec query( limit: integer(), external_ids: [binary()] | [], after: Date.t() | binary(), before: Date.t() | binary(), tags: [binary()], user: (StarkInfra.User.Organization.t() | StarkInfra.User.Project.t()) | nil ) :: {:ok, [t()]} | {:error, [StarkInfra.Error.t()]}
Receive a stream of IssuingWithdrawal structs previously created in the Stark Infra API
options
Options:
:limit
[integer, default nil]: maximum number of structs to be retrieved. Unlimited if nil. ex: 35:external_ids
[list of strings, default []]: external IDs. ex: ["5656565656565656", "4545454545454545"]: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]:tags
[list of strings, default nil]: tags to filter retrieved structs. ex: ["tony", "stark"]: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 IssuingWithdrawals structs with updated attributes