Class: ThePlaidApi::ProcessorHistoricalUpdateWebhook

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/the_plaid_api/models/processor_historical_update_webhook.rb

Overview

This webhook is only sent to [Plaid processor partners](plaid.com/docs/auth/partnerships/). 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. 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 `/processor/transactions/get`; if you are using the newer `/processor/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.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(webhook_type:, webhook_code:, new_transactions:, account_id:, environment:, error: SKIP, additional_properties: nil) ⇒ ProcessorHistoricalUpdateWebhook

Returns a new instance of ProcessorHistoricalUpdateWebhook.



81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/the_plaid_api/models/processor_historical_update_webhook.rb', line 81

def initialize(webhook_type:, webhook_code:, new_transactions:, account_id:,
               environment:, error: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @webhook_type = webhook_type
  @webhook_code = webhook_code
  @error = error unless error == SKIP
  @new_transactions = new_transactions
  @account_id = 
  @environment = environment
  @additional_properties = additional_properties
end

Instance Attribute Details

#account_id ⇒ String

The ID of the account.

Returns:

  • (String) 


49
50
51
 
# File 'lib/the_plaid_api/models/processor_historical_update_webhook.rb', line 49

def 
  @account_id
end

#environment ⇒ WebhookEnvironmentValues

The Plaid environment the webhook was sent from

Returns:



53
54
55
 
# File 'lib/the_plaid_api/models/processor_historical_update_webhook.rb', line 53

def environment
  @environment
end

#error ⇒ Error

Errors are identified by ‘error_code` and categorized by `error_type`. Use these in preference to HTTP status codes to identify and handle specific errors. HTTP status codes are set and provide the broadest categorization of errors: 4xx codes are for developer- or user-related errors, and 5xx codes are for Plaid-related errors, and the status will be 2xx in non-error cases. An Item with a non-`null` error object will only be part of an API response when calling `/item/get` to view Item status. Otherwise, error fields will be `null` if no error has occurred; if an error has occurred, an error code will be returned instead.

Returns:



41
42
43
 
# File 'lib/the_plaid_api/models/processor_historical_update_webhook.rb', line 41

def error
  @error
end

#new_transactions ⇒ Float

The number of new transactions available

Returns:

  • (Float) 


45
46
47
 
# File 'lib/the_plaid_api/models/processor_historical_update_webhook.rb', line 45

def new_transactions
  @new_transactions
end

#webhook_code ⇒ String

‘HISTORICAL_UPDATE`

Returns:

  • (String) 


29
30
31
 
# File 'lib/the_plaid_api/models/processor_historical_update_webhook.rb', line 29

def webhook_code
  @webhook_code
end

#webhook_type ⇒ String

‘TRANSACTIONS`

Returns:

  • (String) 


25
26
27
 
# File 'lib/the_plaid_api/models/processor_historical_update_webhook.rb', line 25

def webhook_type
  @webhook_type
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/the_plaid_api/models/processor_historical_update_webhook.rb', line 96

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  webhook_type = hash.key?('webhook_type') ? hash['webhook_type'] : nil
  webhook_code = hash.key?('webhook_code') ? hash['webhook_code'] : nil
  new_transactions =
    hash.key?('new_transactions') ? hash['new_transactions'] : nil
   = hash.key?('account_id') ? hash['account_id'] : nil
  environment = hash.key?('environment') ? hash['environment'] : nil
  error = Error.from_hash(hash['error']) if hash['error']

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  ProcessorHistoricalUpdateWebhook.new(webhook_type: webhook_type,
                                       webhook_code: webhook_code,
                                       new_transactions: new_transactions,
                                       account_id: ,
                                       environment: environment,
                                       error: error,
                                       additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



56
57
58
59
60
61
62
63
64
65
 
# File 'lib/the_plaid_api/models/processor_historical_update_webhook.rb', line 56

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['webhook_type'] = 'webhook_type'
  @_hash['webhook_code'] = 'webhook_code'
  @_hash['error'] = 'error'
  @_hash['new_transactions'] = 'new_transactions'
  @_hash['account_id'] = 'account_id'
  @_hash['environment'] = 'environment'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



75
76
77
78
79
 
# File 'lib/the_plaid_api/models/processor_historical_update_webhook.rb', line 75

def self.nullables
  %w[
    error
  ]
end

.optionals ⇒ Object

An array for optional fields



68
69
70
71
72
 
# File 'lib/the_plaid_api/models/processor_historical_update_webhook.rb', line 68

def self.optionals
  %w[
    error
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



134
135
136
137
138
139
140
 
# File 'lib/the_plaid_api/models/processor_historical_update_webhook.rb', line 134

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} webhook_type: #{@webhook_type.inspect}, webhook_code:"\
  " #{@webhook_code.inspect}, error: #{@error.inspect}, new_transactions:"\
  " #{@new_transactions.inspect}, account_id: #{@account_id.inspect}, environment:"\
  " #{@environment.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



126
127
128
129
130
131
 
# File 'lib/the_plaid_api/models/processor_historical_update_webhook.rb', line 126

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} webhook_type: #{@webhook_type}, webhook_code: #{@webhook_code}, error:"\
  " #{@error}, new_transactions: #{@new_transactions}, account_id: #{@account_id},"\
  " environment: #{@environment}, additional_properties: #{@additional_properties}>"
end