Class: PureCloud::CampaignNotificationContactSort

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/models/campaign_notification_contact_sort.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CampaignNotificationContactSort

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/purecloudclient_v2a/models/campaign_notification_contact_sort.rb', line 61

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

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

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



27
28
29
 
# File 'lib/purecloudclient_v2a/models/campaign_notification_contact_sort.rb', line 27

def additional_properties
  @additional_properties
end

#direction ⇒ Object

Returns the value of attribute direction.



23
24
25
 
# File 'lib/purecloudclient_v2a/models/campaign_notification_contact_sort.rb', line 23

def direction
  @direction
end

#field_name ⇒ Object

Returns the value of attribute field_name.



21
22
23
 
# File 'lib/purecloudclient_v2a/models/campaign_notification_contact_sort.rb', line 21

def field_name
  @field_name
end

#numeric ⇒ Object

Returns the value of attribute numeric.



25
26
27
 
# File 'lib/purecloudclient_v2a/models/campaign_notification_contact_sort.rb', line 25

def numeric
  @numeric
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/purecloudclient_v2a/models/campaign_notification_contact_sort.rb', line 30

def self.attribute_map
  {
    
    :'field_name' => :'fieldName',
    
    :'direction' => :'direction',
    
    :'numeric' => :'numeric',
    
    :'additional_properties' => :'additionalProperties'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/purecloudclient_v2a/models/campaign_notification_contact_sort.rb', line 45

def self.swagger_types
  {
    
    :'field_name' => :'String',
    
    :'direction' => :'String',
    
    :'numeric' => :'BOOLEAN',
    
    :'additional_properties' => :'Object'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



174
175
176
177
178
179
180
181
 
# File 'lib/purecloudclient_v2a/models/campaign_notification_contact_sort.rb', line 174

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      field_name == o.field_name &&
      direction == o.direction &&
      numeric == o.numeric &&
      additional_properties == o.additional_properties
end

#_deserialize(type, value) ⇒ Object 



215
216
217
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
 
# File 'lib/purecloudclient_v2a/models/campaign_notification_contact_sort.rb', line 215

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



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/purecloudclient_v2a/models/campaign_notification_contact_sort.rb', line 275

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/purecloudclient_v2a/models/campaign_notification_contact_sort.rb', line 196

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


185
186
187
 
# File 'lib/purecloudclient_v2a/models/campaign_notification_contact_sort.rb', line 185

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



191
192
193
 
# File 'lib/purecloudclient_v2a/models/campaign_notification_contact_sort.rb', line 191

def hash
  [field_name, direction, numeric, 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



108
109
110
111
112
113
 
# File 'lib/purecloudclient_v2a/models/campaign_notification_contact_sort.rb', line 108

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



258
259
260
 
# File 'lib/purecloudclient_v2a/models/campaign_notification_contact_sort.rb', line 258

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



263
264
265
266
267
268
269
270
271
 
# File 'lib/purecloudclient_v2a/models/campaign_notification_contact_sort.rb', line 263

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 



253
254
255
 
# File 'lib/purecloudclient_v2a/models/campaign_notification_contact_sort.rb', line 253

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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/purecloudclient_v2a/models/campaign_notification_contact_sort.rb', line 117

def valid?
  
  
  
  
  
  
  
  allowed_values = ["ASC", "DESC"]
  if @direction && !allowed_values.include?(@direction)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
end