Liking cljdoc? Tell your friends :D
starkbank.event
An Event is the notification received from the subscription to the Webhook. Events cannot be created, but may be retrieved from the Stark Bank API to list all generated updates on entities.
Attributes:
:id[string]: unique id returned when the event is created. ex: "5656565656565656":log[Log]: a Log map from one the subscription services (Transfer.Log, Boleto.Log, BoletoPayment.log or UtilityPayment.Log):created[string]: creation datetime for the notification event. ex: "2020-03-26T19:32:35.418698+00:00":is-delivered[bool]: true if the event has been successfully delivered to the user url. ex: false:subscription[string]: service that triggered this event. ex: "transfer", "utility-payment"
An Event is the notification received from the subscription to the Webhook. Events cannot be created, but may be retrieved from the Stark Bank API to list all generated updates on entities. ## Attributes: - `:id` [string]: unique id returned when the event is created. ex: "5656565656565656" - `:log` [Log]: a Log map from one the subscription services (Transfer.Log, Boleto.Log, BoletoPayment.log or UtilityPayment.Log) - `:created` [string]: creation datetime for the notification event. ex: "2020-03-26T19:32:35.418698+00:00" - `:is-delivered` [bool]: true if the event has been successfully delivered to the user url. ex: false - `:subscription` [string]: service that triggered this event. ex: "transfer", "utility-payment"
deleteclj
(delete id)(delete id user)Delete a list of notification Event entities previously created in the Stark Bank API
Parameters (required):
id[string]: Event unique id. ex: "5656565656565656"
Options:
:user[Project or Organization]: Project or Organization map returned from starkbank.user/project or starkbank.user/organization. Only necessary if starkbank.settings/user has not been set.
Return:
- deleted Event map with updated attributes
Delete a list of notification Event entities previously created in the Stark Bank API ## Parameters (required): - `id` [string]: Event unique id. ex: "5656565656565656" ## Options: - `:user` [Project or Organization]: Project or Organization map returned from starkbank.user/project or starkbank.user/organization. Only necessary if starkbank.settings/user has not been set. ## Return: - deleted Event map with updated attributes
getclj
(get id)(get id user)Receive a single notification Event map previously created in the Stark Bank API by passing its id
Parameters (required):
id[string]: map unique id. ex: "5656565656565656"
Options:
:user[Project or Organization]: Project or Organization map returned from starkbank.user/project or starkbank.user/organization. Only necessary if starkbank.settings/user has not been set.
Return:
- Event map with updated attributes
Receive a single notification Event map previously created in the Stark Bank API by passing its id ## Parameters (required): - `id` [string]: map unique id. ex: "5656565656565656" ## Options: - `:user` [Project or Organization]: Project or Organization map returned from starkbank.user/project or starkbank.user/organization. Only necessary if starkbank.settings/user has not been set. ## Return: - Event map with updated attributes
parseclj
(parse content signature)(parse content signature user)Create a single Event map received from event listening at subscribed user endpoint. If the provided digital signature does not check out with the StarkBank public key, an "invalidSignature" error will be returned.
Parameters (required):
content[string]: response content from request received at user endpoint (not parsed)signature[string]: base-64 digital signature received at response header "Digital-Signature"
Parameters (optional):
cache-pid[PID, default nil]: PID of the process that holds the public key cache, returned on previous parses. If not provided, a new cache process will be generated.user[Project]: Project map returned from StarkBank.project(). Only necessary if default project has not been set in configs.
Return:
- Event map with updated attributes
- Cache PID that holds the Stark Bank public key in order to avoid unnecessary requests to the API on future parses
Create a single Event map received from event listening at subscribed user endpoint. If the provided digital signature does not check out with the StarkBank public key, an "invalidSignature" error will be returned. ## Parameters (required): - `content` [string]: response content from request received at user endpoint (not parsed) - `signature` [string]: base-64 digital signature received at response header "Digital-Signature" ## Parameters (optional): - `cache-pid` [PID, default nil]: PID of the process that holds the public key cache, returned on previous parses. If not provided, a new cache process will be generated. - `user` [Project]: Project map returned from StarkBank.project(). Only necessary if default project has not been set in configs. ## Return: - Event map with updated attributes - Cache PID that holds the Stark Bank public key in order to avoid unnecessary requests to the API on future parses
queryclj
(query)(query params)(query params user)Receive a stream of notification Event maps previously created in the Stark Bank API
Options:
:limit[integer, default nil]: maximum number of maps to be retrieved. Unlimited if nil. ex: 35:after[string, default nil]: date filter for maps created only after specified date. ex: ~D[2020-03-25]:before[string, default nil]: date filter for maps created only before specified date. ex: ~D[2020-03-25]:is-delivered[bool, default nil]: filter successfully delivered events. ex: true or false:user[Project or Organization]: Project or Organization map returned from starkbank.user/project or starkbank.user/organization. Only necessary if starkbank.settings/user has not been set.
Return:
- stream of Event maps with updated attributes
Receive a stream of notification Event maps previously created in the Stark Bank API ## Options: - `:limit` [integer, default nil]: maximum number of maps to be retrieved. Unlimited if nil. ex: 35 - `:after` [string, default nil]: date filter for maps created only after specified date. ex: ~D[2020-03-25] - `:before` [string, default nil]: date filter for maps created only before specified date. ex: ~D[2020-03-25] - `:is-delivered` [bool, default nil]: filter successfully delivered events. ex: true or false - `:user` [Project or Organization]: Project or Organization map returned from starkbank.user/project or starkbank.user/organization. Only necessary if starkbank.settings/user has not been set. ## Return: - stream of Event maps with updated attributes
updateclj
(update id params)(update id params user)Update notification Event by passing id. If is-delivered is true, the event will no longer be returned on queries with is-delivered=false.
Parameters (required):
id[list of strings]: Event unique ids. ex: "5656565656565656":is-delivered[bool]: If true and event hasn't been delivered already, event will be set as delivered. ex: true
Parameters (optional):
:user[Project or Organization]: Project or Organization map returned from starkbank.user/project or starkbank.user/organization. Only necessary if starkbank.settings/user has not been set.
Return:
- target Event with updated attributes
Update notification Event by passing id. If is-delivered is true, the event will no longer be returned on queries with is-delivered=false. ## Parameters (required): - `id` [list of strings]: Event unique ids. ex: "5656565656565656" - `:is-delivered` [bool]: If true and event hasn't been delivered already, event will be set as delivered. ex: true ## Parameters (optional): - `:user` [Project or Organization]: Project or Organization map returned from starkbank.user/project or starkbank.user/organization. Only necessary if starkbank.settings/user has not been set. ## Return: - target Event with updated attributes
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close