Class: PureCloud::AuditSearchResult

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AuditSearchResult

Initializes the object



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

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

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

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

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

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

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

end

Instance Attribute Details

#audit_messages ⇒ Object

Returns the value of attribute audit_messages.



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

def audit_messages
  @audit_messages
end

#facet_info ⇒ Object

Returns the value of attribute facet_info.



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

def facet_info
  @facet_info
end

#page_count ⇒ Object

The number of pages of results.



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

def page_count
  @page_count
end

#page_number ⇒ Object

Which page was returned.



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

def page_number
  @page_number
end

#page_size ⇒ Object

The number of results in a page.



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

def page_size
  @page_size
end

#total ⇒ Object

The total number of results.



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/audit_search_result.rb', line 28

def total
  @total
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/purecloudplatformclientv2/models/audit_search_result.rb', line 38

def self.attribute_map
  {
    :'page_number' => :'pageNumber',
    :'page_size' => :'pageSize',
    :'total' => :'total',
    :'page_count' => :'pageCount',
    :'facet_info' => :'facetInfo',
    :'audit_messages' => :'auditMessages'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/purecloudplatformclientv2/models/audit_search_result.rb', line 50

def self.swagger_types
  {
    :'page_number' => :'Integer',
    :'page_size' => :'Integer',
    :'total' => :'Integer',
    :'page_count' => :'Integer',
    :'facet_info' => :'Array<FacetInfo>',
    :'audit_messages' => :'Array<AuditMessage>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



113
114
115
116
117
118
119
120
121
122
 
# File 'lib/purecloudplatformclientv2/models/audit_search_result.rb', line 113

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      page_number == o.page_number &&
      page_size == o.page_size &&
      total == o.total &&
      page_count == o.page_count &&
      facet_info == o.facet_info &&
      audit_messages == o.audit_messages
end

#_deserialize(type, value) ⇒ Object 



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

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



216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/purecloudplatformclientv2/models/audit_search_result.rb', line 216

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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/purecloudplatformclientv2/models/audit_search_result.rb', line 137

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

See Also:

  • `==` method


126
127
128
 
# File 'lib/purecloudplatformclientv2/models/audit_search_result.rb', line 126

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



132
133
134
 
# File 'lib/purecloudplatformclientv2/models/audit_search_result.rb', line 132

def hash
  [page_number, page_size, total, page_count, facet_info, audit_messages].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



101
102
103
104
 
# File 'lib/purecloudplatformclientv2/models/audit_search_result.rb', line 101

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



199
200
201
 
# File 'lib/purecloudplatformclientv2/models/audit_search_result.rb', line 199

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



204
205
206
207
208
209
210
211
212
 
# File 'lib/purecloudplatformclientv2/models/audit_search_result.rb', line 204

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 



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

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



108
109
 
# File 'lib/purecloudplatformclientv2/models/audit_search_result.rb', line 108

def valid?
end