Class: PureCloud::NumberPlan

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NumberPlan

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 116

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?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.has_key?(:'version')
    self.version = attributes[:'version']
  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?(:'modifiedBy')
    self.modified_by = attributes[:'modifiedBy']
  end

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#classification ⇒ Object

Returns the value of attribute classification.



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

def classification
  @classification
end

#created_by ⇒ Object

Returns the value of attribute created_by.



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

def created_by
  @created_by
end

#created_by_app ⇒ Object

Returns the value of attribute created_by_app.



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

def created_by_app
  @created_by_app
end

#date_created ⇒ Object

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



32
33
34
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 32

def date_created
  @date_created
end

#date_modified ⇒ Object

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



35
36
37
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 35

def date_modified
  @date_modified
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#digit_length ⇒ Object

Returns the value of attribute digit_length.



55
56
57
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 55

def digit_length
  @digit_length
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#match ⇒ Object

Returns the value of attribute match.



47
48
49
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 47

def match
  @match
end

#match_type ⇒ Object

Returns the value of attribute match_type.



59
60
61
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 59

def match_type
  @match_type
end

#modified_by ⇒ Object

Returns the value of attribute modified_by.



37
38
39
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 37

def modified_by
  @modified_by
end

#modified_by_app ⇒ Object

Returns the value of attribute modified_by_app.



43
44
45
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 43

def modified_by_app
  @modified_by_app
end

#name ⇒ Object

The name of the entity.



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 25

def name
  @name
end

#normalized_format ⇒ Object

Returns the value of attribute normalized_format.



49
50
51
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 49

def normalized_format
  @normalized_format
end

#numbers ⇒ Object

Returns the value of attribute numbers.



53
54
55
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 53

def numbers
  @numbers
end

#priority ⇒ Object

Returns the value of attribute priority.



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

def priority
  @priority
end

#self_uri ⇒ Object

The URI for this object



62
63
64
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 62

def self_uri
  @self_uri
end

#state ⇒ Object

Returns the value of attribute state.



41
42
43
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 41

def state
  @state
end

#version ⇒ Object

Returns the value of attribute version.



29
30
31
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 29

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 65

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'description' => :'description',
    :'version' => :'version',
    :'date_created' => :'dateCreated',
    :'date_modified' => :'dateModified',
    :'modified_by' => :'modifiedBy',
    :'created_by' => :'createdBy',
    :'state' => :'state',
    :'modified_by_app' => :'modifiedByApp',
    :'created_by_app' => :'createdByApp',
    :'match' => :'match',
    :'normalized_format' => :'normalizedFormat',
    :'priority' => :'priority',
    :'numbers' => :'numbers',
    :'digit_length' => :'digitLength',
    :'classification' => :'classification',
    :'match_type' => :'matchType',
    :'self_uri' => :'selfUri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 90

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'version' => :'Integer',
    :'date_created' => :'DateTime',
    :'date_modified' => :'DateTime',
    :'modified_by' => :'String',
    :'created_by' => :'String',
    :'state' => :'String',
    :'modified_by_app' => :'String',
    :'created_by_app' => :'String',
    :'match' => :'String',
    :'normalized_format' => :'String',
    :'priority' => :'Integer',
    :'numbers' => :'Array<Number>',
    :'digit_length' => :'DigitLength',
    :'classification' => :'String',
    :'match_type' => :'String',
    :'self_uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      version == o.version &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      modified_by == o.modified_by &&
      created_by == o.created_by &&
      state == o.state &&
      modified_by_app == o.modified_by_app &&
      created_by_app == o.created_by_app &&
      match == o.match &&
      normalized_format == o.normalized_format &&
      priority == o.priority &&
      numbers == o.numbers &&
      digit_length == o.digit_length &&
      classification == o.classification &&
      match_type == o.match_type &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 290

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



350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 350

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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 271

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


260
261
262
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 260

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



266
267
268
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 266

def hash
  [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, match, normalized_format, priority, numbers, digit_length, classification, match_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



204
205
206
207
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 204

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))



333
334
335
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 333

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



338
339
340
341
342
343
344
345
346
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 338

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 



328
329
330
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 328

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



211
212
213
214
215
216
217
218
219
220
 
# File 'lib/purecloudplatformclientv2/models/number_plan.rb', line 211

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

  allowed_values = ["active", "inactive", "deleted"]
  if @state && !allowed_values.include?(@state)
    return false
  end
end