Class: PureCloud::FacetRequest

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

Overview

Used as part of a searchRequest or reportRequest to denote which facets to generate from the search results. For RANGE facets, one of rangeFrom or rangeTo (or both) MUST be set

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FacetRequest

Returns a new instance of FacetRequest.



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
105
106
107
108
109
110
111
112
113
 
# File 'lib/purecloud/models/facet_request.rb', line 78

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[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'facetRequestQueryType']
    self.facet_request_query_type = attributes[:'facetRequestQueryType']
  end
  
  if attributes[:'fieldName']
    self.field_name = attributes[:'fieldName']
  end
  
  if attributes[:'type']
    self.type = attributes[:'type']
  end
  
  if attributes[:'rangeFrom']
    self.range_from = attributes[:'rangeFrom']
  end
  
  if attributes[:'rangeTo']
    self.range_to = attributes[:'rangeTo']
  end
  
  if attributes[:'maxFacetCount']
    self.max_facet_count = attributes[:'maxFacetCount']
  end
  
end

Instance Attribute Details

#facet_request_query_type ⇒ Object

Which facet request type



26
27
28
 
# File 'lib/purecloud/models/facet_request.rb', line 26

def facet_request_query_type
  @facet_request_query_type
end

#field_name ⇒ Object

The fieldName to perform the facet request on.



29
30
31
 
# File 'lib/purecloud/models/facet_request.rb', line 29

def field_name
  @field_name
end

#max_facet_count ⇒ Object

Limits/expands the number of facet entries returned (default 500)



41
42
43
 
# File 'lib/purecloud/models/facet_request.rb', line 41

def max_facet_count
  @max_facet_count
end

#name ⇒ Object

name of the facet request that will be returned with the result set



23
24
25
 
# File 'lib/purecloud/models/facet_request.rb', line 23

def name
  @name
end

#range_from ⇒ Object

For RANGE requests populate this field to specify the beginning of a limit (leave blank for openended). Note this value is inclusive of the results. (EG if the value is 1, 1 will be included in the range.)



35
36
37
 
# File 'lib/purecloud/models/facet_request.rb', line 35

def range_from
  @range_from
end

#range_to ⇒ Object

For RANGE requests populate this field to specify the end of a limit (leave blank for openended). Note this value is EXCLUSIVE of the result (EG if this value was 5, only values LESS THAN 5 will be included in the count.)



38
39
40
 
# File 'lib/purecloud/models/facet_request.rb', line 38

def range_to
  @range_to
end

#type ⇒ Object

the fieldtype of the field to perform the facet request on.



32
33
34
 
# File 'lib/purecloud/models/facet_request.rb', line 32

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    
    :'name' => :'name',
    
    :'facet_request_query_type' => :'facetRequestQueryType',
    
    :'field_name' => :'fieldName',
    
    :'type' => :'type',
    
    :'range_from' => :'rangeFrom',
    
    :'range_to' => :'rangeTo',
    
    :'max_facet_count' => :'maxFacetCount'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/purecloud/models/facet_request.rb', line 65

def self.swagger_types
  {
    :'name' => :'String',
    :'facet_request_query_type' => :'String',
    :'field_name' => :'String',
    :'type' => :'String',
    :'range_from' => :'String',
    :'range_to' => :'String',
    :'max_facet_count' => :'Integer'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/purecloud/models/facet_request.rb', line 134

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      facet_request_query_type == o.facet_request_query_type &&
      field_name == o.field_name &&
      type == o.type &&
      range_from == o.range_from &&
      range_to == o.range_to &&
      max_facet_count == o.max_facet_count
end

#_deserialize(type, value) ⇒ Object 



176
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
 
# File 'lib/purecloud/models/facet_request.rb', line 176

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



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/purecloud/models/facet_request.rb', line 236

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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/purecloud/models/facet_request.rb', line 157

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


147
148
149
 
# File 'lib/purecloud/models/facet_request.rb', line 147

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



152
153
154
 
# File 'lib/purecloud/models/facet_request.rb', line 152

def hash
  [name, facet_request_query_type, field_name, type, range_from, range_to, max_facet_count].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



219
220
221
 
# File 'lib/purecloud/models/facet_request.rb', line 219

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



224
225
226
227
228
229
230
231
232
 
# File 'lib/purecloud/models/facet_request.rb', line 224

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 



214
215
216
 
# File 'lib/purecloud/models/facet_request.rb', line 214

def to_s
  to_hash.to_s
end