Class: Plaid::RecaptchaRequiredError

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

Overview

The request was flagged by Plaid’s fraud system, and requires additional verification to ensure they are not a bot.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RecaptchaRequiredError

Initializes the object

Parameters:

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

    Model attributes in the form of hash



78
79
80
81
82
83
84
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
114
115
116
117
118
 
# File 'lib/plaid/models/recaptcha_required_error.rb', line 78

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::RecaptchaRequiredError` 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::RecaptchaRequiredError`. 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?(:'error_type')
    self.error_type = attributes[:'error_type']
  end

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

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

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

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

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

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

Instance Attribute Details

#common_causes ⇒ Object

Plaid’s fraud system detects abusive traffic and considers a variety of parameters throughout Item creation requests. When a request is considered risky or possibly fraudulent, Link presents a reCAPTCHA for the user to solve.



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

def common_causes
  @common_causes
end

#display_message ⇒ Object

Returns the value of attribute display_message.



25
26
27
 
# File 'lib/plaid/models/recaptcha_required_error.rb', line 25

def display_message
  @display_message
end

#error_code ⇒ Object

RECAPTCHA_REQUIRED



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

def error_code
  @error_code
end

#error_type ⇒ Object

RECAPTCHA_ERROR



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

def error_type
  @error_type
end

#http_code ⇒ Object

400



28
29
30
 
# File 'lib/plaid/models/recaptcha_required_error.rb', line 28

def http_code
  @http_code
end

#link_user_experience ⇒ Object

Your user will be prompted to solve a Google reCAPTCHA challenge in the Link Recaptcha pane. If they solve the challenge successfully, the user’s request is resubmitted and they are directed to the next Item creation step.



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

def link_user_experience
  @link_user_experience
end

#troubleshooting_steps ⇒ Object

Link will automatically guide your user through reCAPTCHA verification. As a general rule, we recommend instrumenting basic fraud monitoring to detect and protect your website from spam and abuse. If your user cannot verify their session, please submit a Support ticket with the following identifiers: ‘link_session_id` or `request_id`



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

def troubleshooting_steps
  @troubleshooting_steps
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



53
54
55
 
# File 'lib/plaid/models/recaptcha_required_error.rb', line 53

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/plaid/models/recaptcha_required_error.rb', line 40

def self.attribute_map
  {
    :'error_type' => :'error_type',
    :'error_code' => :'error_code',
    :'display_message' => :'display_message',
    :'http_code' => :'http_code',
    :'link_user_experience' => :'link_user_experience',
    :'common_causes' => :'common_causes',
    :'troubleshooting_steps' => :'troubleshooting_steps'
  }
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



197
198
199
 
# File 'lib/plaid/models/recaptcha_required_error.rb', line 197

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



71
72
73
74
 
# File 'lib/plaid/models/recaptcha_required_error.rb', line 71

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/plaid/models/recaptcha_required_error.rb', line 58

def self.openapi_types
  {
    :'error_type' => :'String',
    :'error_code' => :'String',
    :'display_message' => :'String',
    :'http_code' => :'String',
    :'link_user_experience' => :'String',
    :'common_causes' => :'String',
    :'troubleshooting_steps' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/plaid/models/recaptcha_required_error.rb', line 170

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      error_type == o.error_type &&
      error_code == o.error_code &&
      display_message == o.display_message &&
      http_code == o.http_code &&
      link_user_experience == o.link_user_experience &&
      common_causes == o.common_causes &&
      troubleshooting_steps == o.troubleshooting_steps
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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/plaid/models/recaptcha_required_error.rb', line 228

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



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/plaid/models/recaptcha_required_error.rb', line 299

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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/plaid/models/recaptcha_required_error.rb', line 204

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


184
185
186
 
# File 'lib/plaid/models/recaptcha_required_error.rb', line 184

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



190
191
192
 
# File 'lib/plaid/models/recaptcha_required_error.rb', line 190

def hash
  [error_type, error_code, display_message, http_code, link_user_experience, common_causes, troubleshooting_steps].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



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
 
# File 'lib/plaid/models/recaptcha_required_error.rb', line 122

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

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

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

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

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

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

  if @troubleshooting_steps.nil?
    invalid_properties.push('invalid value for "troubleshooting_steps", troubleshooting_steps 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



275
276
277
 
# File 'lib/plaid/models/recaptcha_required_error.rb', line 275

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



281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/plaid/models/recaptcha_required_error.rb', line 281

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



269
270
271
 
# File 'lib/plaid/models/recaptcha_required_error.rb', line 269

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



157
158
159
160
161
162
163
164
165
166
 
# File 'lib/plaid/models/recaptcha_required_error.rb', line 157

def valid?
  return false if @error_type.nil?
  return false if @error_code.nil?
  return false if @display_message.nil?
  return false if @http_code.nil?
  return false if @link_user_experience.nil?
  return false if @common_causes.nil?
  return false if @troubleshooting_steps.nil?
  true
end