Class: ThePlaidApi::RecurringTransactionsUpdateWebhook

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

Overview

Fired when recurring transactions data is updated. This includes when a new recurring stream is detected or when a new transaction is added to an existing recurring stream. The ‘RECURRING_TRANSACTIONS_UPDATE` webhook will also fire when one or more attributes of the recurring stream changes, which is usually a result of the addition, update, or removal of transactions to the stream. After receipt of this webhook, the updated data can be fetched from `/transactions/recurring/get`.

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:, item_id:, account_ids:, environment:, additional_properties: nil) ⇒ RecurringTransactionsUpdateWebhook

Returns a new instance of RecurringTransactionsUpdateWebhook.



60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/the_plaid_api/models/recurring_transactions_update_webhook.rb', line 60

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

  @webhook_type = webhook_type
  @webhook_code = webhook_code
  @item_id = item_id
  @account_ids = 
  @environment = environment
  @additional_properties = additional_properties
end

Instance Attribute Details

#account_ids ⇒ Array[String]

A list of ‘account_ids` for accounts that have new or updated recurring transactions data.

Returns:

  • (Array[String]) 


33
34
35
 
# File 'lib/the_plaid_api/models/recurring_transactions_update_webhook.rb', line 33

def 
  @account_ids
end

#environment ⇒ WebhookEnvironmentValues

The Plaid environment the webhook was sent from

Returns:



37
38
39
 
# File 'lib/the_plaid_api/models/recurring_transactions_update_webhook.rb', line 37

def environment
  @environment
end

#item_id ⇒ String

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

Returns:

  • (String) 


28
29
30
 
# File 'lib/the_plaid_api/models/recurring_transactions_update_webhook.rb', line 28

def item_id
  @item_id
end

#webhook_code ⇒ String

‘RECURRING_TRANSACTIONS_UPDATE`

Returns:

  • (String) 


24
25
26
 
# File 'lib/the_plaid_api/models/recurring_transactions_update_webhook.rb', line 24

def webhook_code
  @webhook_code
end

#webhook_type ⇒ String

‘TRANSACTIONS`

Returns:

  • (String) 


20
21
22
 
# File 'lib/the_plaid_api/models/recurring_transactions_update_webhook.rb', line 20

def webhook_type
  @webhook_type
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/the_plaid_api/models/recurring_transactions_update_webhook.rb', line 74

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
  item_id = hash.key?('item_id') ? hash['item_id'] : nil
   = hash.key?('account_ids') ? hash['account_ids'] : nil
  environment = hash.key?('environment') ? hash['environment'] : nil

  # 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.
  RecurringTransactionsUpdateWebhook.new(webhook_type: webhook_type,
                                         webhook_code: webhook_code,
                                         item_id: item_id,
                                         account_ids: ,
                                         environment: environment,
                                         additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



40
41
42
43
44
45
46
47
48
 
# File 'lib/the_plaid_api/models/recurring_transactions_update_webhook.rb', line 40

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['webhook_type'] = 'webhook_type'
  @_hash['webhook_code'] = 'webhook_code'
  @_hash['item_id'] = 'item_id'
  @_hash['account_ids'] = 'account_ids'
  @_hash['environment'] = 'environment'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



56
57
58
 
# File 'lib/the_plaid_api/models/recurring_transactions_update_webhook.rb', line 56

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



51
52
53
 
# File 'lib/the_plaid_api/models/recurring_transactions_update_webhook.rb', line 51

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



109
110
111
112
113
114
115
 
# File 'lib/the_plaid_api/models/recurring_transactions_update_webhook.rb', line 109

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



101
102
103
104
105
106
 
# File 'lib/the_plaid_api/models/recurring_transactions_update_webhook.rb', line 101

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