Class: PureCloud::LocationSearchRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/location_search_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LocationSearchRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/purecloudplatformclientv2/models/location_search_request.rb', line 59

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?(:'sortOrder')
    self.sort_order = attributes[:'sortOrder']
  end

  if attributes.has_key?(:'sortBy')
    self.sort_by = attributes[:'sortBy']
  end

  if attributes.has_key?(:'pageSize')
    self.page_size = attributes[:'pageSize']
  end

  if attributes.has_key?(:'pageNumber')
    self.page_number = attributes[:'pageNumber']
  end

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

end

Instance Attribute Details

#page_number ⇒ Object

The page of resources you want to retrieve



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/location_search_request.rb', line 31

def page_number
  @page_number
end

#page_size ⇒ Object

The number of results per page



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/location_search_request.rb', line 28

def page_size
  @page_size
end

#query ⇒ Object

Returns the value of attribute query.



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/location_search_request.rb', line 33

def query
  @query
end

#sort_by ⇒ Object

The field in the resource that you want to sort the results by



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/location_search_request.rb', line 25

def sort_by
  @sort_by
end

#sort_order ⇒ Object

The sort order for results



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/location_search_request.rb', line 22

def sort_order
  @sort_order
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
 
# File 'lib/purecloudplatformclientv2/models/location_search_request.rb', line 36

def self.attribute_map
  {
    :'sort_order' => :'sortOrder',
    :'sort_by' => :'sortBy',
    :'page_size' => :'pageSize',
    :'page_number' => :'pageNumber',
    :'query' => :'query'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
 
# File 'lib/purecloudplatformclientv2/models/location_search_request.rb', line 47

def self.swagger_types
  {
    :'sort_order' => :'String',
    :'sort_by' => :'String',
    :'page_size' => :'Integer',
    :'page_number' => :'Integer',
    :'query' => :'Array<LocationSearchCriteria>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



117
118
119
120
121
122
123
124
125
 
# File 'lib/purecloudplatformclientv2/models/location_search_request.rb', line 117

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      sort_order == o.sort_order &&
      sort_by == o.sort_by &&
      page_size == o.page_size &&
      page_number == o.page_number &&
      query == o.query
end

#_deserialize(type, value) ⇒ Object 



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
192
193
194
195
 
# File 'lib/purecloudplatformclientv2/models/location_search_request.rb', line 159

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



219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/purecloudplatformclientv2/models/location_search_request.rb', line 219

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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/purecloudplatformclientv2/models/location_search_request.rb', line 140

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


129
130
131
 
# File 'lib/purecloudplatformclientv2/models/location_search_request.rb', line 129

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



135
136
137
 
# File 'lib/purecloudplatformclientv2/models/location_search_request.rb', line 135

def hash
  [sort_order, sort_by, page_size, page_number, 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



91
92
93
94
 
# File 'lib/purecloudplatformclientv2/models/location_search_request.rb', line 91

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



202
203
204
 
# File 'lib/purecloudplatformclientv2/models/location_search_request.rb', line 202

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



207
208
209
210
211
212
213
214
215
 
# File 'lib/purecloudplatformclientv2/models/location_search_request.rb', line 207

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 



197
198
199
 
# File 'lib/purecloudplatformclientv2/models/location_search_request.rb', line 197

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



98
99
100
101
102
103
 
# File 'lib/purecloudplatformclientv2/models/location_search_request.rb', line 98

def valid?
  allowed_values = ["ASC", "DESC", "SCORE"]
  if @sort_order && !allowed_values.include?(@sort_order)
    return false
  end
end