Class: PureCloud::SuggestSearchRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SuggestSearchRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
95
96
97
98
 
# File 'lib/purecloudclient_v2a/models/suggest_search_request.rb', line 58

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

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

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

  
end

Instance Attribute Details

#expand ⇒ Object

Provides more details about a specified resource



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

def expand
  @expand
end

#query ⇒ Object

Suggest query



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

def query
  @query
end

#types ⇒ Object

Resource domain type to search



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

def types
  @types
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/purecloudclient_v2a/models/suggest_search_request.rb', line 31

def self.attribute_map
  {
    
    :'expand' => :'expand',
    
    :'types' => :'types',
    
    :'query' => :'query'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/purecloudclient_v2a/models/suggest_search_request.rb', line 44

def self.swagger_types
  {
    
    :'expand' => :'Array<String>',
    
    :'types' => :'Array<String>',
    
    :'query' => :'Array<SuggestSearchCriteria>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



155
156
157
158
159
160
161
 
# File 'lib/purecloudclient_v2a/models/suggest_search_request.rb', line 155

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      expand == o.expand &&
      types == o.types &&
      query == o.query
end

#_deserialize(type, value) ⇒ Object 



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
229
230
231
 
# File 'lib/purecloudclient_v2a/models/suggest_search_request.rb', line 195

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



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

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



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/purecloudclient_v2a/models/suggest_search_request.rb', line 176

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


165
166
167
 
# File 'lib/purecloudclient_v2a/models/suggest_search_request.rb', line 165

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



171
172
173
 
# File 'lib/purecloudclient_v2a/models/suggest_search_request.rb', line 171

def hash
  [expand, types, query].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



102
103
104
105
106
107
 
# File 'lib/purecloudclient_v2a/models/suggest_search_request.rb', line 102

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



238
239
240
 
# File 'lib/purecloudclient_v2a/models/suggest_search_request.rb', line 238

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



243
244
245
246
247
248
249
250
251
 
# File 'lib/purecloudclient_v2a/models/suggest_search_request.rb', line 243

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 



233
234
235
 
# File 'lib/purecloudclient_v2a/models/suggest_search_request.rb', line 233

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



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
 
# File 'lib/purecloudclient_v2a/models/suggest_search_request.rb', line 111

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

  
  
  
  
  
  if @query.nil?
    return false
  end

  
  
  
  
end