Class: PureCloud::DncListCreate

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DncListCreate

Returns a new instance of DncListCreate.



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

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[:'dateCreated']
    self.date_created = attributes[:'dateCreated']
  end
  
  if attributes[:'dateModified']
    self.date_modified = attributes[:'dateModified']
  end
  
  if attributes[:'version']
    self.version = attributes[:'version']
  end
  
  if attributes[:'importStatus']
    self.import_status = attributes[:'importStatus']
  end
  
  if attributes[:'size']
    self.size = attributes[:'size']
  end
  
  if attributes[:'dncSourceType']
    self.dnc_source_type = attributes[:'dncSourceType']
  end
  
  if attributes[:'loginId']
    self. = attributes[:'loginId']
  end
  
  if attributes[:'dncCodes']
    if (value = attributes[:'dncCodes']).is_a?(Array)
      self.dnc_codes = value
    end
  end
  
  if attributes[:'licenseId']
    self.license_id = attributes[:'licenseId']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#date_created ⇒ Object

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



28
29
30
 
# File 'lib/purecloud/models/dnc_list_create.rb', line 28

def date_created
  @date_created
end

#date_modified ⇒ Object

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



31
32
33
 
# File 'lib/purecloud/models/dnc_list_create.rb', line 31

def date_modified
  @date_modified
end

#dnc_codes ⇒ Object

the list of dnc.com codes to be treated as DNC



49
50
51
 
# File 'lib/purecloud/models/dnc_list_create.rb', line 49

def dnc_codes
  @dnc_codes
end

#dnc_source_type ⇒ Object

the type of dnc list being created, rds (csv file), gryphon, or dnc.com



43
44
45
 
# File 'lib/purecloud/models/dnc_list_create.rb', line 43

def dnc_source_type
  @dnc_source_type
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#import_status ⇒ Object

the status of the import process



37
38
39
 
# File 'lib/purecloud/models/dnc_list_create.rb', line 37

def import_status
  @import_status
end

#license_id ⇒ Object

the license number if the dncSourceType is gryphon



52
53
54
 
# File 'lib/purecloud/models/dnc_list_create.rb', line 52

def license_id
  @license_id
end

#login_id ⇒ Object

the loginId if the dncSourceType is dnc.com



46
47
48
 
# File 'lib/purecloud/models/dnc_list_create.rb', line 46

def 
  @login_id
end

#name ⇒ Object

The name of the list.



25
26
27
 
# File 'lib/purecloud/models/dnc_list_create.rb', line 25

def name
  @name
end

#self_uri ⇒ Object

The URI for this object



55
56
57
 
# File 'lib/purecloud/models/dnc_list_create.rb', line 55

def self_uri
  @self_uri
end

#size ⇒ Object

the number of phone numbers in the do not call list



40
41
42
 
# File 'lib/purecloud/models/dnc_list_create.rb', line 40

def size
  @size
end

#version ⇒ Object

Required for updates, must match the version number of the most recent update



34
35
36
 
# File 'lib/purecloud/models/dnc_list_create.rb', line 34

def version
  @version
end

Class Method Details

.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
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/purecloud/models/dnc_list_create.rb', line 58

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'version' => :'version',
    
    :'import_status' => :'importStatus',
    
    :'size' => :'size',
    
    :'dnc_source_type' => :'dncSourceType',
    
    :'login_id' => :'loginId',
    
    :'dnc_codes' => :'dncCodes',
    
    :'license_id' => :'licenseId',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/purecloud/models/dnc_list_create.rb', line 89

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'date_created' => :'DateTime',
    :'date_modified' => :'DateTime',
    :'version' => :'Integer',
    :'import_status' => :'ImportStatus',
    :'size' => :'Integer',
    :'dnc_source_type' => :'String',
    :'login_id' => :'String',
    :'dnc_codes' => :'Array<String>',
    :'license_id' => :'String',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/purecloud/models/dnc_list_create.rb', line 176

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      version == o.version &&
      import_status == o.import_status &&
      size == o.size &&
      dnc_source_type == o.dnc_source_type &&
       == o. &&
      dnc_codes == o.dnc_codes &&
      license_id == o.license_id &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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

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



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/purecloud/models/dnc_list_create.rb', line 283

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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/purecloud/models/dnc_list_create.rb', line 204

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


194
195
196
 
# File 'lib/purecloud/models/dnc_list_create.rb', line 194

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



199
200
201
 
# File 'lib/purecloud/models/dnc_list_create.rb', line 199

def hash
  [id, name, date_created, date_modified, version, import_status, size, dnc_source_type, , dnc_codes, license_id, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



266
267
268
 
# File 'lib/purecloud/models/dnc_list_create.rb', line 266

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



271
272
273
274
275
276
277
278
279
 
# File 'lib/purecloud/models/dnc_list_create.rb', line 271

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 



261
262
263
 
# File 'lib/purecloud/models/dnc_list_create.rb', line 261

def to_s
  to_hash.to_s
end