Class: PureCloud::ReportRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/report_request.rb

Overview

Used to perform a search on various data stored in search engines

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReportRequest

Returns a new instance of ReportRequest.



55
56
57
58
59
60
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
 
# File 'lib/purecloud/models/report_request.rb', line 55

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'pageNumber']
    self.page_number = attributes[:'pageNumber']
  end
  
  if attributes[:'pageSize']
    self.page_size = attributes[:'pageSize']
  end
  
  if attributes[:'facetRequests']
    if (value = attributes[:'facetRequests']).is_a?(Array)
      self.facet_requests = value
    end
  end
  
  if attributes[:'sort']
    if (value = attributes[:'sort']).is_a?(Array)
      self.sort = value
    end
  end
  
  if attributes[:'filters']
    if (value = attributes[:'filters']).is_a?(Array)
      self.filters = value
    end
  end
  
  if attributes[:'groupBy']
    if (value = attributes[:'groupBy']).is_a?(Array)
      self.group_by = value
    end
  end
  
end

Instance Attribute Details

#facet_requests ⇒ Object

List of facet requests to generate summary views from the report result set (if any)



13
14
15
 
# File 'lib/purecloud/models/report_request.rb', line 13

def facet_requests
  @facet_requests
end

#filters ⇒ Object

You can also restrict the request to particular field values and ranges



19
20
21
 
# File 'lib/purecloud/models/report_request.rb', line 19

def filters
  @filters
end

#group_by ⇒ Object

Returns the value of attribute group_by.



21
22
23
 
# File 'lib/purecloud/models/report_request.rb', line 21

def group_by
  @group_by
end

#page_number ⇒ Object

The pageNumber to get results from (EG If there are 100 results with a pageSize of 10 and pageNumber is 3 then 10 results will be returned starting with index #31



7
8
9
 
# File 'lib/purecloud/models/report_request.rb', line 7

def page_number
  @page_number
end

#page_size ⇒ Object

Number of entries to return/calculate per page.



10
11
12
 
# File 'lib/purecloud/models/report_request.rb', line 10

def page_size
  @page_size
end

#sort ⇒ Object

sort the results on a field(s)



16
17
18
 
# File 'lib/purecloud/models/report_request.rb', line 16

def sort
  @sort
end

Class Method Details

.attribute_map ⇒ Object

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



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/purecloud/models/report_request.rb', line 24

def self.attribute_map
  {
    
    :'page_number' => :'pageNumber',
    
    :'page_size' => :'pageSize',
    
    :'facet_requests' => :'facetRequests',
    
    :'sort' => :'sort',
    
    :'filters' => :'filters',
    
    :'group_by' => :'groupBy'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/purecloud/models/report_request.rb', line 43

def self.swagger_types
  {
    :'page_number' => :'Integer',
    :'page_size' => :'Integer',
    :'facet_requests' => :'Array<FacetRequest>',
    :'sort' => :'Array<SortField>',
    :'filters' => :'Array<FilterItem>',
    :'group_by' => :'Array<String>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



97
98
99
100
101
102
103
104
105
106
 
# File 'lib/purecloud/models/report_request.rb', line 97

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      page_number == o.page_number &&
      page_size == o.page_size &&
      facet_requests == o.facet_requests &&
      sort == o.sort &&
      filters == o.filters &&
      group_by == o.group_by
end

#_deserialize(type, value) ⇒ Object 



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
165
166
167
168
169
170
171
 
# File 'lib/purecloud/models/report_request.rb', line 138

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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



195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/purecloud/models/report_request.rb', line 195

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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/purecloud/models/report_request.rb', line 119

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

Returns:

  • (Boolean)

See Also:

  • `==` method


109
110
111
 
# File 'lib/purecloud/models/report_request.rb', line 109

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



114
115
116
 
# File 'lib/purecloud/models/report_request.rb', line 114

def hash
  [page_number, page_size, facet_requests, sort, filters, group_by].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



178
179
180
 
# File 'lib/purecloud/models/report_request.rb', line 178

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



183
184
185
186
187
188
189
190
191
 
# File 'lib/purecloud/models/report_request.rb', line 183

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 



173
174
175
 
# File 'lib/purecloud/models/report_request.rb', line 173

def to_s
  to_hash.to_s
end