Class: PureCloud::LicenseApi
- Inherits:
-
Object
- Object
- PureCloud::LicenseApi
- Defined in:
- lib/purecloudplatformclientv2/api/license_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#get_license_definition(license_id, opts = {}) ⇒ LicenseDefinition
Get PureCloud license definition.
-
#get_license_definition_with_http_info(license_id, opts = {}) ⇒ Array<(LicenseDefinition, Fixnum, Hash)>
Get PureCloud license definition.
-
#get_license_definitions(opts = {}) ⇒ Array<LicenseDefinition>
Get all PureCloud license definitions available for the organization.
-
#get_license_definitions_with_http_info(opts = {}) ⇒ Array<(Array<LicenseDefinition>, Fixnum, Hash)>
Get all PureCloud license definitions available for the organization.
-
#get_license_toggle(feature_name, opts = {}) ⇒ LicenseOrgToggle
Get PureCloud license feature toggle value.
-
#get_license_toggle_with_http_info(feature_name, opts = {}) ⇒ Array<(LicenseOrgToggle, Fixnum, Hash)>
Get PureCloud license feature toggle value.
-
#get_license_user(user_id, opts = {}) ⇒ LicenseUser
Get licenses for specified user.
-
#get_license_user_with_http_info(user_id, opts = {}) ⇒ Array<(LicenseUser, Fixnum, Hash)>
Get licenses for specified user.
-
#get_license_users(opts = {}) ⇒ UserLicensesEntityListing
Get a page of users and their licenses Retrieve a page of users in an organization along with the licenses they possess.
-
#get_license_users_with_http_info(opts = {}) ⇒ Array<(UserLicensesEntityListing, Fixnum, Hash)>
Get a page of users and their licenses Retrieve a page of users in an organization along with the licenses they possess.
-
#initialize(api_client = ApiClient.default) ⇒ LicenseApi
constructor
A new instance of LicenseApi.
-
#post_license_infer(opts = {}) ⇒ Array<String>
Get a list of licenses inferred based on a list of roleIds.
-
#post_license_infer_with_http_info(opts = {}) ⇒ Array<(Array<String>, Fixnum, Hash)>
Get a list of licenses inferred based on a list of roleIds.
-
#post_license_organization(opts = {}) ⇒ Array<LicenseUpdateStatus>
Update the organization’s license assignments in a batch.
-
#post_license_organization_with_http_info(opts = {}) ⇒ Array<(Array<LicenseUpdateStatus>, Fixnum, Hash)>
Update the organization's license assignments in a batch.
-
#post_license_toggle(feature_name, opts = {}) ⇒ LicenseOrgToggle
Switch PureCloud license feature toggle value.
-
#post_license_toggle_with_http_info(feature_name, opts = {}) ⇒ Array<(LicenseOrgToggle, Fixnum, Hash)>
Switch PureCloud license feature toggle value.
-
#post_license_users(opts = {}) ⇒ Hash<String, Object>
Fetch user licenses in a batch.
-
#post_license_users_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>
Fetch user licenses in a batch.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ LicenseApi
Returns a new instance of LicenseApi.
23 24 25 |
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 23 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
21 22 23 |
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 21 def api_client @api_client end |
Instance Method Details
#get_license_definition(license_id, opts = {}) ⇒ LicenseDefinition
Get PureCloud license definition.
32 33 34 35 |
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 32 def get_license_definition(license_id, opts = {}) data, _status_code, _headers = get_license_definition_with_http_info(license_id, opts) return data end |
#get_license_definition_with_http_info(license_id, opts = {}) ⇒ Array<(LicenseDefinition, Fixnum, Hash)>
Get PureCloud license definition.
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 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 42 def get_license_definition_with_http_info(license_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: LicenseApi.get_license_definition ..." end # verify the required parameter 'license_id' is set fail ArgumentError, "Missing the required parameter 'license_id' when calling LicenseApi.get_license_definition" if license_id.nil? # resource path local_var_path = "/api/v2/license/definitions/{licenseId}".sub('{format}','json').sub('{' + 'licenseId' + '}', license_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] 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 => 'LicenseDefinition') if @api_client.config.debugging @api_client.config.logger.debug "API called: LicenseApi#get_license_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_license_definitions(opts = {}) ⇒ Array<LicenseDefinition>
Get all PureCloud license definitions available for the organization.
96 97 98 99 |
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 96 def get_license_definitions(opts = {}) data, _status_code, _headers = get_license_definitions_with_http_info(opts) return data end |
#get_license_definitions_with_http_info(opts = {}) ⇒ Array<(Array<LicenseDefinition>, Fixnum, Hash)>
Get all PureCloud license definitions available for the organization.
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 |
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 105 def get_license_definitions_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: LicenseApi.get_license_definitions ..." end # resource path local_var_path = "/api/v2/license/definitions".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] 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 => 'Array<LicenseDefinition>') if @api_client.config.debugging @api_client.config.logger.debug "API called: LicenseApi#get_license_definitions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_license_toggle(feature_name, opts = {}) ⇒ LicenseOrgToggle
Get PureCloud license feature toggle value.
152 153 154 155 |
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 152 def get_license_toggle(feature_name, opts = {}) data, _status_code, _headers = get_license_toggle_with_http_info(feature_name, opts) return data end |
#get_license_toggle_with_http_info(feature_name, opts = {}) ⇒ Array<(LicenseOrgToggle, Fixnum, Hash)>
Get PureCloud license feature toggle value.
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 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 |
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 162 def get_license_toggle_with_http_info(feature_name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: LicenseApi.get_license_toggle ..." end # verify the required parameter 'feature_name' is set fail ArgumentError, "Missing the required parameter 'feature_name' when calling LicenseApi.get_license_toggle" if feature_name.nil? # resource path local_var_path = "/api/v2/license/toggles/{featureName}".sub('{format}','json').sub('{' + 'featureName' + '}', feature_name.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] 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 => 'LicenseOrgToggle') if @api_client.config.debugging @api_client.config.logger.debug "API called: LicenseApi#get_license_toggle\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_license_user(user_id, opts = {}) ⇒ LicenseUser
Get licenses for specified user.
217 218 219 220 |
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 217 def get_license_user(user_id, opts = {}) data, _status_code, _headers = get_license_user_with_http_info(user_id, opts) return data end |
#get_license_user_with_http_info(user_id, opts = {}) ⇒ Array<(LicenseUser, Fixnum, Hash)>
Get licenses for specified user.
227 228 229 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 273 274 275 |
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 227 def get_license_user_with_http_info(user_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: LicenseApi.get_license_user ..." end # verify the required parameter 'user_id' is set fail ArgumentError, "Missing the required parameter 'user_id' when calling LicenseApi.get_license_user" if user_id.nil? # resource path local_var_path = "/api/v2/license/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] 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 => 'LicenseUser') if @api_client.config.debugging @api_client.config.logger.debug "API called: LicenseApi#get_license_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_license_users(opts = {}) ⇒ UserLicensesEntityListing
Get a page of users and their licenses Retrieve a page of users in an organization along with the licenses they possess.
283 284 285 286 |
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 283 def get_license_users(opts = {}) data, _status_code, _headers = get_license_users_with_http_info(opts) return data end |
#get_license_users_with_http_info(opts = {}) ⇒ Array<(UserLicensesEntityListing, Fixnum, Hash)>
Get a page of users and their licenses Retrieve a page of users in an organization along with the licenses they possess.
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 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 |
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 294 def get_license_users_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: LicenseApi.get_license_users ..." end # resource path local_var_path = "/api/v2/license/users".sub('{format}','json') # query parameters query_params = {} query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size'] query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] 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 => 'UserLicensesEntityListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: LicenseApi#get_license_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#post_license_infer(opts = {}) ⇒ Array<String>
Get a list of licenses inferred based on a list of roleIds
355 356 357 358 |
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 355 def post_license_infer(opts = {}) data, _status_code, _headers = post_license_infer_with_http_info(opts) return data end |
#post_license_infer_with_http_info(opts = {}) ⇒ Array<(Array<String>, Fixnum, Hash)>
Get a list of licenses inferred based on a list of roleIds
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 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 |
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 365 def post_license_infer_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: LicenseApi.post_license_infer ..." end # resource path local_var_path = "/api/v2/license/infer".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'body']) auth_names = ['PureCloud OAuth'] 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 => 'Array<String>') if @api_client.config.debugging @api_client.config.logger.debug "API called: LicenseApi#post_license_infer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#post_license_organization(opts = {}) ⇒ Array<LicenseUpdateStatus>
Update the organization’s license assignments in a batch.
418 419 420 421 |
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 418 def post_license_organization(opts = {}) data, _status_code, _headers = post_license_organization_with_http_info(opts) return data end |
#post_license_organization_with_http_info(opts = {}) ⇒ Array<(Array<LicenseUpdateStatus>, Fixnum, Hash)>
Update the organization's license assignments in a batch.
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 |
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 428 def post_license_organization_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: LicenseApi.post_license_organization ..." end # resource path local_var_path = "/api/v2/license/organization".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'body']) auth_names = ['PureCloud OAuth'] 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 => 'Array<LicenseUpdateStatus>') if @api_client.config.debugging @api_client.config.logger.debug "API called: LicenseApi#post_license_organization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#post_license_toggle(feature_name, opts = {}) ⇒ LicenseOrgToggle
Switch PureCloud license feature toggle value.
481 482 483 484 |
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 481 def post_license_toggle(feature_name, opts = {}) data, _status_code, _headers = post_license_toggle_with_http_info(feature_name, opts) return data end |
#post_license_toggle_with_http_info(feature_name, opts = {}) ⇒ Array<(LicenseOrgToggle, Fixnum, Hash)>
Switch PureCloud license feature toggle value.
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 |
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 491 def post_license_toggle_with_http_info(feature_name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: LicenseApi.post_license_toggle ..." end # verify the required parameter 'feature_name' is set fail ArgumentError, "Missing the required parameter 'feature_name' when calling LicenseApi.post_license_toggle" if feature_name.nil? # resource path local_var_path = "/api/v2/license/toggles/{featureName}".sub('{format}','json').sub('{' + 'featureName' + '}', feature_name.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] 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 => 'LicenseOrgToggle') if @api_client.config.debugging @api_client.config.logger.debug "API called: LicenseApi#post_license_toggle\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#post_license_users(opts = {}) ⇒ Hash<String, Object>
Fetch user licenses in a batch.
546 547 548 549 |
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 546 def post_license_users(opts = {}) data, _status_code, _headers = post_license_users_with_http_info(opts) return data end |
#post_license_users_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>
Fetch user licenses in a batch.
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 |
# File 'lib/purecloudplatformclientv2/api/license_api.rb', line 556 def post_license_users_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: LicenseApi.post_license_users ..." end # resource path local_var_path = "/api/v2/license/users".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'body']) auth_names = ['PureCloud OAuth'] 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 => 'Hash<String, Object>') if @api_client.config.debugging @api_client.config.logger.debug "API called: LicenseApi#post_license_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |