Class: Plaid::LiabilitiesDefaultUpdateWebhook

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/plaid/models/liabilities_default_update_webhook.rb

Overview

The webhook of type ‘LIABILITIES` and code `DEFAULT_UPDATE` will be fired when new or updated liabilities have been detected on a liabilities item.

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:, error:, account_ids_with_new_liabilities:, account_ids_with_updated_liabilities:, additional_properties: nil) ⇒ LiabilitiesDefaultUpdateWebhook

Returns a new instance of LiabilitiesDefaultUpdateWebhook.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/plaid/models/liabilities_default_update_webhook.rb', line 68

def initialize(webhook_type:, webhook_code:, item_id:, error:,
               account_ids_with_new_liabilities:,
               account_ids_with_updated_liabilities:,
               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
  @error = error
  @account_ids_with_new_liabilities = 
  @account_ids_with_updated_liabilities = 
  @additional_properties = additional_properties
end

Instance Attribute Details

#account_ids_with_new_liabilities ⇒ Array[String]

An array of ‘account_id`’s for accounts that contain new liabilities.

Returns:

  • (Array[String]) 


35
36
37
 
# File 'lib/plaid/models/liabilities_default_update_webhook.rb', line 35

def 
  @account_ids_with_new_liabilities
end

#account_ids_with_updated_liabilities ⇒ Hash[String, Object]

An object with keys of ‘account_id`’s that are mapped to their respective liabilities fields that changed. Example: ‘{ “XMBvvyMGQ1UoLbKByoMqH3nXMj84ALSdE5B58”: [“past_amount_due”] }`

Returns:

  • (Hash[String, Object]) 


42
43
44
 
# File 'lib/plaid/models/liabilities_default_update_webhook.rb', line 42

def 
  @account_ids_with_updated_liabilities
end

#error ⇒ Error

We use standard HTTP response codes for success and failure notifications, and our errors are further classified by ‘error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be `null` if no error has occurred.

Returns:



31
32
33
 
# File 'lib/plaid/models/liabilities_default_update_webhook.rb', line 31

def error
  @error
end

#item_id ⇒ String

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

Returns:

  • (String) 


23
24
25
 
# File 'lib/plaid/models/liabilities_default_update_webhook.rb', line 23

def item_id
  @item_id
end

#webhook_code ⇒ String

‘DEFAULT_UPDATE`

Returns:

  • (String) 


19
20
21
 
# File 'lib/plaid/models/liabilities_default_update_webhook.rb', line 19

def webhook_code
  @webhook_code
end

#webhook_type ⇒ String

‘LIABILITIES`

Returns:

  • (String) 


15
16
17
 
# File 'lib/plaid/models/liabilities_default_update_webhook.rb', line 15

def webhook_type
  @webhook_type
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/plaid/models/liabilities_default_update_webhook.rb', line 85

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
  error = Error.from_hash(hash['error']) if hash['error']
   =
    hash.key?('account_ids_with_new_liabilities') ? hash['account_ids_with_new_liabilities'] : nil
   =
    hash.key?('account_ids_with_updated_liabilities') ? hash['account_ids_with_updated_liabilities'] : 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.
  LiabilitiesDefaultUpdateWebhook.new(webhook_type: webhook_type,
                                      webhook_code: webhook_code,
                                      item_id: item_id,
                                      error: error,
                                      account_ids_with_new_liabilities: ,
                                      account_ids_with_updated_liabilities: ,
                                      additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/plaid/models/liabilities_default_update_webhook.rb', line 45

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['webhook_type'] = 'webhook_type'
  @_hash['webhook_code'] = 'webhook_code'
  @_hash['item_id'] = 'item_id'
  @_hash['error'] = 'error'
  @_hash['account_ids_with_new_liabilities'] =
    'account_ids_with_new_liabilities'
  @_hash['account_ids_with_updated_liabilities'] =
    'account_ids_with_updated_liabilities'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



64
65
66
 
# File 'lib/plaid/models/liabilities_default_update_webhook.rb', line 64

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



59
60
61
 
# File 'lib/plaid/models/liabilities_default_update_webhook.rb', line 59

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



126
127
128
129
130
131
132
133
 
# File 'lib/plaid/models/liabilities_default_update_webhook.rb', line 126

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}, error: #{@error.inspect},"\
  " account_ids_with_new_liabilities: #{@account_ids_with_new_liabilities.inspect},"\
  " account_ids_with_updated_liabilities: #{@account_ids_with_updated_liabilities.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



116
117
118
119
120
121
122
123
 
# File 'lib/plaid/models/liabilities_default_update_webhook.rb', line 116

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