Class: PureCloud::TrusteeAuditQueryRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TrusteeAuditQueryRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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/purecloudclient_v2a/models/trustee_audit_query_request.rb', line 86

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?(:'trusteeOrganizationIds')
    
    if (value = attributes[:'trusteeOrganizationIds']).is_a?(Array)
      self.trustee_organization_ids = value
    end
    
    
  
  end

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

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

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

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

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

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

  
end

Instance Attribute Details

#end_date ⇒ Object

Ending date/time for the audit search. ISO-8601 formatted date-time, UTC.



31
32
33
 
# File 'lib/purecloudclient_v2a/models/trustee_audit_query_request.rb', line 31

def end_date
  @end_date
end

#facets ⇒ Object

Facet information to be returned with the query results.



37
38
39
 
# File 'lib/purecloudclient_v2a/models/trustee_audit_query_request.rb', line 37

def facets
  @facets
end

#filters ⇒ Object

Additional custom filters to be applied to the query.



40
41
42
 
# File 'lib/purecloudclient_v2a/models/trustee_audit_query_request.rb', line 40

def filters
  @filters
end

#query_phrase ⇒ Object

Word or phrase to look for in audit bodies.



34
35
36
 
# File 'lib/purecloudclient_v2a/models/trustee_audit_query_request.rb', line 34

def query_phrase
  @query_phrase
end

#start_date ⇒ Object

Starting date/time for the audit search. ISO-8601 formatted date-time, UTC.



28
29
30
 
# File 'lib/purecloudclient_v2a/models/trustee_audit_query_request.rb', line 28

def start_date
  @start_date
end

#trustee_organization_ids ⇒ Object

Limit returned audits to these trustee organizationIds.



22
23
24
 
# File 'lib/purecloudclient_v2a/models/trustee_audit_query_request.rb', line 22

def trustee_organization_ids
  @trustee_organization_ids
end

#trustee_user_ids ⇒ Object

Limit returned audits to these trustee userIds.



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

def trustee_user_ids
  @trustee_user_ids
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/purecloudclient_v2a/models/trustee_audit_query_request.rb', line 43

def self.attribute_map
  {
    
    :'trustee_organization_ids' => :'trusteeOrganizationIds',
    
    :'trustee_user_ids' => :'trusteeUserIds',
    
    :'start_date' => :'startDate',
    
    :'end_date' => :'endDate',
    
    :'query_phrase' => :'queryPhrase',
    
    :'facets' => :'facets',
    
    :'filters' => :'filters'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/purecloudclient_v2a/models/trustee_audit_query_request.rb', line 64

def self.swagger_types
  {
    
    :'trustee_organization_ids' => :'Array<String>',
    
    :'trustee_user_ids' => :'Array<String>',
    
    :'start_date' => :'DateTime',
    
    :'end_date' => :'DateTime',
    
    :'query_phrase' => :'String',
    
    :'facets' => :'Array<Facet>',
    
    :'filters' => :'Array<Filter>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/purecloudclient_v2a/models/trustee_audit_query_request.rb', line 257

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      trustee_organization_ids == o.trustee_organization_ids &&
      trustee_user_ids == o.trustee_user_ids &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      query_phrase == o.query_phrase &&
      facets == o.facets &&
      filters == o.filters
end

#_deserialize(type, value) ⇒ Object 



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/purecloudclient_v2a/models/trustee_audit_query_request.rb', line 301

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



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/purecloudclient_v2a/models/trustee_audit_query_request.rb', line 361

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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/purecloudclient_v2a/models/trustee_audit_query_request.rb', line 282

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


271
272
273
 
# File 'lib/purecloudclient_v2a/models/trustee_audit_query_request.rb', line 271

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



277
278
279
 
# File 'lib/purecloudclient_v2a/models/trustee_audit_query_request.rb', line 277

def hash
  [trustee_organization_ids, trustee_user_ids, start_date, end_date, query_phrase, facets, filters].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



168
169
170
171
172
173
 
# File 'lib/purecloudclient_v2a/models/trustee_audit_query_request.rb', line 168

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



344
345
346
 
# File 'lib/purecloudclient_v2a/models/trustee_audit_query_request.rb', line 344

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



349
350
351
352
353
354
355
356
357
 
# File 'lib/purecloudclient_v2a/models/trustee_audit_query_request.rb', line 349

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 



339
340
341
 
# File 'lib/purecloudclient_v2a/models/trustee_audit_query_request.rb', line 339

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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/purecloudclient_v2a/models/trustee_audit_query_request.rb', line 177

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

  
  
  
  
  
  if @trustee_user_ids.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end