Class: PureCloud::FacetResult

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

Overview

Used as part of the searchResult to return facet results to the caller

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FacetResult

Returns a new instance of FacetResult.



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/facet_result.rb', line 65

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[:'requestName']
    self.request_name = attributes[:'requestName']
  end
  
  if attributes[:'requestFieldName']
    self.request_field_name = attributes[:'requestFieldName']
  end
  
  if attributes[:'fieldType']
    self.field_type = attributes[:'fieldType']
  end
  
  if attributes[:'requestType']
    self.request_type = attributes[:'requestType']
  end
  
  if attributes[:'results']
    if (value = attributes[:'results']).is_a?(Array)
      self.results = value
    end
  end
  
end

Instance Attribute Details

#field_type ⇒ Object

data type of the field being returned (if this is a mixed field this will be unknown)



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

def field_type
  @field_type
end

#request_field_name ⇒ Object

The field name that the facet was requested for.



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

def request_field_name
  @request_field_name
end

#request_name ⇒ Object

This was the name passed in as part of the facetRequest



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

def request_name
  @request_name
end

#request_type ⇒ Object

the facet request type that was made.



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

def request_type
  @request_type
end

#results ⇒ Object

Returns the value of attribute results.



34
35
36
 
# File 'lib/purecloud/models/facet_result.rb', line 34

def results
  @results
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/purecloud/models/facet_result.rb', line 37

def self.attribute_map
  {
    
    :'request_name' => :'requestName',
    
    :'request_field_name' => :'requestFieldName',
    
    :'field_type' => :'fieldType',
    
    :'request_type' => :'requestType',
    
    :'results' => :'results'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/purecloud/models/facet_result.rb', line 54

def self.swagger_types
  {
    :'request_name' => :'String',
    :'request_field_name' => :'String',
    :'field_type' => :'String',
    :'request_type' => :'String',
    :'results' => :'Array<FacetResultItem>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



115
116
117
118
119
120
121
122
123
 
# File 'lib/purecloud/models/facet_result.rb', line 115

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      request_name == o.request_name &&
      request_field_name == o.request_field_name &&
      field_type == o.field_type &&
      request_type == o.request_type &&
      results == o.results
end

#_deserialize(type, value) ⇒ Object 



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

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



215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/purecloud/models/facet_result.rb', line 215

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



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

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


126
127
128
 
# File 'lib/purecloud/models/facet_result.rb', line 126

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



131
132
133
 
# File 'lib/purecloud/models/facet_result.rb', line 131

def hash
  [request_name, request_field_name, field_type, request_type, results].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



198
199
200
 
# File 'lib/purecloud/models/facet_result.rb', line 198

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



203
204
205
206
207
208
209
210
211
 
# File 'lib/purecloud/models/facet_result.rb', line 203

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 



193
194
195
 
# File 'lib/purecloud/models/facet_result.rb', line 193

def to_s
  to_hash.to_s
end