purecloudplatformclientv2 49.0.1 → 50.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 (39) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/AnalyticsEvaluation.md +1 -0
  4. data/docs/ArchitectApi.md +16 -16
  5. data/docs/ArrayNode.md +5 -5
  6. data/docs/AuthorizationApi.md +67 -0
  7. data/docs/DomainOrganizationRole.md +1 -1
  8. data/docs/DomainOrganizationRoleCreate.md +1 -1
  9. data/docs/DomainOrganizationRoleUpdate.md +1 -1
  10. data/docs/GroupsApi.md +3 -0
  11. data/docs/IntegrationsApi.md +41 -37
  12. data/docs/QualityAudit.md +1 -1
  13. data/docs/RoutingApi.md +8 -2
  14. data/docs/TimeZone.md +2 -2
  15. data/docs/UsersApi.md +4 -2
  16. data/docs/ViewFilter.md +6 -0
  17. data/lib/purecloudplatformclientv2/api/architect_api.rb +6 -6
  18. data/lib/purecloudplatformclientv2/api/authorization_api.rb +64 -0
  19. data/lib/purecloudplatformclientv2/api/integrations_api.rb +92 -62
  20. data/lib/purecloudplatformclientv2/api/routing_api.rb +18 -0
  21. data/lib/purecloudplatformclientv2/api/users_api.rb +11 -2
  22. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  23. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +27 -1
  24. data/lib/purecloudplatformclientv2/models/analytics_flow.rb +2 -2
  25. data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +2 -2
  26. data/lib/purecloudplatformclientv2/models/array_node.rb +70 -70
  27. data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
  28. data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
  29. data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
  30. data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
  31. data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
  32. data/lib/purecloudplatformclientv2/models/flow.rb +2 -2
  33. data/lib/purecloudplatformclientv2/models/flow_division_view.rb +2 -2
  34. data/lib/purecloudplatformclientv2/models/quality_audit.rb +14 -14
  35. data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -24
  36. data/lib/purecloudplatformclientv2/models/view_filter.rb +166 -4
  37. data/lib/purecloudplatformclientv2/models/voicemail.rb +2 -2
  38. data/lib/purecloudplatformclientv2/version.rb +1 -1
  39. metadata +2 -2
@@ -10,9 +10,9 @@ title: QualityAudit
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
12
  | **user** | [**User**](User.html) | | [optional] |
13
- | **timestamp** | **String** | | [optional] |
14
13
  | **level** | **String** | | [optional] |
15
14
  | **entity** | [**AuditEntity**](AuditEntity.html) | | [optional] |
15
+ | **timestamp** | **String** | | [optional] |
16
16
  | **action** | **String** | | [optional] |
17
17
  | **status** | **String** | | [optional] |
18
18
  | **changes** | [**Array<Change>**](Change.html) | | [optional] |
@@ -1617,7 +1617,7 @@ Name | Type | Description | Notes
1617
1617
 
1618
1618
  <a name="get_routing_queue_wrapupcodes"></a>
1619
1619
 
1620
- ## [**WrapupCodeEntityListing**](WrapupCodeEntityListing.html) get_routing_queue_wrapupcodes(queue_id)
1620
+ ## [**WrapupCodeEntityListing**](WrapupCodeEntityListing.html) get_routing_queue_wrapupcodes(queue_id, opts)
1621
1621
 
1622
1622
 
1623
1623
 
@@ -1651,10 +1651,14 @@ api_instance = PureCloud::RoutingApi.new
1651
1651
 
1652
1652
  queue_id = "queue_id_example" # String | Queue ID
1653
1653
 
1654
+ opts = {
1655
+ page_size: 25, # Integer | Page size
1656
+ page_number: 1 # Integer | Page number
1657
+ }
1654
1658
 
1655
1659
  begin
1656
1660
  #Get the wrap-up codes for a queue
1657
- result = api_instance.get_routing_queue_wrapupcodes(queue_id)
1661
+ result = api_instance.get_routing_queue_wrapupcodes(queue_id, opts)
1658
1662
  p result
1659
1663
  rescue PureCloud::ApiError => e
1660
1664
  puts "Exception when calling RoutingApi->get_routing_queue_wrapupcodes: #{e}"
@@ -1666,6 +1670,8 @@ end
1666
1670
  Name | Type | Description | Notes
1667
1671
  ------------- | ------------- | ------------- | -------------
1668
1672
  **queue_id** | **String**| Queue ID | |
1673
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
1674
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
1669
1675
  {: class="table table-striped"}
1670
1676
 
1671
1677
 
@@ -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] |
10
12
  | **dstsavings** | **Integer** | | [optional] |
11
13
  | **raw_offset** | **Integer** | | [optional] |
12
- | **id** | **String** | | [optional] |
13
- | **display_name** | **String** | | [optional] |
14
14
  {: class="table table-striped"}
15
15
 
16
16
 
@@ -2136,7 +2136,8 @@ api_instance = PureCloud::UsersApi.new
2136
2136
  opts = {
2137
2137
  page_size: 25, # Integer | Page size
2138
2138
  page_number: 1, # Integer | Page number
2139
- id: ["id_example"], # Array<String> | id
2139
+ id: ["id_example"], # Array<String> | A list of user IDs to fetch by bulk
2140
+ jabber_id: ["jabber_id_example"], # Array<String> | A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter)
2140
2141
  sort_order: "ASC", # String | Ascending or descending sort order
2141
2142
  expand: ["expand_example"], # Array<String> | Which fields, if any, to expand
2142
2143
  state: "active" # String | Only list users of this state
@@ -2157,7 +2158,8 @@ Name | Type | Description | Notes
2157
2158
  ------------- | ------------- | ------------- | -------------
2158
2159
  **page_size** | **Integer**| Page size | [optional] [default to 25] |
2159
2160
  **page_number** | **Integer**| Page number | [optional] [default to 1] |
2160
- **id** | [**Array&lt;String&gt;**](String.html)| id | [optional] |
2161
+ **id** | [**Array&lt;String&gt;**](String.html)| A list of user IDs to fetch by bulk | [optional] |
2162
+ **jabber_id** | [**Array&lt;String&gt;**](String.html)| A list of jabberIds to fetch by bulk (cannot be used with the \&quot;id\&quot; parameter) | [optional] |
2161
2163
  **sort_order** | **String**| Ascending or descending sort order | [optional] [default to ASC]<br />**Values**: ascending, descending |
2162
2164
  **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, languagePreference |
2163
2165
  **state** | **String**| Only list users of this state | [optional] [default to active]<br />**Values**: active, inactive, deleted |
@@ -14,8 +14,10 @@ title: ViewFilter
14
14
  | **language_ids** | **Array&lt;String&gt;** | The language ids are used to filter the view | [optional] |
15
15
  | **language_groups** | **Array&lt;String&gt;** | The language groups used to filter the view | [optional] |
16
16
  | **directions** | **Array&lt;String&gt;** | The directions are used to filter the view | [optional] |
17
+ | **originating_directions** | **Array&lt;String&gt;** | The list of orginating directions used to filter the view | [optional] |
17
18
  | **wrap_up_codes** | **Array&lt;String&gt;** | The wrap up codes are used to filter the view | [optional] |
18
19
  | **dnis_list** | **Array&lt;String&gt;** | The dnis list is used to filter the view | [optional] |
20
+ | **session_dnis_list** | **Array&lt;String&gt;** | The list of session dnis used to filter the view | [optional] |
19
21
  | **filter_queues_by_user_ids** | **Array&lt;String&gt;** | The user ids are used to fetch associated queues for the view | [optional] |
20
22
  | **filter_users_by_queue_ids** | **Array&lt;String&gt;** | The queue ids are used to fetch associated users for the view | [optional] |
21
23
  | **user_ids** | **Array&lt;String&gt;** | The user ids are used to filter the view | [optional] |
@@ -70,7 +72,11 @@ title: ViewFilter
70
72
  | **flow_types** | **Array&lt;String&gt;** | A list of types of the flow | [optional] |
71
73
  | **flow_entry_types** | **Array&lt;String&gt;** | A list of types of the flow entry | [optional] |
72
74
  | **flow_entry_reasons** | **Array&lt;String&gt;** | A list of reasons of flow entry | [optional] |
75
+ | **flow_versions** | **Array&lt;String&gt;** | A list of versions of a flow | [optional] |
73
76
  | **group_ids** | **Array&lt;String&gt;** | A list of directory group ids | [optional] |
77
+ | **has_journey_customer_id** | **BOOLEAN** | Indicates filtering for journey customer id | [optional] |
78
+ | **has_journey_action_map_id** | **BOOLEAN** | Indicates filtering for Journey action map id | [optional] |
79
+ | **has_journey_visit_id** | **BOOLEAN** | Indicates filtering for Journey visit id | [optional] |
74
80
  {: class="table table-striped"}
75
81
 
76
82
 
@@ -1075,8 +1075,8 @@ module PureCloud
1075
1075
  fail ArgumentError, "Missing the required parameter 'object_type' when calling ArchitectApi.get_architect_dependencytracking_consumedresources" if object_type.nil?
1076
1076
 
1077
1077
  # verify enum value
1078
- unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'DATATABLE', 'EMAILROUTE', 'EMERGENCYGROUP', 'FLOWOUTCOME', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RECORDINGPOLICY', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'TTSENGINE', 'TTSVOICE', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(object_type)
1079
- fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, VOICEXML, WORKFLOW"
1078
+ unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'DATATABLE', 'EMAILROUTE', 'EMERGENCYGROUP', 'FLOWOUTCOME', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDCHATFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RECORDINGPOLICY', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'TTSENGINE', 'TTSVOICE', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(object_type)
1079
+ fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, VOICEXML, WORKFLOW"
1080
1080
  end
1081
1081
 
1082
1082
 
@@ -1167,8 +1167,8 @@ module PureCloud
1167
1167
  fail ArgumentError, "Missing the required parameter 'object_type' when calling ArchitectApi.get_architect_dependencytracking_consumingresources" if object_type.nil?
1168
1168
 
1169
1169
  # verify enum value
1170
- unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'DATATABLE', 'EMAILROUTE', 'EMERGENCYGROUP', 'FLOWOUTCOME', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RECORDINGPOLICY', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'TTSENGINE', 'TTSVOICE', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(object_type)
1171
- fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, VOICEXML, WORKFLOW"
1170
+ unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'DATATABLE', 'EMAILROUTE', 'EMERGENCYGROUP', 'FLOWOUTCOME', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDCHATFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RECORDINGPOLICY', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'TTSENGINE', 'TTSVOICE', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(object_type)
1171
+ fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, VOICEXML, WORKFLOW"
1172
1172
  end
1173
1173
 
1174
1174
 
@@ -1392,8 +1392,8 @@ module PureCloud
1392
1392
 
1393
1393
 
1394
1394
 
1395
- if opts[:'object_type'] && !['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'DATATABLE', 'EMAILROUTE', 'EMERGENCYGROUP', 'FLOWOUTCOME', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RECORDINGPOLICY', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'TTSENGINE', 'TTSVOICE', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(opts[:'object_type'])
1396
- fail ArgumentError, 'invalid value for "object_type", must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, VOICEXML, WORKFLOW'
1395
+ if opts[:'object_type'] && !['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'DATATABLE', 'EMAILROUTE', 'EMERGENCYGROUP', 'FLOWOUTCOME', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDCHATFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RECORDINGPOLICY', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'TTSENGINE', 'TTSVOICE', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(opts[:'object_type'])
1396
+ fail ArgumentError, 'invalid value for "object_type", must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, VOICEXML, WORKFLOW'
1397
1397
  end
1398
1398
 
1399
1399
 
@@ -1524,6 +1524,70 @@ module PureCloud
1524
1524
  return data, status_code, headers
1525
1525
  end
1526
1526
 
1527
+ # Get the count of roles granted to a list of subjects
1528
+ #
1529
+ # @param [Hash] opts the optional parameters
1530
+ # @option opts [Array<String>] :id id
1531
+ # @return [Hash<String, Object>]
1532
+ def get_authorization_subjects_rolecounts(opts = {})
1533
+ data, _status_code, _headers = get_authorization_subjects_rolecounts_with_http_info(opts)
1534
+ return data
1535
+ end
1536
+
1537
+ # Get the count of roles granted to a list of subjects
1538
+ #
1539
+ # @param [Hash] opts the optional parameters
1540
+ # @option opts [Array<String>] :id id
1541
+ # @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers
1542
+ def get_authorization_subjects_rolecounts_with_http_info(opts = {})
1543
+ if @api_client.config.debugging
1544
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_subjects_rolecounts ..."
1545
+ end
1546
+
1547
+
1548
+
1549
+
1550
+
1551
+
1552
+
1553
+ # resource path
1554
+ local_var_path = "/api/v2/authorization/subjects/rolecounts".sub('{format}','json')
1555
+
1556
+ # query parameters
1557
+ query_params = {}
1558
+ query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
1559
+
1560
+ # header parameters
1561
+ header_params = {}
1562
+
1563
+ # HTTP header 'Accept' (if needed)
1564
+ local_header_accept = ['application/json']
1565
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1566
+
1567
+ # HTTP header 'Content-Type'
1568
+ local_header_content_type = ['application/json']
1569
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1570
+
1571
+ # form parameters
1572
+ form_params = {}
1573
+
1574
+ # http body (model)
1575
+ post_body = nil
1576
+
1577
+ auth_names = ['PureCloud OAuth']
1578
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1579
+ :header_params => header_params,
1580
+ :query_params => query_params,
1581
+ :form_params => form_params,
1582
+ :body => post_body,
1583
+ :auth_names => auth_names,
1584
+ :return_type => 'Hash<String, Object>')
1585
+ if @api_client.config.debugging
1586
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_subjects_rolecounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1587
+ end
1588
+ return data, status_code, headers
1589
+ end
1590
+
1527
1591
  # Returns a listing of roles and permissions for a user.
1528
1592
  #
1529
1593
  # @param user_id User ID
@@ -578,8 +578,8 @@ module PureCloud
578
578
  #
579
579
  # @param action_id actionId
580
580
  # @param [Hash] opts the optional parameters
581
- # @option opts [String] :expand Indicates fields of the response which should be expanded.
582
- # @option opts [BOOLEAN] :include_config Show config when available (default to false)
581
+ # @option opts [String] :expand Indicates a field in the response which should be expanded.
582
+ # @option opts [BOOLEAN] :include_config Return config in response. (default to false)
583
583
  # @return [Action]
584
584
  def get_integrations_action(action_id, opts = {})
585
585
  data, _status_code, _headers = get_integrations_action_with_http_info(action_id, opts)
@@ -590,8 +590,8 @@ module PureCloud
590
590
  #
591
591
  # @param action_id actionId
592
592
  # @param [Hash] opts the optional parameters
593
- # @option opts [String] :expand Indicates fields of the response which should be expanded.
594
- # @option opts [BOOLEAN] :include_config Show config when available
593
+ # @option opts [String] :expand Indicates a field in the response which should be expanded.
594
+ # @option opts [BOOLEAN] :include_config Return config in response.
595
595
  # @return [Array<(Action, Fixnum, Hash)>] Action data, response status code and response headers
596
596
  def get_integrations_action_with_http_info(action_id, opts = {})
597
597
  if @api_client.config.debugging
@@ -665,8 +665,8 @@ module PureCloud
665
665
  #
666
666
  # @param action_id actionId
667
667
  # @param [Hash] opts the optional parameters
668
- # @option opts [String] :expand Indicates fields of the response which should be expanded.
669
- # @option opts [BOOLEAN] :include_config Show config when available (default to false)
668
+ # @option opts [String] :expand Indicates a field in the response which should be expanded.
669
+ # @option opts [BOOLEAN] :include_config Return config in response. (default to false)
670
670
  # @return [Action]
671
671
  def get_integrations_action_draft(action_id, opts = {})
672
672
  data, _status_code, _headers = get_integrations_action_draft_with_http_info(action_id, opts)
@@ -677,8 +677,8 @@ module PureCloud
677
677
  #
678
678
  # @param action_id actionId
679
679
  # @param [Hash] opts the optional parameters
680
- # @option opts [String] :expand Indicates fields of the response which should be expanded.
681
- # @option opts [BOOLEAN] :include_config Show config when available
680
+ # @option opts [String] :expand Indicates a field in the response which should be expanded.
681
+ # @option opts [BOOLEAN] :include_config Return config in response.
682
682
  # @return [Array<(Action, Fixnum, Hash)>] Action data, response status code and response headers
683
683
  def get_integrations_action_draft_with_http_info(action_id, opts = {})
684
684
  if @api_client.config.debugging
@@ -1116,15 +1116,16 @@ module PureCloud
1116
1116
  # Retrieves all actions associated with filters passed in via query param.
1117
1117
  #
1118
1118
  # @param [Hash] opts the optional parameters
1119
- # @option opts [String] :category Filter by category name
1120
- # @option opts [String] :secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
1121
- # @option opts [String] :include_auth_actions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions.
1122
1119
  # @option opts [Integer] :page_size The total page size requested (default to 25)
1123
1120
  # @option opts [Integer] :page_number The page number requested (default to 1)
1124
- # @option opts [String] :sort_by variable name requested to sort by
1125
- # @option opts [Array<String>] :expand variable name requested by expand list
1126
1121
  # @option opts [String] :next_page next page token
1127
1122
  # @option opts [String] :previous_page Previous page token
1123
+ # @option opts [String] :sort_by Root level field name to sort on.
1124
+ # @option opts [String] :sort_order Direction to sort &#39;sortBy&#39; field. (default to asc)
1125
+ # @option opts [String] :category Filter by category name
1126
+ # @option opts [String] :name Filter by action name. Provide full or just the first part of name.
1127
+ # @option opts [String] :secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
1128
+ # @option opts [String] :include_auth_actions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (default to false)
1128
1129
  # @return [ActionEntityListing]
1129
1130
  def get_integrations_actions(opts = {})
1130
1131
  data, _status_code, _headers = get_integrations_actions_with_http_info(opts)
@@ -1134,15 +1135,16 @@ module PureCloud
1134
1135
  # Retrieves all actions associated with filters passed in via query param.
1135
1136
  #
1136
1137
  # @param [Hash] opts the optional parameters
1137
- # @option opts [String] :category Filter by category name
1138
- # @option opts [String] :secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
1139
- # @option opts [String] :include_auth_actions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions.
1140
1138
  # @option opts [Integer] :page_size The total page size requested
1141
1139
  # @option opts [Integer] :page_number The page number requested
1142
- # @option opts [String] :sort_by variable name requested to sort by
1143
- # @option opts [Array<String>] :expand variable name requested by expand list
1144
1140
  # @option opts [String] :next_page next page token
1145
1141
  # @option opts [String] :previous_page Previous page token
1142
+ # @option opts [String] :sort_by Root level field name to sort on.
1143
+ # @option opts [String] :sort_order Direction to sort &#39;sortBy&#39; field.
1144
+ # @option opts [String] :category Filter by category name
1145
+ # @option opts [String] :name Filter by action name. Provide full or just the first part of name.
1146
+ # @option opts [String] :secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
1147
+ # @option opts [String] :include_auth_actions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions.
1146
1148
  # @return [Array<(ActionEntityListing, Fixnum, Hash)>] ActionEntityListing data, response status code and response headers
1147
1149
  def get_integrations_actions_with_http_info(opts = {})
1148
1150
  if @api_client.config.debugging
@@ -1158,9 +1160,6 @@ module PureCloud
1158
1160
 
1159
1161
 
1160
1162
 
1161
- if opts[:'secure'] && !['true', 'false'].include?(opts[:'secure'])
1162
- fail ArgumentError, 'invalid value for "secure", must be one of true, false'
1163
- end
1164
1163
 
1165
1164
 
1166
1165
 
@@ -1168,9 +1167,6 @@ module PureCloud
1168
1167
 
1169
1168
 
1170
1169
 
1171
- if opts[:'include_auth_actions'] && !['true', 'false'].include?(opts[:'include_auth_actions'])
1172
- fail ArgumentError, 'invalid value for "include_auth_actions", must be one of true, false'
1173
- end
1174
1170
 
1175
1171
 
1176
1172
 
@@ -1185,6 +1181,12 @@ module PureCloud
1185
1181
 
1186
1182
 
1187
1183
 
1184
+
1185
+
1186
+
1187
+ if opts[:'sort_order'] && !['ASC', 'DESC'].include?(opts[:'sort_order'])
1188
+ fail ArgumentError, 'invalid value for "sort_order", must be one of ASC, DESC'
1189
+ end
1188
1190
 
1189
1191
 
1190
1192
 
@@ -1204,6 +1206,9 @@ module PureCloud
1204
1206
 
1205
1207
 
1206
1208
 
1209
+ if opts[:'secure'] && !['true', 'false'].include?(opts[:'secure'])
1210
+ fail ArgumentError, 'invalid value for "secure", must be one of true, false'
1211
+ end
1207
1212
 
1208
1213
 
1209
1214
 
@@ -1211,20 +1216,28 @@ module PureCloud
1211
1216
 
1212
1217
 
1213
1218
 
1219
+ if opts[:'include_auth_actions'] && !['true', 'false'].include?(opts[:'include_auth_actions'])
1220
+ fail ArgumentError, 'invalid value for "include_auth_actions", must be one of true, false'
1221
+ end
1222
+
1223
+
1224
+
1225
+
1214
1226
  # resource path
1215
1227
  local_var_path = "/api/v2/integrations/actions".sub('{format}','json')
1216
1228
 
1217
1229
  # query parameters
1218
1230
  query_params = {}
1219
- query_params[:'category'] = opts[:'category'] if opts[:'category']
1220
- query_params[:'secure'] = opts[:'secure'] if opts[:'secure']
1221
- query_params[:'includeAuthActions'] = opts[:'include_auth_actions'] if opts[:'include_auth_actions']
1222
1231
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1223
1232
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1224
- query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
1225
- query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
1226
1233
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
1227
1234
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
1235
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
1236
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
1237
+ query_params[:'category'] = opts[:'category'] if opts[:'category']
1238
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
1239
+ query_params[:'secure'] = opts[:'secure'] if opts[:'secure']
1240
+ query_params[:'includeAuthActions'] = opts[:'include_auth_actions'] if opts[:'include_auth_actions']
1228
1241
 
1229
1242
  # header parameters
1230
1243
  header_params = {}
@@ -1260,13 +1273,13 @@ module PureCloud
1260
1273
  # Retrieves all categories of available Actions
1261
1274
  #
1262
1275
  # @param [Hash] opts the optional parameters
1263
- # @option opts [String] :secure Filter to only include/exclude Action categories based on if they are considered secure. True will only include categories with Actions marked secured. False will only include categories of unsecured Actions.
1264
1276
  # @option opts [Integer] :page_size The total page size requested (default to 25)
1265
1277
  # @option opts [Integer] :page_number The page number requested (default to 1)
1266
- # @option opts [String] :sort_by variable name requested to sort by
1267
- # @option opts [Array<String>] :expand variable name requested by expand list
1268
1278
  # @option opts [String] :next_page next page token
1269
1279
  # @option opts [String] :previous_page Previous page token
1280
+ # @option opts [String] :sort_by Root level field name to sort on.
1281
+ # @option opts [String] :sort_order Direction to sort &#39;sortBy&#39; field. (default to asc)
1282
+ # @option opts [String] :secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
1270
1283
  # @return [CategoryEntityListing]
1271
1284
  def get_integrations_actions_categories(opts = {})
1272
1285
  data, _status_code, _headers = get_integrations_actions_categories_with_http_info(opts)
@@ -1276,13 +1289,13 @@ module PureCloud
1276
1289
  # Retrieves all categories of available Actions
1277
1290
  #
1278
1291
  # @param [Hash] opts the optional parameters
1279
- # @option opts [String] :secure Filter to only include/exclude Action categories based on if they are considered secure. True will only include categories with Actions marked secured. False will only include categories of unsecured Actions.
1280
1292
  # @option opts [Integer] :page_size The total page size requested
1281
1293
  # @option opts [Integer] :page_number The page number requested
1282
- # @option opts [String] :sort_by variable name requested to sort by
1283
- # @option opts [Array<String>] :expand variable name requested by expand list
1284
1294
  # @option opts [String] :next_page next page token
1285
1295
  # @option opts [String] :previous_page Previous page token
1296
+ # @option opts [String] :sort_by Root level field name to sort on.
1297
+ # @option opts [String] :sort_order Direction to sort &#39;sortBy&#39; field.
1298
+ # @option opts [String] :secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
1286
1299
  # @return [Array<(CategoryEntityListing, Fixnum, Hash)>] CategoryEntityListing data, response status code and response headers
1287
1300
  def get_integrations_actions_categories_with_http_info(opts = {})
1288
1301
  if @api_client.config.debugging
@@ -1292,9 +1305,6 @@ module PureCloud
1292
1305
 
1293
1306
 
1294
1307
 
1295
- if opts[:'secure'] && !['true', 'false'].include?(opts[:'secure'])
1296
- fail ArgumentError, 'invalid value for "secure", must be one of true, false'
1297
- end
1298
1308
 
1299
1309
 
1300
1310
 
@@ -1324,6 +1334,10 @@ module PureCloud
1324
1334
 
1325
1335
 
1326
1336
 
1337
+
1338
+ if opts[:'sort_order'] && !['ASC', 'DESC'].include?(opts[:'sort_order'])
1339
+ fail ArgumentError, 'invalid value for "sort_order", must be one of ASC, DESC'
1340
+ end
1327
1341
 
1328
1342
 
1329
1343
 
@@ -1331,6 +1345,9 @@ module PureCloud
1331
1345
 
1332
1346
 
1333
1347
 
1348
+ if opts[:'secure'] && !['true', 'false'].include?(opts[:'secure'])
1349
+ fail ArgumentError, 'invalid value for "secure", must be one of true, false'
1350
+ end
1334
1351
 
1335
1352
 
1336
1353
 
@@ -1340,13 +1357,13 @@ module PureCloud
1340
1357
 
1341
1358
  # query parameters
1342
1359
  query_params = {}
1343
- query_params[:'secure'] = opts[:'secure'] if opts[:'secure']
1344
1360
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1345
1361
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1346
- query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
1347
- query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
1348
1362
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
1349
1363
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
1364
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
1365
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
1366
+ query_params[:'secure'] = opts[:'secure'] if opts[:'secure']
1350
1367
 
1351
1368
  # header parameters
1352
1369
  header_params = {}
@@ -1382,15 +1399,16 @@ module PureCloud
1382
1399
  # Retrieves all action drafts associated with the filters passed in via query param.
1383
1400
  #
1384
1401
  # @param [Hash] opts the optional parameters
1385
- # @option opts [String] :category Filter by category name
1386
- # @option opts [String] :secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
1387
- # @option opts [String] :include_auth_actions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions.
1388
1402
  # @option opts [Integer] :page_size The total page size requested (default to 25)
1389
1403
  # @option opts [Integer] :page_number The page number requested (default to 1)
1390
- # @option opts [String] :sort_by variable name requested to sort by
1391
- # @option opts [Array<String>] :expand variable name requested by expand list
1392
1404
  # @option opts [String] :next_page next page token
1393
1405
  # @option opts [String] :previous_page Previous page token
1406
+ # @option opts [String] :sort_by Root level field name to sort on.
1407
+ # @option opts [String] :sort_order Direction to sort &#39;sortBy&#39; field. (default to asc)
1408
+ # @option opts [String] :category Filter by category name
1409
+ # @option opts [String] :name Filter by action name. Provide full or just the first part of name.
1410
+ # @option opts [String] :secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
1411
+ # @option opts [String] :include_auth_actions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (default to false)
1394
1412
  # @return [ActionEntityListing]
1395
1413
  def get_integrations_actions_drafts(opts = {})
1396
1414
  data, _status_code, _headers = get_integrations_actions_drafts_with_http_info(opts)
@@ -1400,15 +1418,16 @@ module PureCloud
1400
1418
  # Retrieves all action drafts associated with the filters passed in via query param.
1401
1419
  #
1402
1420
  # @param [Hash] opts the optional parameters
1403
- # @option opts [String] :category Filter by category name
1404
- # @option opts [String] :secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
1405
- # @option opts [String] :include_auth_actions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions.
1406
1421
  # @option opts [Integer] :page_size The total page size requested
1407
1422
  # @option opts [Integer] :page_number The page number requested
1408
- # @option opts [String] :sort_by variable name requested to sort by
1409
- # @option opts [Array<String>] :expand variable name requested by expand list
1410
1423
  # @option opts [String] :next_page next page token
1411
1424
  # @option opts [String] :previous_page Previous page token
1425
+ # @option opts [String] :sort_by Root level field name to sort on.
1426
+ # @option opts [String] :sort_order Direction to sort &#39;sortBy&#39; field.
1427
+ # @option opts [String] :category Filter by category name
1428
+ # @option opts [String] :name Filter by action name. Provide full or just the first part of name.
1429
+ # @option opts [String] :secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
1430
+ # @option opts [String] :include_auth_actions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions.
1412
1431
  # @return [Array<(ActionEntityListing, Fixnum, Hash)>] ActionEntityListing data, response status code and response headers
1413
1432
  def get_integrations_actions_drafts_with_http_info(opts = {})
1414
1433
  if @api_client.config.debugging
@@ -1424,9 +1443,6 @@ module PureCloud
1424
1443
 
1425
1444
 
1426
1445
 
1427
- if opts[:'secure'] && !['true', 'false'].include?(opts[:'secure'])
1428
- fail ArgumentError, 'invalid value for "secure", must be one of true, false'
1429
- end
1430
1446
 
1431
1447
 
1432
1448
 
@@ -1434,9 +1450,6 @@ module PureCloud
1434
1450
 
1435
1451
 
1436
1452
 
1437
- if opts[:'include_auth_actions'] && !['true', 'false'].include?(opts[:'include_auth_actions'])
1438
- fail ArgumentError, 'invalid value for "include_auth_actions", must be one of true, false'
1439
- end
1440
1453
 
1441
1454
 
1442
1455
 
@@ -1450,6 +1463,13 @@ module PureCloud
1450
1463
 
1451
1464
 
1452
1465
 
1466
+
1467
+
1468
+
1469
+
1470
+ if opts[:'sort_order'] && !['ASC', 'DESC'].include?(opts[:'sort_order'])
1471
+ fail ArgumentError, 'invalid value for "sort_order", must be one of ASC, DESC'
1472
+ end
1453
1473
 
1454
1474
 
1455
1475
 
@@ -1469,6 +1489,9 @@ module PureCloud
1469
1489
 
1470
1490
 
1471
1491
 
1492
+ if opts[:'secure'] && !['true', 'false'].include?(opts[:'secure'])
1493
+ fail ArgumentError, 'invalid value for "secure", must be one of true, false'
1494
+ end
1472
1495
 
1473
1496
 
1474
1497
 
@@ -1476,21 +1499,28 @@ module PureCloud
1476
1499
 
1477
1500
 
1478
1501
 
1502
+ if opts[:'include_auth_actions'] && !['true', 'false'].include?(opts[:'include_auth_actions'])
1503
+ fail ArgumentError, 'invalid value for "include_auth_actions", must be one of true, false'
1504
+ end
1505
+
1506
+
1507
+
1479
1508
 
1480
1509
  # resource path
1481
1510
  local_var_path = "/api/v2/integrations/actions/drafts".sub('{format}','json')
1482
1511
 
1483
1512
  # query parameters
1484
1513
  query_params = {}
1485
- query_params[:'category'] = opts[:'category'] if opts[:'category']
1486
- query_params[:'secure'] = opts[:'secure'] if opts[:'secure']
1487
- query_params[:'includeAuthActions'] = opts[:'include_auth_actions'] if opts[:'include_auth_actions']
1488
1514
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1489
1515
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1490
- query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
1491
- query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
1492
1516
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
1493
1517
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
1518
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
1519
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
1520
+ query_params[:'category'] = opts[:'category'] if opts[:'category']
1521
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
1522
+ query_params[:'secure'] = opts[:'secure'] if opts[:'secure']
1523
+ query_params[:'includeAuthActions'] = opts[:'include_auth_actions'] if opts[:'include_auth_actions']
1494
1524
 
1495
1525
  # header parameters
1496
1526
  header_params = {}