Class: PureCloud::NumberOrder

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/number_order.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NumberOrder

Returns a new instance of NumberOrder.



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
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
 
# File 'lib/purecloud/models/number_order.rb', line 136

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

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

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'did']
    self.did = attributes[:'did']
  end
  
  if attributes[:'effectiveStartDate']
    self.effective_start_date = attributes[:'effectiveStartDate']
  end
  
  if attributes[:'effectiveEndDate']
    self.effective_end_date = attributes[:'effectiveEndDate']
  end
  
  if attributes[:'lastUpdated']
    self.last_updated = attributes[:'lastUpdated']
  end
  
  if attributes[:'startAuthUserId']
    self.start_auth_user_id = attributes[:'startAuthUserId']
  end
  
  if attributes[:'endAuthUserId']
    self.end_auth_user_id = attributes[:'endAuthUserId']
  end
  
  if attributes[:'status']
    self.status = attributes[:'status']
  end
  
  if attributes[:'phoneNumberType']
    self.phone_number_type = attributes[:'phoneNumberType']
  end
  
  if attributes[:'porting']
    self.porting = attributes[:'porting']
  else
    self.porting = false
  end
  
  if attributes[:'billingAddress']
    self.billing_address = attributes[:'billingAddress']
  end
  
  if attributes[:'responsibleContact']
    self.responsible_contact = attributes[:'responsibleContact']
  end
  
  if attributes[:'companyName']
    self.company_name = attributes[:'companyName']
  end
  
  if attributes[:'countryCode']
    self.country_code = attributes[:'countryCode']
  end
  
  if attributes[:'envelopeId']
    self.envelope_id = attributes[:'envelopeId']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#billing_address ⇒ Object

Billing address used for a number port



54
55
56
 
# File 'lib/purecloud/models/number_order.rb', line 54

def billing_address
  @billing_address
end

#company_name ⇒ Object

Company name for a number port



60
61
62
 
# File 'lib/purecloud/models/number_order.rb', line 60

def company_name
  @company_name
end

#country_code ⇒ Object

Country dial in codes (telephone dialing prefixes)



63
64
65
 
# File 'lib/purecloud/models/number_order.rb', line 63

def country_code
  @country_code
end

#did ⇒ Object

DID purchased



27
28
29
 
# File 'lib/purecloud/models/number_order.rb', line 27

def did
  @did
end

#effective_end_date ⇒ Object

Effective disconnection date for this order. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



33
34
35
 
# File 'lib/purecloud/models/number_order.rb', line 33

def effective_end_date
  @effective_end_date
end

#effective_start_date ⇒ Object

Effective date of service for this order. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



30
31
32
 
# File 'lib/purecloud/models/number_order.rb', line 30

def effective_start_date
  @effective_start_date
end

#end_auth_user_id ⇒ Object

UserId authorizing disconnection



42
43
44
 
# File 'lib/purecloud/models/number_order.rb', line 42

def end_auth_user_id
  @end_auth_user_id
end

#envelope_id ⇒ Object

Id of the terms and conditions envelope for the order.



66
67
68
 
# File 'lib/purecloud/models/number_order.rb', line 66

def envelope_id
  @envelope_id
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloud/models/number_order.rb', line 22

def id
  @id
end

#last_updated ⇒ Object

Date of last update. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



36
37
38
 
# File 'lib/purecloud/models/number_order.rb', line 36

def last_updated
  @last_updated
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloud/models/number_order.rb', line 24

def name
  @name
end

#phone_number_type ⇒ Object

Class of DID being purchased (eg. us-domestic, toll-free, etc)



48
49
50
 
# File 'lib/purecloud/models/number_order.rb', line 48

def phone_number_type
  @phone_number_type
end

#porting ⇒ Object

Whether or not the number was ported



51
52
53
 
# File 'lib/purecloud/models/number_order.rb', line 51

def porting
  @porting
end

#responsible_contact ⇒ Object

Company contact for a number port



57
58
59
 
# File 'lib/purecloud/models/number_order.rb', line 57

def responsible_contact
  @responsible_contact
end

#self_uri ⇒ Object

The URI for this object



69
70
71
 
# File 'lib/purecloud/models/number_order.rb', line 69

def self_uri
  @self_uri
end

#start_auth_user_id ⇒ Object

UserId authorizing purchase



39
40
41
 
# File 'lib/purecloud/models/number_order.rb', line 39

def start_auth_user_id
  @start_auth_user_id
end

#status ⇒ Object

Current status of this DID order



45
46
47
 
# File 'lib/purecloud/models/number_order.rb', line 45

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
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
 
# File 'lib/purecloud/models/number_order.rb', line 72

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'did' => :'did',
    
    :'effective_start_date' => :'effectiveStartDate',
    
    :'effective_end_date' => :'effectiveEndDate',
    
    :'last_updated' => :'lastUpdated',
    
    :'start_auth_user_id' => :'startAuthUserId',
    
    :'end_auth_user_id' => :'endAuthUserId',
    
    :'status' => :'status',
    
    :'phone_number_type' => :'phoneNumberType',
    
    :'porting' => :'porting',
    
    :'billing_address' => :'billingAddress',
    
    :'responsible_contact' => :'responsibleContact',
    
    :'company_name' => :'companyName',
    
    :'country_code' => :'countryCode',
    
    :'envelope_id' => :'envelopeId',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/purecloud/models/number_order.rb', line 113

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'did' => :'String',
    :'effective_start_date' => :'DateTime',
    :'effective_end_date' => :'DateTime',
    :'last_updated' => :'DateTime',
    :'start_auth_user_id' => :'String',
    :'end_auth_user_id' => :'String',
    :'status' => :'String',
    :'phone_number_type' => :'String',
    :'porting' => :'BOOLEAN',
    :'billing_address' => :'PortBillingAddress',
    :'responsible_contact' => :'PortContact',
    :'company_name' => :'String',
    :'country_code' => :'String',
    :'envelope_id' => :'String',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/purecloud/models/number_order.rb', line 234

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      did == o.did &&
      effective_start_date == o.effective_start_date &&
      effective_end_date == o.effective_end_date &&
      last_updated == o.last_updated &&
      start_auth_user_id == o.start_auth_user_id &&
      end_auth_user_id == o.end_auth_user_id &&
      status == o.status &&
      phone_number_type == o.phone_number_type &&
      porting == o.porting &&
      billing_address == o.billing_address &&
      responsible_contact == o.responsible_contact &&
      company_name == o.company_name &&
      country_code == o.country_code &&
      envelope_id == o.envelope_id &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloud/models/number_order.rb', line 286

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



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/purecloud/models/number_order.rb', line 346

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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/purecloud/models/number_order.rb', line 267

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

Returns:

  • (Boolean)

See Also:

  • `==` method


257
258
259
 
# File 'lib/purecloud/models/number_order.rb', line 257

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



262
263
264
 
# File 'lib/purecloud/models/number_order.rb', line 262

def hash
  [id, name, did, effective_start_date, effective_end_date, last_updated, start_auth_user_id, end_auth_user_id, status, phone_number_type, porting, billing_address, responsible_contact, company_name, country_code, envelope_id, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



329
330
331
 
# File 'lib/purecloud/models/number_order.rb', line 329

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



334
335
336
337
338
339
340
341
342
 
# File 'lib/purecloud/models/number_order.rb', line 334

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 



324
325
326
 
# File 'lib/purecloud/models/number_order.rb', line 324

def to_s
  to_hash.to_s
end