Class: UltracartClient::ConversationPbxAddress

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/conversation_pbx_address.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationPbxAddress

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 108

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address_sid ⇒ Object

Twilio Address SID



19
20
21
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 19

def address_sid
  @address_sid
end

#city ⇒ Object

City



22
23
24
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 22

def city
  @city
end

#conversation_pbx_address_uuid ⇒ Object

Conversation Pbx Address UUID



25
26
27
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 25

def conversation_pbx_address_uuid
  @conversation_pbx_address_uuid
end

#country_code ⇒ Object

ISO country code (2 characters)



28
29
30
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 28

def country_code
  @country_code
end

#customer_name ⇒ Object

Customer name



31
32
33
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 31

def customer_name
  @customer_name
end

#friendly_name ⇒ Object

Friendly name for the address



34
35
36
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 34

def friendly_name
  @friendly_name
end

#merchant_id ⇒ Object

Merchant Id



37
38
39
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 37

def merchant_id
  @merchant_id
end

#postal_code ⇒ Object

Postal code



40
41
42
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 40

def postal_code
  @postal_code
end

#region ⇒ Object

State/Province/Region



43
44
45
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 43

def region
  @region
end

#street ⇒ Object

Street address



46
47
48
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 46

def street
  @street
end

#valid ⇒ Object

Whether the address is valid (validated or verified)



49
50
51
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 49

def valid
  @valid
end

#validated ⇒ Object

Whether the address has been validated by Twilio



52
53
54
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 52

def validated
  @validated
end

#verified ⇒ Object

Whether the address has been verified by Twilio



55
56
57
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 55

def verified
  @verified
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



77
78
79
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 77

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 58

def self.attribute_map
  {
    :'address_sid' => :'address_sid',
    :'city' => :'city',
    :'conversation_pbx_address_uuid' => :'conversation_pbx_address_uuid',
    :'country_code' => :'country_code',
    :'customer_name' => :'customer_name',
    :'friendly_name' => :'friendly_name',
    :'merchant_id' => :'merchant_id',
    :'postal_code' => :'postal_code',
    :'region' => :'region',
    :'street' => :'street',
    :'valid' => :'valid',
    :'validated' => :'validated',
    :'verified' => :'verified'
  }
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



372
373
374
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 372

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



101
102
103
104
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 101

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

.openapi_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 82

def self.openapi_types
  {
    :'address_sid' => :'String',
    :'city' => :'String',
    :'conversation_pbx_address_uuid' => :'String',
    :'country_code' => :'String',
    :'customer_name' => :'String',
    :'friendly_name' => :'String',
    :'merchant_id' => :'String',
    :'postal_code' => :'String',
    :'region' => :'String',
    :'street' => :'String',
    :'valid' => :'Boolean',
    :'validated' => :'Boolean',
    :'verified' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 339

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address_sid == o.address_sid &&
      city == o.city &&
      conversation_pbx_address_uuid == o.conversation_pbx_address_uuid &&
      country_code == o.country_code &&
      customer_name == o.customer_name &&
      friendly_name == o.friendly_name &&
      merchant_id == o.merchant_id &&
      postal_code == o.postal_code &&
      region == o.region &&
      street == o.street &&
      valid == o.valid &&
      validated == o.validated &&
      verified == o.verified
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



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 403

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 = UltracartClient.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



474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 474

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



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 379

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


359
360
361
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 359

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



365
366
367
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 365

def hash
  [address_sid, city, conversation_pbx_address_uuid, country_code, customer_name, friendly_name, merchant_id, postal_code, region, street, valid, validated, verified].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



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
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 176

def list_invalid_properties
  invalid_properties = Array.new
  if !@address_sid.nil? && @address_sid.to_s.length > 50
    invalid_properties.push('invalid value for "address_sid", the character length must be smaller than or equal to 50.')
  end

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

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

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

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

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

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

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

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

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



450
451
452
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 450

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



456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 456

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



444
445
446
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 444

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



223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/ultracart_api/models/conversation_pbx_address.rb', line 223

def valid?
  return false if !@address_sid.nil? && @address_sid.to_s.length > 50
  return false if !@city.nil? && @city.to_s.length > 100
  return false if !@conversation_pbx_address_uuid.nil? && @conversation_pbx_address_uuid.to_s.length > 50
  return false if !@country_code.nil? && @country_code.to_s.length > 2
  return false if !@customer_name.nil? && @customer_name.to_s.length > 100
  return false if !@friendly_name.nil? && @friendly_name.to_s.length > 100
  return false if !@merchant_id.nil? && @merchant_id.to_s.length > 5
  return false if !@postal_code.nil? && @postal_code.to_s.length > 20
  return false if !@region.nil? && @region.to_s.length > 50
  return false if !@street.nil? && @street.to_s.length > 200
  true
end