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.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/AnalyticsEvaluation.md +1 -0
- data/docs/ArchitectApi.md +16 -16
- data/docs/ArrayNode.md +5 -5
- data/docs/AuthorizationApi.md +67 -0
- data/docs/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/GroupsApi.md +3 -0
- data/docs/IntegrationsApi.md +41 -37
- data/docs/QualityAudit.md +1 -1
- data/docs/RoutingApi.md +8 -2
- data/docs/TimeZone.md +2 -2
- data/docs/UsersApi.md +4 -2
- data/docs/ViewFilter.md +6 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +64 -0
- data/lib/purecloudplatformclientv2/api/integrations_api.rb +92 -62
- data/lib/purecloudplatformclientv2/api/routing_api.rb +18 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +11 -2
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +27 -1
- data/lib/purecloudplatformclientv2/models/analytics_flow.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/array_node.rb +70 -70
- data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_division_view.rb +2 -2
- data/lib/purecloudplatformclientv2/models/quality_audit.rb +14 -14
- data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -24
- data/lib/purecloudplatformclientv2/models/view_filter.rb +166 -4
- data/lib/purecloudplatformclientv2/models/voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 503374f257e2d6fbe2e728ef149fa056be682322
|
4
|
+
data.tar.gz: 791e1d1a13cfe64d9f4e7e4379ed109d8fe0acbd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f2d77c669f50cc939d352c60936109376ea11eb72e902783cdc973a4db960fbf5931bec2537ecc00d36cfef79886382ef24c4eab725af68b5f0af1213710dff5
|
7
|
+
data.tar.gz: ae4ecfaa255b64b10431aa4e59d3bd344325466e1546b0e22596ed6793609019a621dcfd026975c6abb06f61298aaff6bd44ae95dee8798b2a6f4dc17fd99299
|
data/README.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
title: PureCloud Ruby Gem
|
3
3
|
---
|
4
|
-

|
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
|
```{"language":"ruby"}
|
13
|
-
gem install 'purecloudplatformclientv2', '~>
|
13
|
+
gem install 'purecloudplatformclientv2', '~> 50.0.0'
|
14
14
|
```
|
15
15
|
|
16
16
|
### Install from Git
|
data/docs/AnalyticsEvaluation.md
CHANGED
@@ -15,6 +15,7 @@ title: AnalyticsEvaluation
|
|
15
15
|
| **form_id** | **String** | Unique identifier for the form used to evaluate the conversation/agent | [optional] |
|
16
16
|
| **context_id** | **String** | A unique identifier for an evaluation form, regardless of version | [optional] |
|
17
17
|
| **form_name** | **String** | Name of the evaluation form | [optional] |
|
18
|
+
| **calibration_id** | **String** | The calibration id used for the purpose of training evaluators | [optional] |
|
18
19
|
| **o_total_score** | **Integer** | | [optional] |
|
19
20
|
| **o_total_critical_score** | **Integer** | | [optional] |
|
20
21
|
{: class="table table-striped"}
|
data/docs/ArchitectApi.md
CHANGED
@@ -940,11 +940,11 @@ Name | Type | Description | Notes
|
|
940
940
|
**name** | **String**| Object name to search for | |
|
941
941
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
942
942
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
943
|
-
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: 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 |
|
943
|
+
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: 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 |
|
944
944
|
**consumed_resources** | **BOOLEAN**| Include resources each result item consumes | [optional] |
|
945
945
|
**consuming_resources** | **BOOLEAN**| Include resources that consume each result item | [optional] |
|
946
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: 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 |
|
947
|
-
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: 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 |
|
946
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: 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 |
|
947
|
+
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: 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 |
|
948
948
|
{: class="table table-striped"}
|
949
949
|
|
950
950
|
|
@@ -1077,8 +1077,8 @@ Name | Type | Description | Notes
|
|
1077
1077
|
------------- | ------------- | ------------- | -------------
|
1078
1078
|
**id** | **String**| Consuming object ID | |
|
1079
1079
|
**version** | **String**| Consuming object version | |
|
1080
|
-
**object_type** | **String**| Consuming object type. Only versioned types are allowed here. | <br />**Values**: 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 |
|
1081
|
-
**resource_type** | [**Array<String>**](String.html)| Types of consumed resources to show | [optional] <br />**Values**: 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 |
|
1080
|
+
**object_type** | **String**| Consuming object type. Only versioned types are allowed here. | <br />**Values**: 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 |
|
1081
|
+
**resource_type** | [**Array<String>**](String.html)| Types of consumed resources to show | [optional] <br />**Values**: 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 |
|
1082
1082
|
{: class="table table-striped"}
|
1083
1083
|
|
1084
1084
|
|
@@ -1149,8 +1149,8 @@ end
|
|
1149
1149
|
Name | Type | Description | Notes
|
1150
1150
|
------------- | ------------- | ------------- | -------------
|
1151
1151
|
**id** | **String**| Consumed object ID | |
|
1152
|
-
**object_type** | **String**| Consumed object type | <br />**Values**: 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 |
|
1153
|
-
**resource_type** | [**Array<String>**](String.html)| Types of consuming resources to show. Only versioned types are allowed here. | [optional] <br />**Values**: 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 |
|
1152
|
+
**object_type** | **String**| Consumed object type | <br />**Values**: 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 |
|
1153
|
+
**resource_type** | [**Array<String>**](String.html)| Types of consuming resources to show. Only versioned types are allowed here. | [optional] <br />**Values**: 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 |
|
1154
1154
|
{: class="table table-striped"}
|
1155
1155
|
|
1156
1156
|
|
@@ -1223,10 +1223,10 @@ end
|
|
1223
1223
|
Name | Type | Description | Notes
|
1224
1224
|
------------- | ------------- | ------------- | -------------
|
1225
1225
|
**name** | **String**| Name to search for | [optional] |
|
1226
|
-
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: 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 |
|
1226
|
+
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: 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 |
|
1227
1227
|
**flow_filter** | **String**| Show only checkedIn or published flows | [optional] <br />**Values**: checkedIn, published |
|
1228
1228
|
**consumed_resources** | **BOOLEAN**| Return consumed resources? | [optional] [default to false] |
|
1229
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: 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 |
|
1229
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: 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 |
|
1230
1230
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1231
1231
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
1232
1232
|
{: class="table table-striped"}
|
@@ -1303,11 +1303,11 @@ Name | Type | Description | Notes
|
|
1303
1303
|
------------- | ------------- | ------------- | -------------
|
1304
1304
|
**id** | **String**| Object ID | |
|
1305
1305
|
**version** | **String**| Object version | [optional] |
|
1306
|
-
**object_type** | **String**| Object type | [optional] <br />**Values**: 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 |
|
1306
|
+
**object_type** | **String**| Object type | [optional] <br />**Values**: 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 |
|
1307
1307
|
**consumed_resources** | **BOOLEAN**| Include resources this item consumes | [optional] |
|
1308
1308
|
**consuming_resources** | **BOOLEAN**| Include resources that consume this item | [optional] |
|
1309
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: 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 |
|
1310
|
-
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: 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 |
|
1309
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: 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 |
|
1310
|
+
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: 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 |
|
1311
1311
|
{: class="table table-striped"}
|
1312
1312
|
|
1313
1313
|
|
@@ -1512,9 +1512,9 @@ end
|
|
1512
1512
|
Name | Type | Description | Notes
|
1513
1513
|
------------- | ------------- | ------------- | -------------
|
1514
1514
|
**name** | **String**| Name to search for | [optional] |
|
1515
|
-
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: 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 |
|
1515
|
+
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: 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 |
|
1516
1516
|
**consumed_resources** | **BOOLEAN**| Return consumed resources? | [optional] [default to false] |
|
1517
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: 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 |
|
1517
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: 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 |
|
1518
1518
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1519
1519
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
1520
1520
|
{: class="table table-striped"}
|
@@ -3318,7 +3318,7 @@ end
|
|
3318
3318
|
|
3319
3319
|
Name | Type | Description | Notes
|
3320
3320
|
------------- | ------------- | ------------- | -------------
|
3321
|
-
**type** | [**Array<String>**](String.html)| Type | [optional] <br />**Values**: inboundcall, inboundemail, inboundshortmessage, outboundcall, inqueuecall, speech, securecall, surveyinvite, workflow |
|
3321
|
+
**type** | [**Array<String>**](String.html)| Type | [optional] <br />**Values**: inboundcall, inboundchat, inboundemail, inboundshortmessage, outboundcall, inqueuecall, speech, securecall, surveyinvite, workflow |
|
3322
3322
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
3323
3323
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
3324
3324
|
**sort_by** | **String**| Sort by | [optional] [default to id] |
|
@@ -3699,7 +3699,7 @@ end
|
|
3699
3699
|
|
3700
3700
|
Name | Type | Description | Notes
|
3701
3701
|
------------- | ------------- | ------------- | -------------
|
3702
|
-
**type** | [**Array<String>**](String.html)| Type | [optional] <br />**Values**: inboundcall, inboundemail, inboundshortmessage, outboundcall, inqueuecall, speech, securecall, surveyinvite, workflow |
|
3702
|
+
**type** | [**Array<String>**](String.html)| Type | [optional] <br />**Values**: inboundcall, inboundchat, inboundemail, inboundshortmessage, outboundcall, inqueuecall, speech, securecall, surveyinvite, workflow |
|
3703
3703
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
3704
3704
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
3705
3705
|
**sort_by** | **String**| Sort by | [optional] [default to id] |
|
data/docs/ArrayNode.md
CHANGED
@@ -8,15 +8,11 @@ title: ArrayNode
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **node_type** | **String** | | [optional] |
|
11
|
-
| **object** | **BOOLEAN** | | [optional] |
|
12
11
|
| **boolean** | **BOOLEAN** | | [optional] |
|
13
12
|
| **number** | **BOOLEAN** | | [optional] |
|
14
13
|
| **float** | **BOOLEAN** | | [optional] |
|
14
|
+
| **object** | **BOOLEAN** | | [optional] |
|
15
15
|
| **floating_point_number** | **BOOLEAN** | | [optional] |
|
16
|
-
| **value_node** | **BOOLEAN** | | [optional] |
|
17
|
-
| **container_node** | **BOOLEAN** | | [optional] |
|
18
|
-
| **missing_node** | **BOOLEAN** | | [optional] |
|
19
|
-
| **pojo** | **BOOLEAN** | | [optional] |
|
20
16
|
| **integral_number** | **BOOLEAN** | | [optional] |
|
21
17
|
| **short** | **BOOLEAN** | | [optional] |
|
22
18
|
| **int** | **BOOLEAN** | | [optional] |
|
@@ -26,6 +22,10 @@ title: ArrayNode
|
|
26
22
|
| **big_integer** | **BOOLEAN** | | [optional] |
|
27
23
|
| **textual** | **BOOLEAN** | | [optional] |
|
28
24
|
| **binary** | **BOOLEAN** | | [optional] |
|
25
|
+
| **value_node** | **BOOLEAN** | | [optional] |
|
26
|
+
| **container_node** | **BOOLEAN** | | [optional] |
|
27
|
+
| **missing_node** | **BOOLEAN** | | [optional] |
|
28
|
+
| **pojo** | **BOOLEAN** | | [optional] |
|
29
29
|
| **array** | **BOOLEAN** | | [optional] |
|
30
30
|
| **null** | **BOOLEAN** | | [optional] |
|
31
31
|
{: class="table table-striped"}
|
data/docs/AuthorizationApi.md
CHANGED
@@ -27,6 +27,7 @@ Method | Description
|
|
27
27
|
[**get_authorization_roles**](AuthorizationApi.html#get_authorization_roles) | Retrieve a list of all roles defined for the organization
|
28
28
|
[**get_authorization_subject**](AuthorizationApi.html#get_authorization_subject) | Returns a listing of roles and permissions for a user.
|
29
29
|
[**get_authorization_subjects_me**](AuthorizationApi.html#get_authorization_subjects_me) | Returns a listing of roles and permissions for the currently authenticated user.
|
30
|
+
[**get_authorization_subjects_rolecounts**](AuthorizationApi.html#get_authorization_subjects_rolecounts) | Get the count of roles granted to a list of subjects
|
30
31
|
[**get_user_roles**](AuthorizationApi.html#get_user_roles) | Returns a listing of roles and permissions for a user.
|
31
32
|
[**patch_authorization_role**](AuthorizationApi.html#patch_authorization_role) | Patch Organization Role for needsUpdate Field
|
32
33
|
[**post_authorization_division_object**](AuthorizationApi.html#post_authorization_division_object) | Assign a list of objects to a division
|
@@ -1330,6 +1331,72 @@ This endpoint does not need any parameter.
|
|
1330
1331
|
|
1331
1332
|
|
1332
1333
|
|
1334
|
+
<a name="get_authorization_subjects_rolecounts"></a>
|
1335
|
+
|
1336
|
+
## Hash<String, Object>** get_authorization_subjects_rolecounts(opts)
|
1337
|
+
|
1338
|
+
|
1339
|
+
|
1340
|
+
Get the count of roles granted to a list of subjects
|
1341
|
+
|
1342
|
+
|
1343
|
+
|
1344
|
+
Wraps GET /api/v2/authorization/subjects/rolecounts
|
1345
|
+
|
1346
|
+
Requires ANY permissions:
|
1347
|
+
|
1348
|
+
* authorization:grant:view
|
1349
|
+
|
1350
|
+
|
1351
|
+
### Example
|
1352
|
+
```{"language":"ruby"}
|
1353
|
+
# load the gem
|
1354
|
+
require 'purecloudplatformclientv2'
|
1355
|
+
# setup authorization
|
1356
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1357
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1358
|
+
environment = "mypurecloud.com"
|
1359
|
+
|
1360
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1361
|
+
|
1362
|
+
PureCloud.configure do |config|
|
1363
|
+
config.access_token = @authToken
|
1364
|
+
end
|
1365
|
+
|
1366
|
+
api_instance = PureCloud::AuthorizationApi.new
|
1367
|
+
|
1368
|
+
opts = {
|
1369
|
+
id: ["id_example"] # Array<String> | id
|
1370
|
+
}
|
1371
|
+
|
1372
|
+
begin
|
1373
|
+
#Get the count of roles granted to a list of subjects
|
1374
|
+
result = api_instance.get_authorization_subjects_rolecounts(opts)
|
1375
|
+
p result
|
1376
|
+
rescue PureCloud::ApiError => e
|
1377
|
+
puts "Exception when calling AuthorizationApi->get_authorization_subjects_rolecounts: #{e}"
|
1378
|
+
end
|
1379
|
+
```
|
1380
|
+
|
1381
|
+
### Parameters
|
1382
|
+
|
1383
|
+
Name | Type | Description | Notes
|
1384
|
+
------------- | ------------- | ------------- | -------------
|
1385
|
+
**id** | [**Array<String>**](String.html)| id | [optional] |
|
1386
|
+
{: class="table table-striped"}
|
1387
|
+
|
1388
|
+
|
1389
|
+
### Return type
|
1390
|
+
|
1391
|
+
**Hash<String, Object>**
|
1392
|
+
|
1393
|
+
### HTTP request headers
|
1394
|
+
|
1395
|
+
- **Content-Type**: application/json
|
1396
|
+
- **Accept**: application/json
|
1397
|
+
|
1398
|
+
|
1399
|
+
|
1333
1400
|
<a name="get_user_roles"></a>
|
1334
1401
|
|
1335
1402
|
## [**UserAuthorization**](UserAuthorization.html) get_user_roles(user_id)
|
@@ -15,8 +15,8 @@ title: DomainOrganizationRole
|
|
15
15
|
| **permission_policies** | [**Array<DomainPermissionPolicy>**](DomainPermissionPolicy.html) | | [optional] |
|
16
16
|
| **user_count** | **Integer** | | [optional] |
|
17
17
|
| **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
|
18
|
-
| **base** | **BOOLEAN** | | [optional] |
|
19
18
|
| **default** | **BOOLEAN** | | [optional] |
|
19
|
+
| **base** | **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<DomainPermissionPolicy>**](DomainPermissionPolicy.html) | | [optional] |
|
16
16
|
| **user_count** | **Integer** | | [optional] |
|
17
17
|
| **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
|
18
|
-
| **base** | **BOOLEAN** | | [optional] |
|
19
18
|
| **default** | **BOOLEAN** | | [optional] |
|
19
|
+
| **base** | **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<DomainPermissionPolicy>**](DomainPermissionPolicy.html) | | [optional] |
|
16
16
|
| **user_count** | **Integer** | | [optional] |
|
17
17
|
| **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
|
18
|
-
| **base** | **BOOLEAN** | | [optional] |
|
19
18
|
| **default** | **BOOLEAN** | | [optional] |
|
19
|
+
| **base** | **BOOLEAN** | | [optional] |
|
20
20
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
21
21
|
{: class="table table-striped"}
|
22
22
|
|
data/docs/GroupsApi.md
CHANGED
@@ -38,6 +38,7 @@ Wraps DELETE /api/v2/groups/{groupId}
|
|
38
38
|
|
39
39
|
Requires ANY permissions:
|
40
40
|
|
41
|
+
* directory:group:delete
|
41
42
|
* group_administration
|
42
43
|
* admin
|
43
44
|
|
@@ -781,6 +782,7 @@ Wraps POST /api/v2/groups
|
|
781
782
|
|
782
783
|
Requires ANY permissions:
|
783
784
|
|
785
|
+
* directory:group:add
|
784
786
|
* group_administration
|
785
787
|
* group_creation
|
786
788
|
|
@@ -911,6 +913,7 @@ Wraps PUT /api/v2/groups/{groupId}
|
|
911
913
|
|
912
914
|
Requires ANY permissions:
|
913
915
|
|
916
|
+
* directory:group:edit
|
914
917
|
* group_administration
|
915
918
|
* admin
|
916
919
|
|
data/docs/IntegrationsApi.md
CHANGED
@@ -561,8 +561,8 @@ api_instance = PureCloud::IntegrationsApi.new
|
|
561
561
|
action_id = "action_id_example" # String | actionId
|
562
562
|
|
563
563
|
opts = {
|
564
|
-
expand: "expand_example", # String | Indicates
|
565
|
-
include_config: false # BOOLEAN |
|
564
|
+
expand: "expand_example", # String | Indicates a field in the response which should be expanded.
|
565
|
+
include_config: false # BOOLEAN | Return config in response.
|
566
566
|
}
|
567
567
|
|
568
568
|
begin
|
@@ -579,8 +579,8 @@ end
|
|
579
579
|
Name | Type | Description | Notes
|
580
580
|
------------- | ------------- | ------------- | -------------
|
581
581
|
**action_id** | **String**| actionId | |
|
582
|
-
**expand** | **String**| Indicates
|
583
|
-
**include_config** | **BOOLEAN**|
|
582
|
+
**expand** | **String**| Indicates a field in the response which should be expanded. | [optional] <br />**Values**: contract |
|
583
|
+
**include_config** | **BOOLEAN**| Return config in response. | [optional] [default to false] |
|
584
584
|
{: class="table table-striped"}
|
585
585
|
|
586
586
|
|
@@ -633,8 +633,8 @@ api_instance = PureCloud::IntegrationsApi.new
|
|
633
633
|
action_id = "action_id_example" # String | actionId
|
634
634
|
|
635
635
|
opts = {
|
636
|
-
expand: "expand_example", # String | Indicates
|
637
|
-
include_config: false # BOOLEAN |
|
636
|
+
expand: "expand_example", # String | Indicates a field in the response which should be expanded.
|
637
|
+
include_config: false # BOOLEAN | Return config in response.
|
638
638
|
}
|
639
639
|
|
640
640
|
begin
|
@@ -651,8 +651,8 @@ end
|
|
651
651
|
Name | Type | Description | Notes
|
652
652
|
------------- | ------------- | ------------- | -------------
|
653
653
|
**action_id** | **String**| actionId | |
|
654
|
-
**expand** | **String**| Indicates
|
655
|
-
**include_config** | **BOOLEAN**|
|
654
|
+
**expand** | **String**| Indicates a field in the response which should be expanded. | [optional] <br />**Values**: contract |
|
655
|
+
**include_config** | **BOOLEAN**| Return config in response. | [optional] [default to false] |
|
656
656
|
{: class="table table-striped"}
|
657
657
|
|
658
658
|
|
@@ -1044,15 +1044,16 @@ end
|
|
1044
1044
|
api_instance = PureCloud::IntegrationsApi.new
|
1045
1045
|
|
1046
1046
|
opts = {
|
1047
|
-
category: "category_example", # String | Filter by category name
|
1048
|
-
secure: "secure_example", # String | 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.
|
1049
|
-
include_auth_actions: "include_auth_actions_example", # String | 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.
|
1050
1047
|
page_size: 25, # Integer | The total page size requested
|
1051
1048
|
page_number: 1, # Integer | The page number requested
|
1052
|
-
sort_by: "sort_by_example", # String | variable name requested to sort by
|
1053
|
-
expand: ["expand_example"], # Array<String> | variable name requested by expand list
|
1054
1049
|
next_page: "next_page_example", # String | next page token
|
1055
|
-
previous_page: "previous_page_example" # String | Previous page token
|
1050
|
+
previous_page: "previous_page_example", # String | Previous page token
|
1051
|
+
sort_by: "sort_by_example", # String | Root level field name to sort on.
|
1052
|
+
sort_order: "asc", # String | Direction to sort 'sortBy' field.
|
1053
|
+
category: "category_example", # String | Filter by category name
|
1054
|
+
name: "name_example", # String | Filter by action name. Provide full or just the first part of name.
|
1055
|
+
secure: "secure_example", # String | 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.
|
1056
|
+
include_auth_actions: "false" # String | 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.
|
1056
1057
|
}
|
1057
1058
|
|
1058
1059
|
begin
|
@@ -1068,15 +1069,16 @@ end
|
|
1068
1069
|
|
1069
1070
|
Name | Type | Description | Notes
|
1070
1071
|
------------- | ------------- | ------------- | -------------
|
1071
|
-
**category** | **String**| Filter by category name | [optional] |
|
1072
|
-
**secure** | **String**| 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. | [optional] <br />**Values**: true, false |
|
1073
|
-
**include_auth_actions** | **String**| 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. | [optional] <br />**Values**: true, false |
|
1074
1072
|
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
1075
1073
|
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
1076
|
-
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
1077
|
-
**expand** | [**Array<String>**](String.html)| variable name requested by expand list | [optional] |
|
1078
1074
|
**next_page** | **String**| next page token | [optional] |
|
1079
1075
|
**previous_page** | **String**| Previous page token | [optional] |
|
1076
|
+
**sort_by** | **String**| Root level field name to sort on. | [optional] |
|
1077
|
+
**sort_order** | **String**| Direction to sort 'sortBy' field. | [optional] [default to asc]<br />**Values**: ASC, DESC |
|
1078
|
+
**category** | **String**| Filter by category name | [optional] |
|
1079
|
+
**name** | **String**| Filter by action name. Provide full or just the first part of name. | [optional] |
|
1080
|
+
**secure** | **String**| 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. | [optional] <br />**Values**: true, false |
|
1081
|
+
**include_auth_actions** | **String**| 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. | [optional] [default to false]<br />**Values**: true, false |
|
1080
1082
|
{: class="table table-striped"}
|
1081
1083
|
|
1082
1084
|
|
@@ -1127,13 +1129,13 @@ end
|
|
1127
1129
|
api_instance = PureCloud::IntegrationsApi.new
|
1128
1130
|
|
1129
1131
|
opts = {
|
1130
|
-
secure: "secure_example", # String | 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.
|
1131
1132
|
page_size: 25, # Integer | The total page size requested
|
1132
1133
|
page_number: 1, # Integer | The page number requested
|
1133
|
-
sort_by: "sort_by_example", # String | variable name requested to sort by
|
1134
|
-
expand: ["expand_example"], # Array<String> | variable name requested by expand list
|
1135
1134
|
next_page: "next_page_example", # String | next page token
|
1136
|
-
previous_page: "previous_page_example" # String | Previous page token
|
1135
|
+
previous_page: "previous_page_example", # String | Previous page token
|
1136
|
+
sort_by: "sort_by_example", # String | Root level field name to sort on.
|
1137
|
+
sort_order: "asc", # String | Direction to sort 'sortBy' field.
|
1138
|
+
secure: "secure_example" # String | 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.
|
1137
1139
|
}
|
1138
1140
|
|
1139
1141
|
begin
|
@@ -1149,13 +1151,13 @@ end
|
|
1149
1151
|
|
1150
1152
|
Name | Type | Description | Notes
|
1151
1153
|
------------- | ------------- | ------------- | -------------
|
1152
|
-
**secure** | **String**| 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. | [optional] <br />**Values**: true, false |
|
1153
1154
|
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
1154
1155
|
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
1155
|
-
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
1156
|
-
**expand** | [**Array<String>**](String.html)| variable name requested by expand list | [optional] |
|
1157
1156
|
**next_page** | **String**| next page token | [optional] |
|
1158
1157
|
**previous_page** | **String**| Previous page token | [optional] |
|
1158
|
+
**sort_by** | **String**| Root level field name to sort on. | [optional] |
|
1159
|
+
**sort_order** | **String**| Direction to sort 'sortBy' field. | [optional] [default to asc]<br />**Values**: ASC, DESC |
|
1160
|
+
**secure** | **String**| 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. | [optional] <br />**Values**: true, false |
|
1159
1161
|
{: class="table table-striped"}
|
1160
1162
|
|
1161
1163
|
|
@@ -1206,15 +1208,16 @@ end
|
|
1206
1208
|
api_instance = PureCloud::IntegrationsApi.new
|
1207
1209
|
|
1208
1210
|
opts = {
|
1209
|
-
category: "category_example", # String | Filter by category name
|
1210
|
-
secure: "secure_example", # String | 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.
|
1211
|
-
include_auth_actions: "include_auth_actions_example", # String | 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.
|
1212
1211
|
page_size: 25, # Integer | The total page size requested
|
1213
1212
|
page_number: 1, # Integer | The page number requested
|
1214
|
-
sort_by: "sort_by_example", # String | variable name requested to sort by
|
1215
|
-
expand: ["expand_example"], # Array<String> | variable name requested by expand list
|
1216
1213
|
next_page: "next_page_example", # String | next page token
|
1217
|
-
previous_page: "previous_page_example" # String | Previous page token
|
1214
|
+
previous_page: "previous_page_example", # String | Previous page token
|
1215
|
+
sort_by: "sort_by_example", # String | Root level field name to sort on.
|
1216
|
+
sort_order: "asc", # String | Direction to sort 'sortBy' field.
|
1217
|
+
category: "category_example", # String | Filter by category name
|
1218
|
+
name: "name_example", # String | Filter by action name. Provide full or just the first part of name.
|
1219
|
+
secure: "secure_example", # String | 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.
|
1220
|
+
include_auth_actions: "false" # String | 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.
|
1218
1221
|
}
|
1219
1222
|
|
1220
1223
|
begin
|
@@ -1230,15 +1233,16 @@ end
|
|
1230
1233
|
|
1231
1234
|
Name | Type | Description | Notes
|
1232
1235
|
------------- | ------------- | ------------- | -------------
|
1233
|
-
**category** | **String**| Filter by category name | [optional] |
|
1234
|
-
**secure** | **String**| 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. | [optional] <br />**Values**: true, false |
|
1235
|
-
**include_auth_actions** | **String**| 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. | [optional] <br />**Values**: true, false |
|
1236
1236
|
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
1237
1237
|
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
1238
|
-
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
1239
|
-
**expand** | [**Array<String>**](String.html)| variable name requested by expand list | [optional] |
|
1240
1238
|
**next_page** | **String**| next page token | [optional] |
|
1241
1239
|
**previous_page** | **String**| Previous page token | [optional] |
|
1240
|
+
**sort_by** | **String**| Root level field name to sort on. | [optional] |
|
1241
|
+
**sort_order** | **String**| Direction to sort 'sortBy' field. | [optional] [default to asc]<br />**Values**: ASC, DESC |
|
1242
|
+
**category** | **String**| Filter by category name | [optional] |
|
1243
|
+
**name** | **String**| Filter by action name. Provide full or just the first part of name. | [optional] |
|
1244
|
+
**secure** | **String**| 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. | [optional] <br />**Values**: true, false |
|
1245
|
+
**include_auth_actions** | **String**| 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. | [optional] [default to false]<br />**Values**: true, false |
|
1242
1246
|
{: class="table table-striped"}
|
1243
1247
|
|
1244
1248
|
|