Class: PureCloud::GroupSearchRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GroupSearchRequest

Returns a new instance of GroupSearchRequest.



76
77
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
114
115
116
117
 
# File 'lib/purecloud/models/group_search_request.rb', line 76

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[:'sortOrder']
    self.sort_order = attributes[:'sortOrder']
  end
  
  if attributes[:'sortBy']
    self.sort_by = attributes[:'sortBy']
  end
  
  if attributes[:'pageSize']
    self.page_size = attributes[:'pageSize']
  end
  
  if attributes[:'pageNumber']
    self.page_number = attributes[:'pageNumber']
  end
  
  if attributes[:'returnFields']
    if (value = attributes[:'returnFields']).is_a?(Array)
      self.return_fields = value
    end
  end
  
  if attributes[:'expand']
    if (value = attributes[:'expand']).is_a?(Array)
      self.expand = value
    end
  end
  
  if attributes[:'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



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

def expand
  @expand
end

#page_number ⇒ Object

The page of resources you want to retrieve



31
32
33
 
# File 'lib/purecloud/models/group_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/purecloud/models/group_search_request.rb', line 28

def page_size
  @page_size
end

#query ⇒ Object

Returns the value of attribute query.



39
40
41
 
# File 'lib/purecloud/models/group_search_request.rb', line 39

def query
  @query
end

#return_fields ⇒ Object

A List of strings containing the resource field paths that you want to return



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

def return_fields
  @return_fields
end

#sort_by ⇒ Object

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



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

def sort_by
  @sort_by
end

#sort_order ⇒ Object

The sort order for results



22
23
24
 
# File 'lib/purecloud/models/group_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.



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

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

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/purecloud/models/group_search_request.rb', line 63

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

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/purecloud/models/group_search_request.rb', line 129

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 &&
      return_fields == o.return_fields &&
      expand == o.expand &&
      query == o.query
end

#_deserialize(type, value) ⇒ Object 



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
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/purecloud/models/group_search_request.rb', line 171

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



231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/purecloud/models/group_search_request.rb', line 231

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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/purecloud/models/group_search_request.rb', line 152

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


142
143
144
 
# File 'lib/purecloud/models/group_search_request.rb', line 142

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



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

def hash
  [sort_order, sort_by, page_size, page_number, return_fields, expand, query].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



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

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



219
220
221
222
223
224
225
226
227
 
# File 'lib/purecloud/models/group_search_request.rb', line 219

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 



209
210
211
 
# File 'lib/purecloud/models/group_search_request.rb', line 209

def to_s
  to_hash.to_s
end