Class: PureCloud::SmsPhoneNumber

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/sms_phone_number.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SmsPhoneNumber

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 176

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  
  if attributes.has_key?(:'id')
    
    
    self.id = attributes[:'id']
    
  
  end

  
  if attributes.has_key?(:'name')
    
    
    self.name = attributes[:'name']
    
  
  end

  
  if attributes.has_key?(:'phoneNumber')
    
    
    self.phone_number = attributes[:'phoneNumber']
    
  
  end

  
  if attributes.has_key?(:'phoneNumberType')
    
    
    self.phone_number_type = attributes[:'phoneNumberType']
    
  
  end

  
  if attributes.has_key?(:'provisionedThroughPureCloud')
    
    
    self.provisioned_through_pure_cloud = attributes[:'provisionedThroughPureCloud']
    
  
  end

  
  if attributes.has_key?(:'phoneNumberStatus')
    
    
    self.phone_number_status = attributes[:'phoneNumberStatus']
    
  
  end

  
  if attributes.has_key?(:'capabilities')
    
    if (value = attributes[:'capabilities']).is_a?(Array)
      self.capabilities = value
    end
    
    
  
  end

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

  
  if attributes.has_key?(:'dateCreated')
    
    
    self.date_created = attributes[:'dateCreated']
    
  
  end

  
  if attributes.has_key?(:'dateModified')
    
    
    self.date_modified = attributes[:'dateModified']
    
  
  end

  
  if attributes.has_key?(:'createdBy')
    
    
    self.created_by = attributes[:'createdBy']
    
  
  end

  
  if attributes.has_key?(:'modifiedBy')
    
    
    self.modified_by = attributes[:'modifiedBy']
    
  
  end

  
  if attributes.has_key?(:'version')
    
    
    self.version = attributes[:'version']
    
  
  end

  
  if attributes.has_key?(:'purchaseDate')
    
    
    self.purchase_date = attributes[:'purchaseDate']
    
  
  end

  
  if attributes.has_key?(:'cancellationDate')
    
    
    self.cancellation_date = attributes[:'cancellationDate']
    
  
  end

  
  if attributes.has_key?(:'renewalDate')
    
    
    self.renewal_date = attributes[:'renewalDate']
    
  
  end

  
  if attributes.has_key?(:'autoRenewable')
    
    
    self.auto_renewable = attributes[:'autoRenewable']
    
  
  end

  
  if attributes.has_key?(:'addressId')
    
    
    self.address_id = attributes[:'addressId']
    
  
  end

  
  if attributes.has_key?(:'shortCodeBillingType')
    
    
    self.short_code_billing_type = attributes[:'shortCodeBillingType']
    
  
  end

  
  if attributes.has_key?(:'selfUri')
    
    
    self.self_uri = attributes[:'selfUri']
    
  
  end

  
end

Instance Attribute Details

#address_id ⇒ Object

The id of an address attached to this phone number.



72
73
74
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 72

def address_id
  @address_id
end

#auto_renewable ⇒ Object

Renewal time period of this phone number, if the phoneNumberType is shortcode.



69
70
71
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 69

def auto_renewable
  @auto_renewable
end

#cancellation_date ⇒ Object

Contract end date of this phone number, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



63
64
65
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 63

def cancellation_date
  @cancellation_date
end

#capabilities ⇒ Object

The capabilities of the phone number available for provisioning.



39
40
41
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 39

def capabilities
  @capabilities
end

#country_code ⇒ Object

The ISO 3166-1 alpha-2 country code of the country this phone number is associated with.



42
43
44
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 42

def country_code
  @country_code
end

#created_by ⇒ Object

User that provisioned this phone number



51
52
53
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 51

def created_by
  @created_by
end

#date_created ⇒ Object

Date this phone number was provisioned. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



45
46
47
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 45

def date_created
  @date_created
end

#date_modified ⇒ Object

Date this phone number was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



48
49
50
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 48

def date_modified
  @date_modified
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 22

def id
  @id
end

#modified_by ⇒ Object

User that last modified this phone number



54
55
56
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 54

def modified_by
  @modified_by
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 24

def name
  @name
end

#phone_number ⇒ Object

A phone number provisioned for SMS communications in E.164 format. E.g. 13175555555 or 34234234234



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 27

def phone_number
  @phone_number
end

#phone_number_status ⇒ Object

Status of the provisioned phone number.



36
37
38
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 36

def phone_number_status
  @phone_number_status
end

#phone_number_type ⇒ Object

Type of the phone number provisioned.



30
31
32
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 30

def phone_number_type
  @phone_number_type
end

#provisioned_through_pure_cloud ⇒ Object

Is set to false, if the phone number is provisioned through a SMS provider, outside of PureCloud



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 33

def provisioned_through_pure_cloud
  @provisioned_through_pure_cloud
end

#purchase_date ⇒ Object

Date this phone number was purchased, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



60
61
62
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 60

def purchase_date
  @purchase_date
end

#renewal_date ⇒ Object

Contract renewal date of this phone number, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



66
67
68
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 66

def renewal_date
  @renewal_date
end

#self_uri ⇒ Object

The URI for this object



78
79
80
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 78

def self_uri
  @self_uri
end

#short_code_billing_type ⇒ Object

BillingType of this phone number, if the phoneNumberType is shortcode.



75
76
77
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 75

def short_code_billing_type
  @short_code_billing_type
end

#version ⇒ Object

Version number required for updates.



57
58
59
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 57

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



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/purecloudplatformclientv2/models/sms_phone_number.rb', line 81

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'phone_number' => :'phoneNumber',
    
    :'phone_number_type' => :'phoneNumberType',
    
    :'provisioned_through_pure_cloud' => :'provisionedThroughPureCloud',
    
    :'phone_number_status' => :'phoneNumberStatus',
    
    :'capabilities' => :'capabilities',
    
    :'country_code' => :'countryCode',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'created_by' => :'createdBy',
    
    :'modified_by' => :'modifiedBy',
    
    :'version' => :'version',
    
    :'purchase_date' => :'purchaseDate',
    
    :'cancellation_date' => :'cancellationDate',
    
    :'renewal_date' => :'renewalDate',
    
    :'auto_renewable' => :'autoRenewable',
    
    :'address_id' => :'addressId',
    
    :'short_code_billing_type' => :'shortCodeBillingType',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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/purecloudplatformclientv2/models/sms_phone_number.rb', line 128

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'phone_number' => :'String',
    
    :'phone_number_type' => :'String',
    
    :'provisioned_through_pure_cloud' => :'BOOLEAN',
    
    :'phone_number_status' => :'String',
    
    :'capabilities' => :'Array<String>',
    
    :'country_code' => :'String',
    
    :'date_created' => :'DateTime',
    
    :'date_modified' => :'DateTime',
    
    :'created_by' => :'User',
    
    :'modified_by' => :'User',
    
    :'version' => :'Integer',
    
    :'purchase_date' => :'DateTime',
    
    :'cancellation_date' => :'DateTime',
    
    :'renewal_date' => :'DateTime',
    
    :'auto_renewable' => :'String',
    
    :'address_id' => :'SmsAddress',
    
    :'short_code_billing_type' => :'String',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 631

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      phone_number == o.phone_number &&
      phone_number_type == o.phone_number_type &&
      provisioned_through_pure_cloud == o.provisioned_through_pure_cloud &&
      phone_number_status == o.phone_number_status &&
      capabilities == o.capabilities &&
      country_code == o.country_code &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      created_by == o.created_by &&
      modified_by == o.modified_by &&
      version == o.version &&
      purchase_date == o.purchase_date &&
      cancellation_date == o.cancellation_date &&
      renewal_date == o.renewal_date &&
      auto_renewable == o.auto_renewable &&
      address_id == o.address_id &&
      short_code_billing_type == o.short_code_billing_type &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 688

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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 =~ /^(true|t|yes|y|1)$/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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 748

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

build the object from hash



669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 669

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


658
659
660
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 658

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



664
665
666
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 664

def hash
  [id, name, phone_number, phone_number_type, provisioned_through_pure_cloud, phone_number_status, capabilities, country_code, date_created, date_modified, created_by, modified_by, version, purchase_date, cancellation_date, renewal_date, auto_renewable, address_id, short_code_billing_type, self_uri].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



369
370
371
372
373
374
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 369

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



731
732
733
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 731

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



736
737
738
739
740
741
742
743
744
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 736

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ Object 



726
727
728
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 726

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



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
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
441
442
443
444
445
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
484
485
486
487
488
489
490
 
# File 'lib/purecloudplatformclientv2/models/sms_phone_number.rb', line 378

def valid?
  
  
  
  
  
  
  
  
  
  
  if @phone_number.nil?
    return false
  end

  
  
  
  
  
  
  allowed_values = ["local", "mobile", "tollfree", "shortcode"]
  if @phone_number_type && !allowed_values.include?(@phone_number_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  allowed_values = ["INVALID", "ACTIVE", "PORTING", "PENDING", "PENDING_CANCELLATION"]
  if @phone_number_status && !allowed_values.include?(@phone_number_status)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if @version.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["Quarterly"]
  if @auto_renewable && !allowed_values.include?(@auto_renewable)
    return false
  end
  
  
  
  
  
  
  
  
  
  allowed_values = ["Basic", "Vanity"]
  if @short_code_billing_type && !allowed_values.include?(@short_code_billing_type)
    return false
  end
  
  
  
  
  
  
  
end