Class: PureCloud::SearchApi
- Inherits:
-
Object
- Object
- PureCloud::SearchApi
- Defined in:
- lib/purecloud/api/search_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#get_search(opts = {}) ⇒ GroupsSearchResponse
Search using q64.
-
#get_search_0(opts = {}) ⇒ LocationsSearchResponse
Search using q64.
-
#get_search_0_with_http_info(opts = {}) ⇒ Array<(LocationsSearchResponse, Fixnum, Hash)>
Search using q64.
-
#get_search_1(opts = {}) ⇒ JsonNodeSearchResponse
Search using q64.
-
#get_search_1_with_http_info(opts = {}) ⇒ Array<(JsonNodeSearchResponse, Fixnum, Hash)>
Search using q64.
-
#get_search_2(opts = {}) ⇒ UsersSearchResponse
Search using q64.
-
#get_search_2_with_http_info(opts = {}) ⇒ Array<(UsersSearchResponse, Fixnum, Hash)>
Search using q64.
-
#get_search_with_http_info(opts = {}) ⇒ Array<(GroupsSearchResponse, Fixnum, Hash)>
Search using q64.
-
#get_suggest(opts = {}) ⇒ JsonNodeSearchResponse
Suggest using q64.
-
#get_suggest_with_http_info(opts = {}) ⇒ Array<(JsonNodeSearchResponse, Fixnum, Hash)>
Suggest using q64.
-
#initialize(api_client = ApiClient.default) ⇒ SearchApi
constructor
A new instance of SearchApi.
-
#post_search(opts = {}) ⇒ GroupsSearchResponse
Search.
-
#post_search_0(opts = {}) ⇒ LocationsSearchResponse
Search.
-
#post_search_0_with_http_info(opts = {}) ⇒ Array<(LocationsSearchResponse, Fixnum, Hash)>
Search.
-
#post_search_1(opts = {}) ⇒ JsonNodeSearchResponse
Search.
-
#post_search_1_with_http_info(opts = {}) ⇒ Array<(JsonNodeSearchResponse, Fixnum, Hash)>
Search.
-
#post_search_2(opts = {}) ⇒ UsersSearchResponse
Search.
-
#post_search_2_with_http_info(opts = {}) ⇒ Array<(UsersSearchResponse, Fixnum, Hash)>
Search.
-
#post_search_with_http_info(opts = {}) ⇒ Array<(GroupsSearchResponse, Fixnum, Hash)>
Search.
-
#post_suggest(opts = {}) ⇒ JsonNodeSearchResponse
Suggest.
-
#post_suggest_with_http_info(opts = {}) ⇒ Array<(JsonNodeSearchResponse, Fixnum, Hash)>
Suggest.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
21 22 23 |
# File 'lib/purecloud/api/search_api.rb', line 21 def api_client @api_client end |
Instance Method Details
#get_search(opts = {}) ⇒ GroupsSearchResponse
Search using q64
33 34 35 36 |
# File 'lib/purecloud/api/search_api.rb', line 33 def get_search(opts = {}) data, status_code, headers = get_search_with_http_info(opts) return data end |
#get_search_0(opts = {}) ⇒ LocationsSearchResponse
Search using q64
94 95 96 97 |
# File 'lib/purecloud/api/search_api.rb', line 94 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<(LocationsSearchResponse, Fixnum, Hash)>
Search using q64
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 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 |
# File 'lib/purecloud/api/search_api.rb', line 105 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 local_var_path = "/api/v2/locations/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, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'LocationsSearchResponse') 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 = {}) ⇒ JsonNodeSearchResponse
Search using q64
156 157 158 159 |
# File 'lib/purecloud/api/search_api.rb', line 156 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<(JsonNodeSearchResponse, Fixnum, Hash)>
Search using q64
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 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 |
# File 'lib/purecloud/api/search_api.rb', line 168 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 local_var_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'] query_params[:'profile'] = opts[:'profile'] if opts[:'profile'] # 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, local_var_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_1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_search_2(opts = {}) ⇒ UsersSearchResponse
Search using q64
219 220 221 222 |
# File 'lib/purecloud/api/search_api.rb', line 219 def get_search_2(opts = {}) data, status_code, headers = get_search_2_with_http_info(opts) return data end |
#get_search_2_with_http_info(opts = {}) ⇒ Array<(UsersSearchResponse, Fixnum, Hash)>
Search using q64
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'lib/purecloud/api/search_api.rb', line 230 def get_search_2_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#get_search_2 ..." end # resource path local_var_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, local_var_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_2\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
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 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/purecloud/api/search_api.rb', line 44 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 local_var_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, local_var_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 |
#get_suggest(opts = {}) ⇒ JsonNodeSearchResponse
Suggest using q64
280 281 282 283 |
# File 'lib/purecloud/api/search_api.rb', line 280 def get_suggest(opts = {}) data, status_code, headers = get_suggest_with_http_info(opts) return data end |
#get_suggest_with_http_info(opts = {}) ⇒ Array<(JsonNodeSearchResponse, Fixnum, Hash)>
Suggest using q64
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/purecloud/api/search_api.rb', line 291 def get_suggest_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#get_suggest ..." end # resource path local_var_path = "/api/v2/search/suggest".sub('{format}','json') # query parameters query_params = {} query_params[:'q64'] = opts[:'q64'] if opts[:'q64'] query_params[:'profile'] = opts[:'profile'] if opts[:'profile'] # 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, local_var_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_suggest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#post_search(opts = {}) ⇒ GroupsSearchResponse
Search
340 341 342 343 |
# File 'lib/purecloud/api/search_api.rb', line 340 def post_search(opts = {}) data, status_code, headers = post_search_with_http_info(opts) return data end |
#post_search_0(opts = {}) ⇒ LocationsSearchResponse
Search
397 398 399 400 |
# File 'lib/purecloud/api/search_api.rb', line 397 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<(LocationsSearchResponse, Fixnum, Hash)>
Search
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 |
# File 'lib/purecloud/api/search_api.rb', line 407 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 local_var_path = "/api/v2/locations/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, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'LocationsSearchResponse') 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 = {}) ⇒ JsonNodeSearchResponse
Search
455 456 457 458 |
# File 'lib/purecloud/api/search_api.rb', line 455 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<(JsonNodeSearchResponse, Fixnum, Hash)>
Search
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 |
# File 'lib/purecloud/api/search_api.rb', line 466 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 local_var_path = "/api/v2/search".sub('{format}','json') # query parameters query_params = {} query_params[:'profile'] = opts[:'profile'] if opts[:'profile'] # 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, local_var_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_1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#post_search_2(opts = {}) ⇒ UsersSearchResponse
Search
514 515 516 517 |
# File 'lib/purecloud/api/search_api.rb', line 514 def post_search_2(opts = {}) data, status_code, headers = post_search_2_with_http_info(opts) return data end |
#post_search_2_with_http_info(opts = {}) ⇒ Array<(UsersSearchResponse, Fixnum, Hash)>
Search
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 |
# File 'lib/purecloud/api/search_api.rb', line 524 def post_search_2_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#post_search_2 ..." end # resource path local_var_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, local_var_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_2\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
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 |
# File 'lib/purecloud/api/search_api.rb', line 350 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 local_var_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, local_var_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 |
#post_suggest(opts = {}) ⇒ JsonNodeSearchResponse
Suggest
572 573 574 575 |
# File 'lib/purecloud/api/search_api.rb', line 572 def post_suggest(opts = {}) data, status_code, headers = post_suggest_with_http_info(opts) return data end |
#post_suggest_with_http_info(opts = {}) ⇒ Array<(JsonNodeSearchResponse, Fixnum, Hash)>
Suggest
583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 |
# File 'lib/purecloud/api/search_api.rb', line 583 def post_suggest_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#post_suggest ..." end # resource path local_var_path = "/api/v2/search/suggest".sub('{format}','json') # query parameters query_params = {} query_params[:'profile'] = opts[:'profile'] if opts[:'profile'] # 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, local_var_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_suggest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |