class

Plaid::SyncUpdatesAvailableWebhook

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

Fired when an Item's transactions change. This can be due to any event resulting in new changes, such as an initial 30-day transactions fetch upon the initialization of an Item with transactions, the backfill of historical transactions that occurs shortly after, or when changes are populated from a regularly-scheduled transactions update job. It is recommended to listen for the SYNC_UPDATES_AVAILABLE webhook when using the /transactions/sync endpoint. Note that when using /transactions/sync the older webhooks INITIAL_UPDATE, HISTORICAL_UPDATE, DEFAULT_UPDATE, and TRANSACTIONS_REMOVED, which are intended for use with /transactions/get, will also continue to be sent in order to maintain backwards compatibility. It is not necessary to listen for and respond to those webhooks when using /transactions/sync. After receipt of this webhook, the new changes can be fetched for the Item from /transactions/sync. Note that to receive this webhook for an Item, /transactions/sync must have been called at least once on that Item. This means that, unlike the INITIAL_UPDATE and HISTORICAL_UPDATE webhooks, it will not fire immediately upon Item creation. If /transactions/sync is called on an Item that was not initialized with Transactions, the webhook will fire twice: once the first 30 days of transactions data has been fetched, and a second time when all available historical transactions data has been fetched. This webhook will fire in the Sandbox environment as it would in Production. It can also be manually triggered in Sandbox by calling /sandbox/item/fire_webhook.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, webhook_type : String | Nil = nil, webhook_code : String | Nil = nil, item_id : String | Nil = nil, initial_update_complete : Bool | Nil = nil, historical_update_complete : Bool | Nil = nil, environment : Plaid::WebhookEnvironmentValues | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

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
Source
environment=(new_value : Plaid::WebhookEnvironmentValues | Nil)

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

Source
hash(hasher)

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

historical_update_complete

Indicates if historical pull information is available.

Source
historical_update_complete=(new_value : Bool | Nil)

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

Source
initial_update_complete

Indicates if initial pull information is available.

Source
initial_update_complete=(new_value : Bool | Nil)

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

Source
item_id

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

Source
item_id=(new_value : String | Nil)

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

Source
list_invalid_properties

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

Source
valid?

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

Source
webhook_code

SYNC_UPDATES_AVAILABLE

Source
webhook_code=(new_value : String | Nil)

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

Source
webhook_type

TRANSACTIONS

Source
webhook_type=(new_value : String | Nil)

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

Source