Class: Plaid::SMSVerification

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

Overview

Additional information for the individual SMS verification.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SMSVerification

Initializes the object

Parameters:

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

    Model attributes in the form of hash



109
110
111
112
113
114
115
116
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
 
# File 'lib/plaid/models/sms_verification.rb', line 109

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

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

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

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

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

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

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

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

Instance Attribute Details

#attempt ⇒ Object

The attempt field begins with 1 and increments with each subsequent SMS verification.



22
23
24
 
# File 'lib/plaid/models/sms_verification.rb', line 22

def attempt
  @attempt
end

#delivery_attempt_count ⇒ Object

The number of delivery attempts made within the verification to send the SMS code to the user. Each delivery attempt represents the user taking action from the front end UI to request creation and delivery of a new SMS verification code, or to resend an existing SMS verification code. There is a limit of 3 delivery attempts per verification.



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

def delivery_attempt_count
  @delivery_attempt_count
end

#initially_sent_at ⇒ Object

An ISO8601 formatted timestamp.



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

def initially_sent_at
  @initially_sent_at
end

#last_sent_at ⇒ Object

An ISO8601 formatted timestamp.



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

def last_sent_at
  @last_sent_at
end

#phone_number ⇒ Object

A phone number in E.164 format.



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

def phone_number
  @phone_number
end

#redacted_at ⇒ Object

An ISO8601 formatted timestamp.



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

def redacted_at
  @redacted_at
end

#solve_attempt_count ⇒ Object

The number of attempts made by the user within the verification to verify the SMS code by entering it into the front end UI. There is a limit of 3 solve attempts per verification.



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

def solve_attempt_count
  @solve_attempt_count
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/plaid/models/sms_verification.rb', line 79

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/plaid/models/sms_verification.rb', line 65

def self.attribute_map
  {
    :'status' => :'status',
    :'attempt' => :'attempt',
    :'phone_number' => :'phone_number',
    :'delivery_attempt_count' => :'delivery_attempt_count',
    :'solve_attempt_count' => :'solve_attempt_count',
    :'initially_sent_at' => :'initially_sent_at',
    :'last_sent_at' => :'last_sent_at',
    :'redacted_at' => :'redacted_at'
  }
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



218
219
220
 
# File 'lib/plaid/models/sms_verification.rb', line 218

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



98
99
100
101
102
103
104
105
 
# File 'lib/plaid/models/sms_verification.rb', line 98

def self.openapi_nullable
  Set.new([
    :'phone_number',
    :'initially_sent_at',
    :'last_sent_at',
    :'redacted_at'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/plaid/models/sms_verification.rb', line 84

def self.openapi_types
  {
    :'status' => :'SMSVerificationStatus',
    :'attempt' => :'Integer',
    :'phone_number' => :'String',
    :'delivery_attempt_count' => :'Integer',
    :'solve_attempt_count' => :'Integer',
    :'initially_sent_at' => :'Time',
    :'last_sent_at' => :'Time',
    :'redacted_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/plaid/models/sms_verification.rb', line 190

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      status == o.status &&
      attempt == o.attempt &&
      phone_number == o.phone_number &&
      delivery_attempt_count == o.delivery_attempt_count &&
      solve_attempt_count == o.solve_attempt_count &&
      initially_sent_at == o.initially_sent_at &&
      last_sent_at == o.last_sent_at &&
      redacted_at == o.redacted_at
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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/plaid/models/sms_verification.rb', line 249

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



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/plaid/models/sms_verification.rb', line 320

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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/plaid/models/sms_verification.rb', line 225

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


205
206
207
 
# File 'lib/plaid/models/sms_verification.rb', line 205

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



211
212
213
 
# File 'lib/plaid/models/sms_verification.rb', line 211

def hash
  [status, attempt, phone_number, delivery_attempt_count, solve_attempt_count, initially_sent_at, last_sent_at, redacted_at].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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/plaid/models/sms_verification.rb', line 157

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

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

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

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



296
297
298
 
# File 'lib/plaid/models/sms_verification.rb', line 296

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



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/plaid/models/sms_verification.rb', line 302

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



290
291
292
 
# File 'lib/plaid/models/sms_verification.rb', line 290

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



180
181
182
183
184
185
186
 
# File 'lib/plaid/models/sms_verification.rb', line 180

def valid?
  return false if @status.nil?
  return false if @attempt.nil?
  return false if @delivery_attempt_count.nil?
  return false if @solve_attempt_count.nil?
  true
end