Class: PureCloud::SearchApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/api/search_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SearchApi

Returns a new instance of SearchApi.



7
8
9
 
# File 'lib/purecloud/api/search_api.rb', line 7

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/purecloud/api/search_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#get_search(opts = {}) ⇒ GroupsSearchResponse

Search using q64

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q64 (String)
  • :expand (Array<String>)

Returns:



17
18
19
20
 
# File 'lib/purecloud/api/search_api.rb', line 17

def get_search(opts = {})
  data, status_code, headers = get_search_with_http_info(opts)
  return data
end

#get_search_0(opts = {}) ⇒ JsonNodeSearchResponse

Search using q64

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q64 (String)
  • :expand (Array<String>)

Returns:



137
138
139
140
 
# File 'lib/purecloud/api/search_api.rb', line 137

def get_search_0(opts = {})
  data, status_code, headers = get_search_0_with_http_info(opts)
  return data
end

#get_search_0_with_http_info(opts = {}) ⇒ Array<(JsonNodeSearchResponse, Fixnum, Hash)>

Search using q64

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q64 (String)
  • :expand (Array<String>)

Returns:

  • (Array<(JsonNodeSearchResponse, Fixnum, Hash)>) —

    JsonNodeSearchResponse data, response status code and response headers



148
149
150
151
152
153
154
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/api/search_api.rb', line 148

def get_search_0_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SearchApi#get_search_0 ..."
  end
  
  # resource path
  path = "/api/v2/search".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'q64'] = opts[:'q64'] if opts[:'q64']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'JsonNodeSearchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SearchApi#get_search_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_search_1(opts = {}) ⇒ UsersSearchResponse

Search using q64

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q64 (String)
  • :expand (Array<String>)

Returns:



257
258
259
260
 
# File 'lib/purecloud/api/search_api.rb', line 257

def get_search_1(opts = {})
  data, status_code, headers = get_search_1_with_http_info(opts)
  return data
end

#get_search_1_with_http_info(opts = {}) ⇒ Array<(UsersSearchResponse, Fixnum, Hash)>

Search using q64

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q64 (String)
  • :expand (Array<String>)

Returns:

  • (Array<(UsersSearchResponse, Fixnum, Hash)>) —

    UsersSearchResponse data, response status code and response headers



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/purecloud/api/search_api.rb', line 268

def get_search_1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SearchApi#get_search_1 ..."
  end
  
  # resource path
  path = "/api/v2/users/search".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'q64'] = opts[:'q64'] if opts[:'q64']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UsersSearchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SearchApi#get_search_1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_search_with_http_info(opts = {}) ⇒ Array<(GroupsSearchResponse, Fixnum, Hash)>

Search using q64

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q64 (String)
  • :expand (Array<String>)

Returns:

  • (Array<(GroupsSearchResponse, Fixnum, Hash)>) —

    GroupsSearchResponse data, response status code and response headers



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/purecloud/api/search_api.rb', line 28

def get_search_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SearchApi#get_search ..."
  end
  
  # resource path
  path = "/api/v2/groups/search".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'q64'] = opts[:'q64'] if opts[:'q64']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GroupsSearchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SearchApi#get_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_search(opts = {}) ⇒ GroupsSearchResponse

Search

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



78
79
80
81
 
# File 'lib/purecloud/api/search_api.rb', line 78

def post_search(opts = {})
  data, status_code, headers = post_search_with_http_info(opts)
  return data
end

#post_search_0(opts = {}) ⇒ JsonNodeSearchResponse

Search

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



198
199
200
201
 
# File 'lib/purecloud/api/search_api.rb', line 198

def post_search_0(opts = {})
  data, status_code, headers = post_search_0_with_http_info(opts)
  return data
end

#post_search_0_with_http_info(opts = {}) ⇒ Array<(JsonNodeSearchResponse, Fixnum, Hash)>

Search

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(JsonNodeSearchResponse, Fixnum, Hash)>) —

    JsonNodeSearchResponse data, response status code and response headers



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/purecloud/api/search_api.rb', line 208

def post_search_0_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SearchApi#post_search_0 ..."
  end
  
  # resource path
  path = "/api/v2/search".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'JsonNodeSearchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SearchApi#post_search_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_search_1(opts = {}) ⇒ UsersSearchResponse

Search

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



318
319
320
321
 
# File 'lib/purecloud/api/search_api.rb', line 318

def post_search_1(opts = {})
  data, status_code, headers = post_search_1_with_http_info(opts)
  return data
end

#post_search_1_with_http_info(opts = {}) ⇒ Array<(UsersSearchResponse, Fixnum, Hash)>

Search

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(UsersSearchResponse, Fixnum, Hash)>) —

    UsersSearchResponse data, response status code and response headers



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/purecloud/api/search_api.rb', line 328

def post_search_1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SearchApi#post_search_1 ..."
  end
  
  # resource path
  path = "/api/v2/users/search".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UsersSearchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SearchApi#post_search_1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_search_with_http_info(opts = {}) ⇒ Array<(GroupsSearchResponse, Fixnum, Hash)>

Search

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(GroupsSearchResponse, Fixnum, Hash)>) —

    GroupsSearchResponse data, response status code and response headers



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
129
 
# File 'lib/purecloud/api/search_api.rb', line 88

def post_search_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SearchApi#post_search ..."
  end
  
  # resource path
  path = "/api/v2/groups/search".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GroupsSearchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SearchApi#post_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end