purecloudplatformclientv2 39.1.0 → 40.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/AuthorizationApi.md +80 -0
  4. data/docs/CreateQueueRequest.md +1 -1
  5. data/docs/DomainOrganizationRole.md +1 -1
  6. data/docs/DomainOrganizationRoleCreate.md +1 -1
  7. data/docs/DomainOrganizationRoleUpdate.md +1 -1
  8. data/docs/ExternalContactsApi.md +3 -3
  9. data/docs/JsonNode.md +4 -4
  10. data/docs/QualityApi.md +1 -1
  11. data/docs/QueueRequest.md +37 -0
  12. data/docs/RoutingApi.md +5 -5
  13. data/docs/SubjectDivisionGrants.md +17 -0
  14. data/docs/SubjectDivisionGrantsEntityListing.md +22 -0
  15. data/docs/TimeZone.md +2 -2
  16. data/docs/UserQueue.md +0 -1
  17. data/docs/WritableDivision.md +15 -0
  18. data/lib/purecloudplatformclientv2.rb +4 -0
  19. data/lib/purecloudplatformclientv2/api/authorization_api.rb +119 -0
  20. data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +2 -2
  21. data/lib/purecloudplatformclientv2/api/routing_api.rb +2 -2
  22. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  23. data/lib/purecloudplatformclientv2/models/create_queue_request.rb +1 -1
  24. data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
  25. data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
  26. data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
  27. data/lib/purecloudplatformclientv2/models/forecast_time_series_result.rb +2 -2
  28. data/lib/purecloudplatformclientv2/models/history_listing.rb +2 -2
  29. data/lib/purecloudplatformclientv2/models/json_node.rb +76 -76
  30. data/lib/purecloudplatformclientv2/models/operation.rb +2 -2
  31. data/lib/purecloudplatformclientv2/models/queue_request.rb +870 -0
  32. data/lib/purecloudplatformclientv2/models/subject_division_grants.rb +319 -0
  33. data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +428 -0
  34. data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -24
  35. data/lib/purecloudplatformclientv2/models/user_queue.rb +1 -27
  36. data/lib/purecloudplatformclientv2/models/writable_division.rb +253 -0
  37. data/lib/purecloudplatformclientv2/version.rb +1 -1
  38. metadata +10 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 60ed3ed1c7f5c344698ed228b2278fa58954c076
4
- data.tar.gz: 3a0769a8582b8805f6dc1c155f3ae4cfb0aa8439
3
+ metadata.gz: d78efd690398b7b5d30b5a896b3f36fe273e91f2
4
+ data.tar.gz: b1a00d5fcdf794dc14981717c8d5c2a8cb41fd15
5
5
  SHA512:
6
- metadata.gz: d74861f6f1dfd9d89a6b89f0fd1ed8ea422644a7afb8465e72cc77ef545190a4b50d9118fce043fceb901a0292baf91d2c218ea99c526d6c260a34eebd0c0967
7
- data.tar.gz: 548dd74722ac140beddc9506957cb2ca2fc1ee2a0c87a9f7e9ba553c6b8e19400b3a2d47ba0555a293b6afccf37ceea966224f335d60cb7173c1dcb40969d936
6
+ metadata.gz: e3d124be2740f5409a6121b4c272ab5d10f11b26334487ce76da48cba0ad44bc075bf8bb85fc23ce91ac72ddde5a10f39b0e7304dbcfaf633221bac0b78f5d50
7
+ data.tar.gz: 7c5d63362b4ba854ca8bac35f49fb510c2862278baefb29b7ca6e1092ad82b0d2b17afdfed8b8b47be1542271da76c55bd31514721448441ef7a0a8e4a835785
data/README.md CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: PureCloud Ruby Gem
3
3
  ---
4
- ![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=39.1.0)
4
+ ![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=40.0.0)
5
5
 
6
6
  Documentation can be found at [https://developer.mypurecloud.com/api/rest/client-libraries/ruby/](https://developer.mypurecloud.com/api/rest/client-libraries/ruby/)
7
7
 
@@ -10,7 +10,7 @@ Documentation can be found at [https://developer.mypurecloud.com/api/rest/client
10
10
  ### from rubygems.org
11
11
 
12
12
  ~~~ ruby
13
- gem install 'purecloudplatformclientv2', '~> 39.1.0'
13
+ gem install 'purecloudplatformclientv2', '~> 40.0.0'
14
14
  ~~~
15
15
 
16
16
  ### Install from Git
@@ -14,6 +14,7 @@ Method | Description
14
14
  [**get_authorization_products**](AuthorizationApi.html#get_authorization_products) | Get the list of enabled products
15
15
  [**get_authorization_role**](AuthorizationApi.html#get_authorization_role) | Get a single organization role.
16
16
  [**get_authorization_role_comparedefault_right_role_id**](AuthorizationApi.html#get_authorization_role_comparedefault_right_role_id) | Get an org role to default role comparison comparison
17
+ [**get_authorization_role_subjectgrants**](AuthorizationApi.html#get_authorization_role_subjectgrants) | Get the subjects' granted divisions in the specified role.
17
18
  [**get_authorization_roles**](AuthorizationApi.html#get_authorization_roles) | Retrieve a list of all roles defined for the organization
18
19
  [**get_user_roles**](AuthorizationApi.html#get_user_roles) | Returns a listing of roles and permissions for a user.
19
20
  [**patch_authorization_role**](AuthorizationApi.html#patch_authorization_role) | Patch Organization Role for needsUpdate Field
@@ -417,6 +418,85 @@ Name | Type | Description | Notes
417
418
 
418
419
 
419
420
 
421
+ <a name="get_authorization_role_subjectgrants"></a>
422
+
423
+ ## -[**SubjectDivisionGrantsEntityListing**](SubjectDivisionGrantsEntityListing.html) get_authorization_role_subjectgrants(role_id, opts)
424
+
425
+
426
+
427
+ Get the subjects' granted divisions in the specified role.
428
+
429
+ Includes the divisions for which the subject has a grant.
430
+
431
+ Wraps GET /api/v2/authorization/roles/{roleId}/subjectgrants
432
+
433
+ Requires ANY permissions:
434
+
435
+ * authorization:role:view
436
+
437
+
438
+ ### Example
439
+ ~~~ruby
440
+ # load the gem
441
+ require 'purecloudplatformclientv2'
442
+ # setup authorization
443
+ @secret = ENV['PURECLOUD_SECRET']
444
+ @id = ENV['PURECLOUD_CLIENT_ID']
445
+ environment = "mypurecloud.com"
446
+
447
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
448
+
449
+ PureCloud.configure do |config|
450
+ config.access_token = @authToken
451
+ end
452
+
453
+ api_instance = PureCloud::AuthorizationApi.new
454
+
455
+ role_id = "role_id_example" # String | Role ID
456
+
457
+ opts = {
458
+ page_size: 25, # Integer | The total page size requested
459
+ page_number: 1, # Integer | The page number requested
460
+ sort_by: "sort_by_example", # String | variable name requested to sort by
461
+ expand: ["expand_example"], # Array<String> | variable name requested by expand list
462
+ next_page: "next_page_example", # String | next page token
463
+ previous_page: "previous_page_example" # String | Previous page token
464
+ }
465
+
466
+ begin
467
+ #Get the subjects' granted divisions in the specified role.
468
+ result = api_instance.get_authorization_role_subjectgrants(role_id, opts)
469
+ p result
470
+ rescue PureCloud::ApiError => e
471
+ puts "Exception when calling AuthorizationApi->get_authorization_role_subjectgrants: #{e}"
472
+ end
473
+ ~~~
474
+
475
+ ### Parameters
476
+
477
+ Name | Type | Description | Notes
478
+ ------------- | ------------- | ------------- | -------------
479
+ **role_id** | **String**| Role ID | |
480
+ **page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
481
+ **page_number** | **Integer**| The page number requested | [optional] [default to 1] |
482
+ **sort_by** | **String**| variable name requested to sort by | [optional] |
483
+ **expand** | [**Array&lt;String&gt;**](String.html)| variable name requested by expand list | [optional] |
484
+ **next_page** | **String**| next page token | [optional] |
485
+ **previous_page** | **String**| Previous page token | [optional] |
486
+ {: class="table table-striped"}
487
+
488
+
489
+ ### Return type
490
+
491
+ [**SubjectDivisionGrantsEntityListing**](SubjectDivisionGrantsEntityListing.html)
492
+
493
+ ### HTTP request headers
494
+
495
+ - **Content-Type**: application/json
496
+ - **Accept**: application/json
497
+
498
+
499
+
420
500
  <a name="get_authorization_roles"></a>
421
501
 
422
502
  ## -[**OrganizationRoleEntityListing**](OrganizationRoleEntityListing.html) get_authorization_roles(opts)
@@ -9,7 +9,7 @@ title: CreateQueueRequest
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
- | **division** | [**Division**](Division.html) | The division to which this entity belongs. | [optional] |
12
+ | **division** | [**WritableDivision**](WritableDivision.html) | The division to which this entity belongs. | [optional] |
13
13
  | **description** | **String** | The queue description. | [optional] |
14
14
  | **version** | **Integer** | The current version of the queue. | [optional] |
15
15
  | **date_created** | **DateTime** | The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
@@ -15,8 +15,8 @@ title: DomainOrganizationRole
15
15
  | **permission_policies** | [**Array&lt;DomainPermissionPolicy&gt;**](DomainPermissionPolicy.html) | | [optional] |
16
16
  | **user_count** | **Integer** | | [optional] |
17
17
  | **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
18
- | **default** | **BOOLEAN** | | [optional] |
19
18
  | **base** | **BOOLEAN** | | [optional] |
19
+ | **default** | **BOOLEAN** | | [optional] |
20
20
  | **self_uri** | **String** | The URI for this object | [optional] |
21
21
  {: class="table table-striped"}
22
22
 
@@ -15,8 +15,8 @@ title: DomainOrganizationRoleCreate
15
15
  | **permission_policies** | [**Array&lt;DomainPermissionPolicy&gt;**](DomainPermissionPolicy.html) | | [optional] |
16
16
  | **user_count** | **Integer** | | [optional] |
17
17
  | **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
18
- | **default** | **BOOLEAN** | | [optional] |
19
18
  | **base** | **BOOLEAN** | | [optional] |
19
+ | **default** | **BOOLEAN** | | [optional] |
20
20
  | **self_uri** | **String** | The URI for this object | [optional] |
21
21
  {: class="table table-striped"}
22
22
 
@@ -15,8 +15,8 @@ title: DomainOrganizationRoleUpdate
15
15
  | **permission_policies** | [**Array&lt;DomainPermissionPolicy&gt;**](DomainPermissionPolicy.html) | | [optional] |
16
16
  | **user_count** | **Integer** | | [optional] |
17
17
  | **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
18
- | **default** | **BOOLEAN** | | [optional] |
19
18
  | **base** | **BOOLEAN** | | [optional] |
19
+ | **default** | **BOOLEAN** | | [optional] |
20
20
  | **self_uri** | **String** | The URI for this object | [optional] |
21
21
  {: class="table table-striped"}
22
22
 
@@ -25,7 +25,7 @@ Method | Description
25
25
  [**get_externalcontacts_organization_relationships**](ExternalContactsApi.html#get_externalcontacts_organization_relationships) | Fetch a relationship for an external organization
26
26
  [**get_externalcontacts_organizations**](ExternalContactsApi.html#get_externalcontacts_organizations) | Search for external organizations
27
27
  [**get_externalcontacts_relationship**](ExternalContactsApi.html#get_externalcontacts_relationship) | Fetch a relationship
28
- [**get_externalcontacts_reversewhitepageslookup**](ExternalContactsApi.html#get_externalcontacts_reversewhitepageslookup) | Lookup contacts and externalOrganizations based on an attribute
28
+ [**get_externalcontacts_reversewhitepageslookup**](ExternalContactsApi.html#get_externalcontacts_reversewhitepageslookup) | Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned.
29
29
  [**post_externalcontacts_contact_notes**](ExternalContactsApi.html#post_externalcontacts_contact_notes) | Create a note for an external contact
30
30
  [**post_externalcontacts_contacts**](ExternalContactsApi.html#post_externalcontacts_contacts) | Create an external contact
31
31
  [**post_externalcontacts_organization_notes**](ExternalContactsApi.html#post_externalcontacts_organization_notes) | Create a note for an external organization
@@ -1243,7 +1243,7 @@ Name | Type | Description | Notes
1243
1243
 
1244
1244
 
1245
1245
 
1246
- Lookup contacts and externalOrganizations based on an attribute
1246
+ Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned.
1247
1247
 
1248
1248
 
1249
1249
 
@@ -1278,7 +1278,7 @@ opts = {
1278
1278
  }
1279
1279
 
1280
1280
  begin
1281
- #Lookup contacts and externalOrganizations based on an attribute
1281
+ #Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned.
1282
1282
  result = api_instance.get_externalcontacts_reversewhitepageslookup(lookup_val, opts)
1283
1283
  p result
1284
1284
  rescue PureCloud::ApiError => e
data/docs/JsonNode.md CHANGED
@@ -7,19 +7,17 @@ title: JsonNode
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **array** | **BOOLEAN** | | [optional] |
11
- | **null** | **BOOLEAN** | | [optional] |
12
10
  | **node_type** | **String** | | [optional] |
13
11
  | **object** | **BOOLEAN** | | [optional] |
14
12
  | **boolean** | **BOOLEAN** | | [optional] |
15
13
  | **number** | **BOOLEAN** | | [optional] |
16
14
  | **float** | **BOOLEAN** | | [optional] |
15
+ | **floating_point_number** | **BOOLEAN** | | [optional] |
16
+ | **value_node** | **BOOLEAN** | | [optional] |
17
17
  | **container_node** | **BOOLEAN** | | [optional] |
18
18
  | **missing_node** | **BOOLEAN** | | [optional] |
19
- | **value_node** | **BOOLEAN** | | [optional] |
20
19
  | **pojo** | **BOOLEAN** | | [optional] |
21
20
  | **integral_number** | **BOOLEAN** | | [optional] |
22
- | **floating_point_number** | **BOOLEAN** | | [optional] |
23
21
  | **short** | **BOOLEAN** | | [optional] |
24
22
  | **int** | **BOOLEAN** | | [optional] |
25
23
  | **long** | **BOOLEAN** | | [optional] |
@@ -28,6 +26,8 @@ title: JsonNode
28
26
  | **big_integer** | **BOOLEAN** | | [optional] |
29
27
  | **textual** | **BOOLEAN** | | [optional] |
30
28
  | **binary** | **BOOLEAN** | | [optional] |
29
+ | **array** | **BOOLEAN** | | [optional] |
30
+ | **null** | **BOOLEAN** | | [optional] |
31
31
  {: class="table table-striped"}
32
32
 
33
33
 
data/docs/QualityApi.md CHANGED
@@ -2302,7 +2302,7 @@ Wraps PATCH /api/v2/quality/forms/surveys/{formId}
2302
2302
 
2303
2303
  Requires ANY permissions:
2304
2304
 
2305
- * quality:surveyForm:edit
2305
+ * quality:surveyForm:disable
2306
2306
 
2307
2307
 
2308
2308
  ### Example
@@ -0,0 +1,37 @@
1
+ ---
2
+ title: QueueRequest
3
+ ---
4
+ ## PureCloud::QueueRequest
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **division** | [**WritableDivision**](WritableDivision.html) | The division to which this entity belongs. | [optional] |
13
+ | **description** | **String** | The queue description. | [optional] |
14
+ | **version** | **Integer** | The current version of the queue. | [optional] |
15
+ | **date_created** | **DateTime** | The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
16
+ | **date_modified** | **DateTime** | The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
17
+ | **modified_by** | **String** | The ID of the user that last modified the queue. | [optional] |
18
+ | **created_by** | **String** | The ID of the user that created the queue. | [optional] |
19
+ | **state** | **String** | Indicates if the queue is active, inactive, or deleted. | [optional] |
20
+ | **modified_by_app** | **String** | The application that last modified the queue. | [optional] |
21
+ | **created_by_app** | **String** | The application that created the queue. | [optional] |
22
+ | **media_settings** | [**Hash&lt;String, MediaSetting&gt;**](MediaSetting.html) | The media settings for the queue. Valid Key Values: CALL, CALLBACK, CHAT, EMAIL, SOCIAL_EXPRESSION | |
23
+ | **bullseye** | [**Bullseye**](Bullseye.html) | The bulls-eye settings for the queue. | [optional] |
24
+ | **acw_settings** | [**AcwSettings**](AcwSettings.html) | The ACW settings for the queue. | |
25
+ | **skill_evaluation_method** | **String** | The skill evaluation method to use when routing conversations. | |
26
+ | **queue_flow** | [**UriReference**](UriReference.html) | The in-queue flow to use for conversations waiting in queue. | [optional] |
27
+ | **whisper_prompt** | [**UriReference**](UriReference.html) | The prompt used for whisper on the queue, if configured. | [optional] |
28
+ | **auto_answer_only** | **BOOLEAN** | Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered. | [optional] |
29
+ | **calling_party_name** | **String** | The name to use for caller identification for outbound calls from this queue. | [optional] |
30
+ | **calling_party_number** | **String** | The phone number to use for caller identification for outbound calls from this queue. | [optional] |
31
+ | **default_scripts** | [**Hash&lt;String, Script&gt;**](Script.html) | The default script Ids for the communication types. | [optional] |
32
+ | **outbound_email_address** | [**QueueEmailAddress**](QueueEmailAddress.html) | | [optional] |
33
+ | **member_count** | **Integer** | | [optional] |
34
+ | **self_uri** | **String** | The URI for this object | [optional] |
35
+ {: class="table table-striped"}
36
+
37
+
data/docs/RoutingApi.md CHANGED
@@ -53,7 +53,7 @@ Method | Description
53
53
  [**post_routing_languages**](RoutingApi.html#post_routing_languages) | Create Language
54
54
  [**post_routing_queue_users**](RoutingApi.html#post_routing_queue_users) | Bulk add or delete up to 100 queue members
55
55
  [**post_routing_queue_wrapupcodes**](RoutingApi.html#post_routing_queue_wrapupcodes) | Add up to 100 wrap-up codes to a queue
56
- [**post_routing_queues**](RoutingApi.html#post_routing_queues) | Create queue
56
+ [**post_routing_queues**](RoutingApi.html#post_routing_queues) | Create a queue
57
57
  [**post_routing_skills**](RoutingApi.html#post_routing_skills) | Create Skill
58
58
  [**post_routing_sms_addresses**](RoutingApi.html#post_routing_sms_addresses) | Provision an Address for SMS
59
59
  [**post_routing_sms_phonenumbers**](RoutingApi.html#post_routing_sms_phonenumbers) | Provision a phone number for SMS
@@ -3139,7 +3139,7 @@ Name | Type | Description | Notes
3139
3139
 
3140
3140
 
3141
3141
 
3142
- Create queue
3142
+ Create a queue
3143
3143
 
3144
3144
 
3145
3145
 
@@ -3171,7 +3171,7 @@ body = PureCloud::CreateQueueRequest.new # CreateQueueRequest | Queue
3171
3171
 
3172
3172
 
3173
3173
  begin
3174
- #Create queue
3174
+ #Create a queue
3175
3175
  result = api_instance.post_routing_queues(body)
3176
3176
  p result
3177
3177
  rescue PureCloud::ApiError => e
@@ -3771,7 +3771,7 @@ api_instance = PureCloud::RoutingApi.new
3771
3771
 
3772
3772
  queue_id = "queue_id_example" # String | Queue ID
3773
3773
 
3774
- body = PureCloud::Queue.new # Queue | Queue
3774
+ body = PureCloud::QueueRequest.new # QueueRequest | Queue
3775
3775
 
3776
3776
 
3777
3777
  begin
@@ -3788,7 +3788,7 @@ end
3788
3788
  Name | Type | Description | Notes
3789
3789
  ------------- | ------------- | ------------- | -------------
3790
3790
  **queue_id** | **String**| Queue ID | |
3791
- **body** | [**Queue**](Queue.html)| Queue | |
3791
+ **body** | [**QueueRequest**](QueueRequest.html)| Queue | |
3792
3792
  {: class="table table-striped"}
3793
3793
 
3794
3794
 
@@ -0,0 +1,17 @@
1
+ ---
2
+ title: SubjectDivisionGrants
3
+ ---
4
+ ## PureCloud::SubjectDivisionGrants
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **divisions** | [**Array&lt;Division&gt;**](Division.html) | | [optional] |
13
+ | **type** | **String** | | [optional] |
14
+ | **self_uri** | **String** | The URI for this object | [optional] |
15
+ {: class="table table-striped"}
16
+
17
+
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: SubjectDivisionGrantsEntityListing
3
+ ---
4
+ ## PureCloud::SubjectDivisionGrantsEntityListing
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **entities** | [**Array&lt;SubjectDivisionGrants&gt;**](SubjectDivisionGrants.html) | | [optional] |
11
+ | **page_size** | **Integer** | | [optional] |
12
+ | **page_number** | **Integer** | | [optional] |
13
+ | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **previous_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
17
+ | **last_uri** | **String** | | [optional] |
18
+ | **first_uri** | **String** | | [optional] |
19
+ | **page_count** | **Integer** | | [optional] |
20
+ {: class="table table-striped"}
21
+
22
+
data/docs/TimeZone.md CHANGED
@@ -7,10 +7,10 @@ title: TimeZone
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **display_name** | **String** | | [optional] |
11
- | **id** | **String** | | [optional] |
12
10
  | **dstsavings** | **Integer** | | [optional] |
13
11
  | **raw_offset** | **Integer** | | [optional] |
12
+ | **id** | **String** | | [optional] |
13
+ | **display_name** | **String** | | [optional] |
14
14
  {: class="table table-striped"}
15
15
 
16
16
 
data/docs/UserQueue.md CHANGED
@@ -25,7 +25,6 @@ title: UserQueue
25
25
  | **skill_evaluation_method** | **String** | The skill evaluation method to use when routing conversations. | |
26
26
  | **queue_flow** | [**UriReference**](UriReference.html) | The in-queue flow to use for conversations waiting in queue. | [optional] |
27
27
  | **whisper_prompt** | [**UriReference**](UriReference.html) | The prompt used for whisper on the queue, if configured. | [optional] |
28
- | **auto_answer_only** | **BOOLEAN** | Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered. | [optional] |
29
28
  | **calling_party_name** | **String** | The name to use for caller identification for outbound calls from this queue. | [optional] |
30
29
  | **calling_party_number** | **String** | The phone number to use for caller identification for outbound calls from this queue. | [optional] |
31
30
  | **default_scripts** | [**Hash&lt;String, Script&gt;**](Script.html) | The default script Ids for the communication types. | [optional] |
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: WritableDivision
3
+ ---
4
+ ## PureCloud::WritableDivision
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **self_uri** | **String** | The URI for this object | [optional] |
13
+ {: class="table table-striped"}
14
+
15
+
@@ -917,6 +917,7 @@ require 'purecloudplatformclientv2/models/queue_member'
917
917
  require 'purecloudplatformclientv2/models/queue_member_entity_listing'
918
918
  require 'purecloudplatformclientv2/models/queue_member_notification'
919
919
  require 'purecloudplatformclientv2/models/queue_reference'
920
+ require 'purecloudplatformclientv2/models/queue_request'
920
921
  require 'purecloudplatformclientv2/models/queue_utilization_diagnostic'
921
922
  require 'purecloudplatformclientv2/models/reaction'
922
923
  require 'purecloudplatformclientv2/models/recall_entry'
@@ -1081,6 +1082,8 @@ require 'purecloudplatformclientv2/models/stats_notification_notification_datum'
1081
1082
  require 'purecloudplatformclientv2/models/stats_notification_notification_metric'
1082
1083
  require 'purecloudplatformclientv2/models/stats_notification_notification_metrics'
1083
1084
  require 'purecloudplatformclientv2/models/street_address'
1085
+ require 'purecloudplatformclientv2/models/subject_division_grants'
1086
+ require 'purecloudplatformclientv2/models/subject_division_grants_entity_listing'
1084
1087
  require 'purecloudplatformclientv2/models/subscriber_response'
1085
1088
  require 'purecloudplatformclientv2/models/suggest_search_criteria'
1086
1089
  require 'purecloudplatformclientv2/models/suggest_search_request'
@@ -1296,6 +1299,7 @@ require 'purecloudplatformclientv2/models/wrap_up_code_reference'
1296
1299
  require 'purecloudplatformclientv2/models/wrapup'
1297
1300
  require 'purecloudplatformclientv2/models/wrapup_code'
1298
1301
  require 'purecloudplatformclientv2/models/wrapup_code_entity_listing'
1302
+ require 'purecloudplatformclientv2/models/writable_division'
1299
1303
  require 'purecloudplatformclientv2/models/writable_entity'
1300
1304
 
1301
1305
  # APIs
@@ -420,6 +420,125 @@ module PureCloud
420
420
  return data, status_code, headers
421
421
  end
422
422
 
423
+ # Get the subjects' granted divisions in the specified role.
424
+ # Includes the divisions for which the subject has a grant.
425
+ # @param role_id Role ID
426
+ # @param [Hash] opts the optional parameters
427
+ # @option opts [Integer] :page_size The total page size requested (default to 25)
428
+ # @option opts [Integer] :page_number The page number requested (default to 1)
429
+ # @option opts [String] :sort_by variable name requested to sort by
430
+ # @option opts [Array<String>] :expand variable name requested by expand list
431
+ # @option opts [String] :next_page next page token
432
+ # @option opts [String] :previous_page Previous page token
433
+ # @return [SubjectDivisionGrantsEntityListing]
434
+ def get_authorization_role_subjectgrants(role_id, opts = {})
435
+ data, _status_code, _headers = get_authorization_role_subjectgrants_with_http_info(role_id, opts)
436
+ return data
437
+ end
438
+
439
+ # Get the subjects&#39; granted divisions in the specified role.
440
+ # Includes the divisions for which the subject has a grant.
441
+ # @param role_id Role ID
442
+ # @param [Hash] opts the optional parameters
443
+ # @option opts [Integer] :page_size The total page size requested
444
+ # @option opts [Integer] :page_number The page number requested
445
+ # @option opts [String] :sort_by variable name requested to sort by
446
+ # @option opts [Array<String>] :expand variable name requested by expand list
447
+ # @option opts [String] :next_page next page token
448
+ # @option opts [String] :previous_page Previous page token
449
+ # @return [Array<(SubjectDivisionGrantsEntityListing, Fixnum, Hash)>] SubjectDivisionGrantsEntityListing data, response status code and response headers
450
+ def get_authorization_role_subjectgrants_with_http_info(role_id, opts = {})
451
+ if @api_client.config.debugging
452
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_role_subjectgrants ..."
453
+ end
454
+
455
+
456
+ # verify the required parameter 'role_id' is set
457
+ fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.get_authorization_role_subjectgrants" if role_id.nil?
458
+
459
+
460
+
461
+
462
+
463
+
464
+
465
+
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
+ # resource path
500
+ local_var_path = "/api/v2/authorization/roles/{roleId}/subjectgrants".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s)
501
+
502
+ # query parameters
503
+ query_params = {}
504
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
505
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
506
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
507
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
508
+ query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
509
+ query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
510
+
511
+ # header parameters
512
+ header_params = {}
513
+
514
+ # HTTP header 'Accept' (if needed)
515
+ local_header_accept = ['application/json']
516
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
517
+
518
+ # HTTP header 'Content-Type'
519
+ local_header_content_type = ['application/json']
520
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
521
+
522
+ # form parameters
523
+ form_params = {}
524
+
525
+ # http body (model)
526
+ post_body = nil
527
+
528
+ auth_names = ['PureCloud Auth']
529
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
530
+ :header_params => header_params,
531
+ :query_params => query_params,
532
+ :form_params => form_params,
533
+ :body => post_body,
534
+ :auth_names => auth_names,
535
+ :return_type => 'SubjectDivisionGrantsEntityListing')
536
+ if @api_client.config.debugging
537
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_role_subjectgrants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
538
+ end
539
+ return data, status_code, headers
540
+ end
541
+
423
542
  # Retrieve a list of all roles defined for the organization
424
543
  #
425
544
  # @param [Hash] opts the optional parameters