Class: Bandwidth::Address

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/bandwidth-sdk/models/address.rb', line 84

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

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

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

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

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

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

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

Instance Attribute Details

#addr1 ⇒ Object

The address of the business using the toll-free number.



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

def addr1
  @addr1
end

#addr2 ⇒ Object

The address of the business using the toll-free number.



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

def addr2
  @addr2
end

#city ⇒ Object

The city of the business using the toll-free number.



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

def city
  @city
end

#name ⇒ Object

The name of the business using the toll-free number.



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

def name
  @name
end

#state ⇒ Object

The state of the business using the toll-free number.



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

def state
  @state
end

#url ⇒ Object

The website of the business using the toll-free number.



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

def url
  @url
end

#zip ⇒ Object

The zip of the business using the toll-free number.



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

def zip
  @zip
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



53
54
55
 
# File 'lib/bandwidth-sdk/models/address.rb', line 53

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



58
59
60
 
# File 'lib/bandwidth-sdk/models/address.rb', line 58

def self.acceptable_attributes
  acceptable_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/bandwidth-sdk/models/address.rb', line 40

def self.attribute_map
  {
    :'name' => :'name',
    :'addr1' => :'addr1',
    :'addr2' => :'addr2',
    :'city' => :'city',
    :'state' => :'state',
    :'zip' => :'zip',
    :'url' => :'url'
  }
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



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/bandwidth-sdk/models/address.rb', line 398

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



76
77
78
79
80
 
# File 'lib/bandwidth-sdk/models/address.rb', line 76

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

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/bandwidth-sdk/models/address.rb', line 63

def self.openapi_types
  {
    :'name' => :'String',
    :'addr1' => :'String',
    :'addr2' => :'String',
    :'city' => :'String',
    :'state' => :'String',
    :'zip' => :'String',
    :'url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/bandwidth-sdk/models/address.rb', line 371

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      addr1 == o.addr1 &&
      addr2 == o.addr2 &&
      city == o.city &&
      state == o.state &&
      zip == o.zip &&
      url == o.url
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


385
386
387
 
# File 'lib/bandwidth-sdk/models/address.rb', line 385

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



391
392
393
 
# File 'lib/bandwidth-sdk/models/address.rb', line 391

def hash
  [name, addr1, addr2, city, state, zip, url].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



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  pattern = Regexp.new(/[- A-Za-z0-9]{0,500}/)
  if @zip !~ pattern
    invalid_properties.push("invalid value for \"zip\", must conform to the pattern #{pattern}.")
  end

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

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

  if @url.to_s.length < 1
    invalid_properties.push('invalid value for "url", the character length must be greater than or equal to 1.')
  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



420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/bandwidth-sdk/models/address.rb', line 420

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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/bandwidth-sdk/models/address.rb', line 226

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @name.to_s.length > 500
  return false if @name.to_s.length < 1
  return false if @addr1.nil?
  return false if @addr1.to_s.length > 500
  return false if @addr1.to_s.length < 1
  return false if !@addr2.nil? && @addr2.to_s.length > 500
  return false if !@addr2.nil? && @addr2.to_s.length < 0
  return false if @city.nil?
  return false if @city.to_s.length > 500
  return false if @city.to_s.length < 1
  return false if @state.nil?
  return false if @state.to_s.length > 500
  return false if @state.to_s.length < 1
  return false if @zip.nil?
  return false if @zip !~ Regexp.new(/[- A-Za-z0-9]{0,500}/)
  return false if @url.nil?
  return false if @url.to_s.length > 500
  return false if @url.to_s.length < 1
  true
end