Class: Plaid::CraReportUpdatedWebhook

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

Overview

Fired when a subscribed CRA report has been updated. Retrieve the updated products by calling the relevant product /get endpoint. A single webhook covers all CRA report-update subscriptions; the successful_products/failed_products fields indicate which products were updated, and the scope field indicates the data the report was computed over.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CraReportUpdatedWebhook

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 117

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::CraReportUpdatedWebhook` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::CraReportUpdatedWebhook`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'webhook_type')
    self.webhook_type = attributes[:'webhook_type']
  end

  if attributes.key?(:'webhook_code')
    self.webhook_code = attributes[:'webhook_code']
  end

  if attributes.key?(:'user_id')
    self.user_id = attributes[:'user_id']
  end

  if attributes.key?(:'report_id')
    self.report_id = attributes[:'report_id']
  end

  if attributes.key?(:'scope')
    self.scope = attributes[:'scope']
  end

  if attributes.key?(:'successful_products')
    if (value = attributes[:'successful_products']).is_a?(Array)
      self.successful_products = value
    end
  end

  if attributes.key?(:'failed_products')
    if (value = attributes[:'failed_products']).is_a?(Array)
      self.failed_products = value
    end
  end

  if attributes.key?(:'generated_time')
    self.generated_time = attributes[:'generated_time']
  end

  if attributes.key?(:'error_code')
    self.error_code = attributes[:'error_code']
  end

  if attributes.key?(:'environment')
    self.environment = attributes[:'environment']
  end
end

Instance Attribute Details

#environment ⇒ Object

Returns the value of attribute environment.



45
46
47
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 45

def environment
  @environment
end

#error_code ⇒ Object

The reason all products failed to update. Populated only when every requested product failed; null if any product succeeded. For example, NO_ELIGIBLE_ITEMS.



43
44
45
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 43

def error_code
  @error_code
end

#failed_products ⇒ Object

Specifies a list of products that have failed to update for the report. Additional detail on what caused the failure can be found by calling the product /get endpoint.



37
38
39
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 37

def failed_products
  @failed_products
end

#generated_time ⇒ Object

The timestamp when the products were generated, in ISO 8601 format. Null if there are no successful products.



40
41
42
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 40

def generated_time
  @generated_time
end

#report_id ⇒ Object

The identifier of the CRA report that was updated. Pass this value to the relevant product /get endpoint to retrieve the updated report.



29
30
31
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 29

def report_id
  @report_id
end

#scope ⇒ Object

Returns the value of attribute scope.



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

def scope
  @scope
end

#successful_products ⇒ Object

Specifies a list of products that have successfully been updated for the report. Call the product /get endpoint to retrieve them.



34
35
36
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 34

def successful_products
  @successful_products
end

#user_id ⇒ Object

The user_id associated with the user whose data is being requested. This is received by calling /user/create.



26
27
28
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 26

def user_id
  @user_id
end

#webhook_code ⇒ Object

CRA_REPORT_UPDATED



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

def webhook_code
  @webhook_code
end

#webhook_type ⇒ Object

CRA_REPORT



20
21
22
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 20

def webhook_type
  @webhook_type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



86
87
88
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 86

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



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

def self.attribute_map
  {
    :'webhook_type' => :'webhook_type',
    :'webhook_code' => :'webhook_code',
    :'user_id' => :'user_id',
    :'report_id' => :'report_id',
    :'scope' => :'scope',
    :'successful_products' => :'successful_products',
    :'failed_products' => :'failed_products',
    :'generated_time' => :'generated_time',
    :'error_code' => :'error_code',
    :'environment' => :'environment'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



255
256
257
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 255

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



107
108
109
110
111
112
113
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 107

def self.openapi_nullable
  Set.new([
    :'report_id',
    :'generated_time',
    :'error_code',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 91

def self.openapi_types
  {
    :'webhook_type' => :'String',
    :'webhook_code' => :'String',
    :'user_id' => :'String',
    :'report_id' => :'String',
    :'scope' => :'CraReportScope',
    :'successful_products' => :'Array<CreditProduct>',
    :'failed_products' => :'Array<CreditProduct>',
    :'generated_time' => :'Time',
    :'error_code' => :'String',
    :'environment' => :'WebhookEnvironmentValues'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 225

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      webhook_type == o.webhook_type &&
      webhook_code == o.webhook_code &&
      user_id == o.user_id &&
      report_id == o.report_id &&
      scope == o.scope &&
      successful_products == o.successful_products &&
      failed_products == o.failed_products &&
      generated_time == o.generated_time &&
      error_code == o.error_code &&
      environment == o.environment
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 286

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Plaid.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 357

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 262

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


242
243
244
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 242

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



248
249
250
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 248

def hash
  [webhook_type, webhook_code, user_id, report_id, scope, successful_products, failed_products, generated_time, error_code, environment].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 177

def list_invalid_properties
  invalid_properties = Array.new
  if @webhook_type.nil?
    invalid_properties.push('invalid value for "webhook_type", webhook_type cannot be nil.')
  end

  if @webhook_code.nil?
    invalid_properties.push('invalid value for "webhook_code", webhook_code cannot be nil.')
  end

  if @user_id.nil?
    invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
  end

  if @scope.nil?
    invalid_properties.push('invalid value for "scope", scope cannot be nil.')
  end

  if @successful_products.nil?
    invalid_properties.push('invalid value for "successful_products", successful_products cannot be nil.')
  end

  if @failed_products.nil?
    invalid_properties.push('invalid value for "failed_products", failed_products cannot be nil.')
  end

  if @environment.nil?
    invalid_properties.push('invalid value for "environment", environment cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



333
334
335
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 333

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 339

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



327
328
329
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 327

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



212
213
214
215
216
217
218
219
220
221
 
# File 'lib/plaid/models/cra_report_updated_webhook.rb', line 212

def valid?
  return false if @webhook_type.nil?
  return false if @webhook_code.nil?
  return false if @user_id.nil?
  return false if @scope.nil?
  return false if @successful_products.nil?
  return false if @failed_products.nil?
  return false if @environment.nil?
  true
end