Class: PureCloud::DncListNotification

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DncListNotification

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/purecloudplatformclientv2/models/dnc_list_notification.rb', line 83

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

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

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

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

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

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

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

end

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



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

def additional_properties
  @additional_properties
end

#date_created ⇒ Object

Returns the value of attribute date_created.



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

def date_created
  @date_created
end

#date_modified ⇒ Object

Returns the value of attribute date_modified.



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

def date_modified
  @date_modified
end

#dnc_codes ⇒ Object

Returns the value of attribute dnc_codes.



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

def dnc_codes
  @dnc_codes
end

#dnc_source_type ⇒ Object

Returns the value of attribute dnc_source_type.



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

def dnc_source_type
  @dnc_source_type
end

#id ⇒ Object

Returns the value of attribute id.



21
22
23
 
# File 'lib/purecloudplatformclientv2/models/dnc_list_notification.rb', line 21

def id
  @id
end

#import_status ⇒ Object

Returns the value of attribute import_status.



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/dnc_list_notification.rb', line 31

def import_status
  @import_status
end

#license_id ⇒ Object

Returns the value of attribute license_id.



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

def license_id
  @license_id
end

#login_id ⇒ Object

Returns the value of attribute login_id.



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

def 
  @login_id
end

#name ⇒ Object

Returns the value of attribute name.



23
24
25
 
# File 'lib/purecloudplatformclientv2/models/dnc_list_notification.rb', line 23

def name
  @name
end

#size ⇒ Object

Returns the value of attribute size.



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

def size
  @size
end

#version ⇒ Object

Returns the value of attribute version.



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/purecloudplatformclientv2/models/dnc_list_notification.rb', line 46

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',
    :'additional_properties' => :'additionalProperties'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/purecloudplatformclientv2/models/dnc_list_notification.rb', line 64

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/purecloudplatformclientv2/models/dnc_list_notification.rb', line 169

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 &&
      additional_properties == o.additional_properties
end

#_deserialize(type, value) ⇒ Object 



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

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



278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/purecloudplatformclientv2/models/dnc_list_notification.rb', line 278

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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/purecloudplatformclientv2/models/dnc_list_notification.rb', line 199

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


188
189
190
 
# File 'lib/purecloudplatformclientv2/models/dnc_list_notification.rb', line 188

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



194
195
196
 
# File 'lib/purecloudplatformclientv2/models/dnc_list_notification.rb', line 194

def hash
  [id, name, date_created, date_modified, version, import_status, size, dnc_source_type, , dnc_codes, license_id, additional_properties].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



143
144
145
146
 
# File 'lib/purecloudplatformclientv2/models/dnc_list_notification.rb', line 143

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



261
262
263
 
# File 'lib/purecloudplatformclientv2/models/dnc_list_notification.rb', line 261

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



266
267
268
269
270
271
272
273
274
 
# File 'lib/purecloudplatformclientv2/models/dnc_list_notification.rb', line 266

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 



256
257
258
 
# File 'lib/purecloudplatformclientv2/models/dnc_list_notification.rb', line 256

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



150
151
152
153
154
155
 
# File 'lib/purecloudplatformclientv2/models/dnc_list_notification.rb', line 150

def valid?
  allowed_values = ["RDS", "DNC_COM", "GRYPHON"]
  if @dnc_source_type && !allowed_values.include?(@dnc_source_type)
    return false
  end
end