class Plaid::HistoricalUpdateWebhook
- Plaid::HistoricalUpdateWebhook
- Reference
- Object
Overview
Fired when an Item's historical transaction pull is completed and Plaid has prepared as much historical transaction data as possible for the Item. Once this webhook has been fired, transaction data beyond the most recent 30 days can be fetched for the Item. If Account Select v2 is enabled, this webhook will also be fired if account selections for the Item are updated, with #new_transactions
set to the number of net new transactions pulled after the account selection update. This webhook is intended for use with /transactions/get
; if you are using the newer /transactions/sync
endpoint, this webhook will still be fired to maintain backwards compatibility, but it is recommended to listen for and respond to the SYNC_UPDATES_AVAILABLE
webhook instead.
Included Modules
- JSON::Serializable
- JSON::Serializable::Unmapped
- OpenApi::Json
- OpenApi::Validatable
Defined in:
plaid/models/historical_update_webhook.crConstructors
- .new(pull : JSON::PullParser)
-
.new(*, webhook_type : String | Nil = nil, webhook_code : String | Nil = nil, new_transactions : Float64 | Nil = nil, item_id : String | Nil = nil, environment : Plaid::WebhookEnvironmentValues | Nil = nil, error : PlaidError | Nil = nil)
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance Method Summary
-
#==(other : self)
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.
- #environment : Plaid::WebhookEnvironmentValues | Nil
-
#environment=(new_value : Plaid::WebhookEnvironmentValues | Nil)
Custom attribute writer method checking allowed values (enum).
- #error : PlaidError | Nil
-
#error=(new_value : PlaidError | Nil)
Custom attribute writer method checking allowed values (enum).
- #error_present=(error_present : Bool)
- #error_present? : Bool
-
#hash(hasher)
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.
- #item_id : String | Nil
-
#item_id=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
-
#list_invalid_properties : Array(String)
Show invalid properties with the reasons.
- #new_transactions : Float64 | Nil
-
#new_transactions=(new_value : Float64 | Nil)
Custom attribute writer method checking allowed values (enum).
-
#valid? : Bool
Check to see if the all the properties in the model are valid @return true if the model is valid
- #webhook_code : String | Nil
-
#webhook_code=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
- #webhook_type : String | Nil
-
#webhook_type=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
Instance methods inherited from module OpenApi::Json
after_initialize
after_initialize,
eql?(o : self)
eql?,
to_hash : Hash(String, JSON::Any)
to_hash,
to_json_any : JSON::Any
to_json_any
Class methods inherited from module OpenApi::Json
build_from_hash(hash : Hash)
build_from_hash,
build_from_json_any(json_any : JSON::Any)
build_from_json_any
Instance methods inherited from module OpenApi::Validatable
list_invalid_properties : Array(String)
list_invalid_properties,
list_invalid_properties_for(key : String) : Array(String)
list_invalid_properties_for,
valid? : Bool
valid?,
validate : Nil
validate
Constructor Detail
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance Method Detail
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] environment Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] error Object to be assigned
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] item_id Object to be assigned
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Custom attribute writer method checking allowed values (enum). @param [Object] new_transactions Object to be assigned
Check to see if the all the properties in the model are valid @return true if the model is valid
Custom attribute writer method checking allowed values (enum). @param [Object] webhook_code Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] webhook_type Object to be assigned