Class: Bandwidth::VerifyCodeRequest

Inherits:
ApiModelBase show all
Defined in:
lib/bandwidth-sdk/models/verify_code_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ VerifyCodeRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



68
69
70
71
72
73
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
99
100
101
102
103
 
# File 'lib/bandwidth-sdk/models/verify_code_request.rb', line 68

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

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

  if attributes.key?(:'to')
    self.to = attributes[:'to']
  else
    self.to = nil
  end

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

  if attributes.key?(:'expiration_time_in_minutes')
    self.expiration_time_in_minutes = attributes[:'expiration_time_in_minutes']
  else
    self.expiration_time_in_minutes = nil
  end

  if attributes.key?(:'code')
    self.code = attributes[:'code']
  else
    self.code = nil
  end
end

Instance Attribute Details

#code ⇒ Object

The generated mfa code to check if valid.



28
29
30
 
# File 'lib/bandwidth-sdk/models/verify_code_request.rb', line 28

def code
  @code
end

#expiration_time_in_minutes ⇒ Object

The time period, in minutes, to validate the mfa code. By setting this to 3 minutes, it will mean any code generated within the last 3 minutes are still valid. The valid range for expiration time is between 0 and 15 minutes, exclusively and inclusively, respectively.



25
26
27
 
# File 'lib/bandwidth-sdk/models/verify_code_request.rb', line 25

def expiration_time_in_minutes
  @expiration_time_in_minutes
end

#scope ⇒ Object

An optional field to denote what scope or action the mfa code is addressing. If not supplied, defaults to "2FA".



22
23
24
 
# File 'lib/bandwidth-sdk/models/verify_code_request.rb', line 22

def scope
  @scope
end

#to ⇒ Object

The phone number to send the mfa code to.



19
20
21
 
# File 'lib/bandwidth-sdk/models/verify_code_request.rb', line 19

def to
  @to
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



41
42
43
 
# File 'lib/bandwidth-sdk/models/verify_code_request.rb', line 41

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



46
47
48
 
# File 'lib/bandwidth-sdk/models/verify_code_request.rb', line 46

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
 
# File 'lib/bandwidth-sdk/models/verify_code_request.rb', line 31

def self.attribute_map
  {
    :'to' => :'to',
    :'scope' => :'scope',
    :'expiration_time_in_minutes' => :'expirationTimeInMinutes',
    :'code' => :'code'
  }
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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/bandwidth-sdk/models/verify_code_request.rb', line 238

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



61
62
63
64
 
# File 'lib/bandwidth-sdk/models/verify_code_request.rb', line 61

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

.openapi_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
 
# File 'lib/bandwidth-sdk/models/verify_code_request.rb', line 51

def self.openapi_types
  {
    :'to' => :'String',
    :'scope' => :'String',
    :'expiration_time_in_minutes' => :'Float',
    :'code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



214
215
216
217
218
219
220
221
 
# File 'lib/bandwidth-sdk/models/verify_code_request.rb', line 214

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      to == o.to &&
      scope == o.scope &&
      expiration_time_in_minutes == o.expiration_time_in_minutes &&
      code == o.code
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


225
226
227
 
# File 'lib/bandwidth-sdk/models/verify_code_request.rb', line 225

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



231
232
233
 
# File 'lib/bandwidth-sdk/models/verify_code_request.rb', line 231

def hash
  [to, scope, expiration_time_in_minutes, code].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



107
108
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
 
# File 'lib/bandwidth-sdk/models/verify_code_request.rb', line 107

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @to.nil?
    invalid_properties.push('invalid value for "to", to cannot be nil.')
  end

  pattern = Regexp.new(/^\+[1-9]\d{1,14}$/)
  if @to !~ pattern
    invalid_properties.push("invalid value for \"to\", must conform to the pattern #{pattern}.")
  end

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

  if @expiration_time_in_minutes > 15
    invalid_properties.push('invalid value for "expiration_time_in_minutes", must be smaller than or equal to 15.')
  end

  if @expiration_time_in_minutes < 1
    invalid_properties.push('invalid value for "expiration_time_in_minutes", must be greater than or equal to 1.')
  end

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

  if @code.to_s.length > 8
    invalid_properties.push('invalid value for "code", the character length must be smaller than or equal to 8.')
  end

  if @code.to_s.length < 4
    invalid_properties.push('invalid value for "code", the character length must be greater than or equal to 4.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/bandwidth-sdk/models/verify_code_request.rb', line 260

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/bandwidth-sdk/models/verify_code_request.rb', line 148

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @to.nil?
  return false if @to !~ Regexp.new(/^\+[1-9]\d{1,14}$/)
  return false if @expiration_time_in_minutes.nil?
  return false if @expiration_time_in_minutes > 15
  return false if @expiration_time_in_minutes < 1
  return false if @code.nil?
  return false if @code.to_s.length > 8
  return false if @code.to_s.length < 4
  true
end