class

Plaid::HistoricalUpdateWebhook

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

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.

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable 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 methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

environment

environment=(new_value : Plaid::WebhookEnvironmentValues | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] environment Object to be assigned

error

error=(new_value : PlaidError | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] error Object to be assigned

error_present=(error_present : Bool)

error_present?

hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

item_id

The item_id of the Item associated with this webhook, warning, or error

item_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] item_id Object to be assigned

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

new_transactions

The number of new, unfetched transactions available

new_transactions=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] new_transactions Object to be assigned

valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

webhook_code

HISTORICAL_UPDATE

webhook_code=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] webhook_code Object to be assigned

webhook_type

TRANSACTIONS

webhook_type=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] webhook_type Object to be assigned