Class: PureCloud::ContactList

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ContactList

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#attempt_limits ⇒ Object

the associated AttemptLimits



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

def attempt_limits
  @attempt_limits
end

#column_names ⇒ Object

the contact column names



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

def column_names
  @column_names
end

#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



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

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



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

def date_modified
  @date_modified
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#import_status ⇒ Object

the status of the import process



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

def import_status
  @import_status
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#phone_columns ⇒ Object

the columns containing phone numbers



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

def phone_columns
  @phone_columns
end

#preview_mode_accepted_values ⇒ Object

list of user-defined values indicating the contact is to be dialed in preview mode only



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

def preview_mode_accepted_values
  @preview_mode_accepted_values
end

#preview_mode_column_name ⇒ Object

the name of the column that holds the indicators for contacts that are to be dialed in preview mode only



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

def preview_mode_column_name
  @preview_mode_column_name
end

#self_uri ⇒ Object

The URI for this object



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

def self_uri
  @self_uri
end

#size ⇒ Object

the number of contacts in the contact list



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

def size
  @size
end

#version ⇒ Object

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



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/purecloudplatformclientv2/models/contact_list.rb', line 60

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'date_created' => :'dateCreated',
    :'date_modified' => :'dateModified',
    :'version' => :'version',
    :'column_names' => :'columnNames',
    :'phone_columns' => :'phoneColumns',
    :'import_status' => :'importStatus',
    :'preview_mode_column_name' => :'previewModeColumnName',
    :'preview_mode_accepted_values' => :'previewModeAcceptedValues',
    :'size' => :'size',
    :'attempt_limits' => :'attemptLimits',
    :'self_uri' => :'selfUri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/purecloudplatformclientv2/models/contact_list.rb', line 79

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'date_created' => :'DateTime',
    :'date_modified' => :'DateTime',
    :'version' => :'Integer',
    :'column_names' => :'Array<String>',
    :'phone_columns' => :'Array<ContactPhoneNumberColumn>',
    :'import_status' => :'ImportStatus',
    :'preview_mode_column_name' => :'String',
    :'preview_mode_accepted_values' => :'Array<String>',
    :'size' => :'Integer',
    :'attempt_limits' => :'UriReference',
    :'self_uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/purecloudplatformclientv2/models/contact_list.rb', line 187

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 &&
      column_names == o.column_names &&
      phone_columns == o.phone_columns &&
      import_status == o.import_status &&
      preview_mode_column_name == o.preview_mode_column_name &&
      preview_mode_accepted_values == o.preview_mode_accepted_values &&
      size == o.size &&
      attempt_limits == o.attempt_limits &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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

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



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/purecloudplatformclientv2/models/contact_list.rb', line 297

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/purecloudplatformclientv2/models/contact_list.rb', line 218

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


207
208
209
 
# File 'lib/purecloudplatformclientv2/models/contact_list.rb', line 207

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



213
214
215
 
# File 'lib/purecloudplatformclientv2/models/contact_list.rb', line 213

def hash
  [id, name, date_created, date_modified, version, column_names, phone_columns, import_status, preview_mode_column_name, preview_mode_accepted_values, size, attempt_limits, 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



167
168
169
170
 
# File 'lib/purecloudplatformclientv2/models/contact_list.rb', line 167

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



280
281
282
 
# File 'lib/purecloudplatformclientv2/models/contact_list.rb', line 280

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



285
286
287
288
289
290
291
292
293
 
# File 'lib/purecloudplatformclientv2/models/contact_list.rb', line 285

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 



275
276
277
 
# File 'lib/purecloudplatformclientv2/models/contact_list.rb', line 275

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



174
175
176
177
178
179
180
181
182
183
 
# File 'lib/purecloudplatformclientv2/models/contact_list.rb', line 174

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

  if @phone_columns.nil?
    return false
  end

end