Class: Bandwidth::VerificationUpdateRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/bandwidth-sdk/models/verification_update_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VerificationUpdateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



102
103
104
105
106
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
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
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 102

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#additional_information ⇒ Object

Any additional information.



37
38
39
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 37

def additional_information
  @additional_information
end

#business_address ⇒ Object

Returns the value of attribute business_address.



18
19
20
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 18

def business_address
  @business_address
end

#business_contact ⇒ Object

Returns the value of attribute business_contact.



20
21
22
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 20

def business_contact
  @business_contact
end

#business_dba ⇒ Object

The company ‘Doing Business As’.



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

def business_dba
  @business_dba
end

#isv_reseller ⇒ Object

ISV name.



40
41
42
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 40

def isv_reseller
  @isv_reseller
end

#message_volume ⇒ Object

Estimated monthly volume of messages from the toll-free number.



23
24
25
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 23

def message_volume
  @message_volume
end

#opt_in_workflow ⇒ Object

Returns the value of attribute opt_in_workflow.



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

def opt_in_workflow
  @opt_in_workflow
end

#privacy_policy_url ⇒ Object

The Toll-Free Verification request privacy policy URL.



43
44
45
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 43

def privacy_policy_url
  @privacy_policy_url
end

#production_message_content ⇒ Object

Example of message content.



32
33
34
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 32

def production_message_content
  @production_message_content
end

#terms_and_conditions_url ⇒ Object

The Toll-Free Verification request terms and conditions policy URL.



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

def terms_and_conditions_url
  @terms_and_conditions_url
end

#use_case ⇒ Object

The category of the use case.



26
27
28
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 26

def use_case
  @use_case
end

#use_case_summary ⇒ Object

A general idea of the use case and customer.



29
30
31
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 29

def use_case_summary
  @use_case_summary
end

Class Method Details

._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



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 446

def self._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 = Bandwidth.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



70
71
72
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 70

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 52

def self.attribute_map
  {
    :'business_address' => :'businessAddress',
    :'business_contact' => :'businessContact',
    :'message_volume' => :'messageVolume',
    :'use_case' => :'useCase',
    :'use_case_summary' => :'useCaseSummary',
    :'production_message_content' => :'productionMessageContent',
    :'opt_in_workflow' => :'optInWorkflow',
    :'additional_information' => :'additionalInformation',
    :'isv_reseller' => :'isvReseller',
    :'privacy_policy_url' => :'privacyPolicyUrl',
    :'terms_and_conditions_url' => :'termsAndConditionsUrl',
    :'business_dba' => :'businessDba'
  }
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



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 422

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



93
94
95
96
97
98
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 93

def self.openapi_nullable
  Set.new([
    :'additional_information',
    :'isv_reseller',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 75

def self.openapi_types
  {
    :'business_address' => :'Address',
    :'business_contact' => :'Contact',
    :'message_volume' => :'Integer',
    :'use_case' => :'String',
    :'use_case_summary' => :'String',
    :'production_message_content' => :'String',
    :'opt_in_workflow' => :'OptInWorkflow',
    :'additional_information' => :'String',
    :'isv_reseller' => :'String',
    :'privacy_policy_url' => :'String',
    :'terms_and_conditions_url' => :'String',
    :'business_dba' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 390

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      business_address == o.business_address &&
      business_contact == o.business_contact &&
      message_volume == o.message_volume &&
      use_case == o.use_case &&
      use_case_summary == o.use_case_summary &&
      production_message_content == o.production_message_content &&
      opt_in_workflow == o.opt_in_workflow &&
      additional_information == o.additional_information &&
      isv_reseller == o.isv_reseller &&
      privacy_policy_url == o.privacy_policy_url &&
      terms_and_conditions_url == o.terms_and_conditions_url &&
      business_dba == o.business_dba
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



517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 517

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


409
410
411
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 409

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



415
416
417
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 415

def hash
  [business_address, business_contact, message_volume, use_case, use_case_summary, production_message_content, opt_in_workflow, additional_information, isv_reseller, privacy_policy_url, terms_and_conditions_url, business_dba].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



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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
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
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 180

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if !@additional_information.nil? && @additional_information.to_s.length < 0
    invalid_properties.push('invalid value for "additional_information", the character length must be great than or equal to 0.')
  end

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

  if !@isv_reseller.nil? && @isv_reseller.to_s.length < 0
    invalid_properties.push('invalid value for "isv_reseller", the character length must be great than or equal to 0.')
  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



493
494
495
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 493

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



499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 499

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



487
488
489
 
# File 'lib/bandwidth-sdk/models/verification_update_request.rb', line 487

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



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/bandwidth-sdk/models/verification_update_request.rb', line 264

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @business_address.nil?
  return false if @business_contact.nil?
  return false if @message_volume.nil?
  return false if @message_volume > 10000000
  return false if @message_volume < 10
  return false if @use_case.nil?
  return false if @use_case.to_s.length > 500
  return false if @use_case.to_s.length < 0
  return false if @use_case_summary.nil?
  return false if @use_case_summary.to_s.length > 500
  return false if @use_case_summary.to_s.length < 0
  return false if @production_message_content.nil?
  return false if @production_message_content.to_s.length > 500
  return false if @production_message_content.to_s.length < 0
  return false if @opt_in_workflow.nil?
  return false if !@additional_information.nil? && @additional_information.to_s.length > 500
  return false if !@additional_information.nil? && @additional_information.to_s.length < 0
  return false if !@isv_reseller.nil? && @isv_reseller.to_s.length > 500
  return false if !@isv_reseller.nil? && @isv_reseller.to_s.length < 0
  true
end