Class: PureCloud::DocumentationSearchCriteria

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentationSearchCriteria

Returns a new instance of DocumentationSearchCriteria.



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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/purecloud/models/documentation_search_criteria.rb', line 83

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[:'endValue']
    self.end_value = attributes[:'endValue']
  end
  
  if attributes[:'values']
    if (value = attributes[:'values']).is_a?(Array)
      self.values = value
    end
  end
  
  if attributes[:'startValue']
    self.start_value = attributes[:'startValue']
  end
  
  if attributes[:'fields']
    if (value = attributes[:'fields']).is_a?(Array)
      self.fields = value
    end
  end
  
  if attributes[:'value']
    self.value = attributes[:'value']
  end
  
  if attributes[:'operator']
    self.operator = attributes[:'operator']
  end
  
  if attributes[:'group']
    if (value = attributes[:'group']).is_a?(Array)
      self.group = value
    end
  end
  
  if attributes[:'type']
    self.type = attributes[:'type']
  end
  
end

Instance Attribute Details

#end_value ⇒ Object

The end value of the range. This field is used for range search types.



22
23
24
 
# File 'lib/purecloud/models/documentation_search_criteria.rb', line 22

def end_value
  @end_value
end

#fields ⇒ Object

Field names to search against



31
32
33
 
# File 'lib/purecloud/models/documentation_search_criteria.rb', line 31

def fields
  @fields
end

#group ⇒ Object

Groups multiple conditions



40
41
42
 
# File 'lib/purecloud/models/documentation_search_criteria.rb', line 40

def group
  @group
end

#operator ⇒ Object

How to apply this search criteria against other criteria



37
38
39
 
# File 'lib/purecloud/models/documentation_search_criteria.rb', line 37

def operator
  @operator
end

#start_value ⇒ Object

The start value of the range. This field is used for range search types.



28
29
30
 
# File 'lib/purecloud/models/documentation_search_criteria.rb', line 28

def start_value
  @start_value
end

#type ⇒ Object

Search Type



43
44
45
 
# File 'lib/purecloud/models/documentation_search_criteria.rb', line 43

def type
  @type
end

#value ⇒ Object

A value for the search to match against



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

def value
  @value
end

#values ⇒ Object

A list of values for the search to match against



25
26
27
 
# File 'lib/purecloud/models/documentation_search_criteria.rb', line 25

def values
  @values
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/purecloud/models/documentation_search_criteria.rb', line 46

def self.attribute_map
  {
    
    :'end_value' => :'endValue',
    
    :'values' => :'values',
    
    :'start_value' => :'startValue',
    
    :'fields' => :'fields',
    
    :'value' => :'value',
    
    :'operator' => :'operator',
    
    :'group' => :'group',
    
    :'type' => :'type'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/purecloud/models/documentation_search_criteria.rb', line 69

def self.swagger_types
  {
    :'end_value' => :'String',
    :'values' => :'Array<String>',
    :'start_value' => :'String',
    :'fields' => :'Array<String>',
    :'value' => :'String',
    :'operator' => :'String',
    :'group' => :'Array<DocumentationSearchCriteria>',
    :'type' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/purecloud/models/documentation_search_criteria.rb', line 149

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      end_value == o.end_value &&
      values == o.values &&
      start_value == o.start_value &&
      fields == o.fields &&
      value == o.value &&
      operator == o.operator &&
      group == o.group &&
      type == o.type
end

#_deserialize(type, value) ⇒ Object 



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
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/purecloud/models/documentation_search_criteria.rb', line 192

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



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/purecloud/models/documentation_search_criteria.rb', line 252

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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/purecloud/models/documentation_search_criteria.rb', line 173

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


163
164
165
 
# File 'lib/purecloud/models/documentation_search_criteria.rb', line 163

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



168
169
170
 
# File 'lib/purecloud/models/documentation_search_criteria.rb', line 168

def hash
  [end_value, values, start_value, fields, value, operator, group, type].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



235
236
237
 
# File 'lib/purecloud/models/documentation_search_criteria.rb', line 235

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



240
241
242
243
244
245
246
247
248
 
# File 'lib/purecloud/models/documentation_search_criteria.rb', line 240

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 



230
231
232
 
# File 'lib/purecloud/models/documentation_search_criteria.rb', line 230

def to_s
  to_hash.to_s
end