Class: Bandwidth::CodeRequest

Inherits:
ApiModelBase show all
Defined in:
lib/bandwidth-sdk/models/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 = {}) ⇒ CodeRequest

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
119
120
121
122
123
124
125
 
# File 'lib/bandwidth-sdk/models/code_request.rb', line 78

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

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

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

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

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

Instance Attribute Details

#application_id ⇒ Object

The application unique ID, obtained from Bandwidth.



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

def application_id
  @application_id
end

#digits ⇒ Object

The number of digits for your mfa code. The valid number ranges from 2 to 8, inclusively.



34
35
36
 
# File 'lib/bandwidth-sdk/models/code_request.rb', line 34

def digits
  @digits
end

#from ⇒ Object

The application phone number, the sender of the mfa code.



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

def from
  @from
end

#message ⇒ Object

The message format of the mfa code. There are three values that the system will replace "CODE", "NAME", "SCOPE". The "SCOPE" and "NAME value template are optional, while "CODE" must be supplied. As the name would suggest, code will be replace with the actual mfa code. Name is replaced with the application name, configured during provisioning of mfa. The scope value is the same value sent during the call and partitioned by the server.



31
32
33
 
# File 'lib/bandwidth-sdk/models/code_request.rb', line 31

def message
  @message
end

#scope ⇒ Object

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



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

def scope
  @scope
end

#to ⇒ Object

The phone number to send the mfa code to.



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

def to
  @to
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



49
50
51
 
# File 'lib/bandwidth-sdk/models/code_request.rb', line 49

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



54
55
56
 
# File 'lib/bandwidth-sdk/models/code_request.rb', line 54

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/bandwidth-sdk/models/code_request.rb', line 37

def self.attribute_map
  {
    :'to' => :'to',
    :'from' => :'from',
    :'application_id' => :'applicationId',
    :'scope' => :'scope',
    :'message' => :'message',
    :'digits' => :'digits'
  }
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



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/bandwidth-sdk/models/code_request.rb', line 331

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



71
72
73
74
 
# File 'lib/bandwidth-sdk/models/code_request.rb', line 71

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

.openapi_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/bandwidth-sdk/models/code_request.rb', line 59

def self.openapi_types
  {
    :'to' => :'String',
    :'from' => :'String',
    :'application_id' => :'String',
    :'scope' => :'String',
    :'message' => :'String',
    :'digits' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



305
306
307
308
309
310
311
312
313
314
 
# File 'lib/bandwidth-sdk/models/code_request.rb', line 305

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      to == o.to &&
      from == o.from &&
      application_id == o.application_id &&
      scope == o.scope &&
      message == o.message &&
      digits == o.digits
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


318
319
320
 
# File 'lib/bandwidth-sdk/models/code_request.rb', line 318

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



324
325
326
 
# File 'lib/bandwidth-sdk/models/code_request.rb', line 324

def hash
  [to, from, application_id, scope, message, digits].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



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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/bandwidth-sdk/models/code_request.rb', line 129

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 @from.nil?
    invalid_properties.push('invalid value for "from", from cannot be nil.')
  end

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

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

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

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

  if !@scope.nil? && @scope.to_s.length > 25
    invalid_properties.push('invalid value for "scope", the character length must be smaller than or equal to 25.')
  end

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

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

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

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

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



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/bandwidth-sdk/models/code_request.rb', line 353

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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/bandwidth-sdk/models/code_request.rb', line 191

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 @from.nil?
  return false if @from.to_s.length > 32
  return false if @from !~ Regexp.new(/^\+[1-9]\d{1,14}$/)
  return false if @application_id.nil?
  return false if @application_id.to_s.length > 50
  return false if !@scope.nil? && @scope.to_s.length > 25
  return false if @message.nil?
  return false if @message.to_s.length > 2048
  return false if @digits.nil?
  return false if @digits > 8
  return false if @digits < 4
  true
end