purecloudplatformclientv2 87.0.0 → 92.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cce9512dc39d496d6cdaa3525d5c72c7d3090757
-  data.tar.gz: a273910322ded4e284f142c84571166467aaa164
+  metadata.gz: de5b34b200b5833072135f588c7cb1c5f5bbe4b5
+  data.tar.gz: eaee9307038e485bd8bd4cceb89b103cb68e03af
 SHA512:
-  metadata.gz: 6f11945a94ef34efaa258bc7afd0f7587efbb54adb6544966ea6251cf65ab30520863d0887f114f7736396c902c9a1b73ae0502d495736251ebe7d68d0e9567a
-  data.tar.gz: 6e9d8c5bc7cfb9ea14b63be8333f20cbbbbf6e04a84aa2d30d8dc25426576dfb2a40bf99837faeedc738f9659722794210abf92c64a2c35c00942f368c32c647
+  metadata.gz: eb4d0ac120ede979ec0a76dfdefbcb139915c0d31581e5778f2fee6f0593e3f080235c9dfa7f7972ac8e8fe37bbb06a4b95b960f5d463d431f10cc456d36d726
+  data.tar.gz: 5cfc3bb03f0ca0dc0de84d344c7b83f1735c1fde75daaf45ac0a32835782d3de6507fa79296315b548ddce15f92305c8d825757ebe53f595d97225e5b714a9f7

data/README.md

@@ -1,7 +1,7 @@
 ---
-title: PureCloud Ruby Gem
+title: Platform API Client SDK - Ruby
 ---
-![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=87.0.0)
+![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=92.0.0)
 
 Documentation can be found at [https://developer.mypurecloud.com/api/rest/client-libraries/ruby/](https://developer.mypurecloud.com/api/rest/client-libraries/ruby/)
 
@@ -10,7 +10,7 @@ Documentation can be found at [https://developer.mypurecloud.com/api/rest/client
 ### from rubygems.org
 
 ```{"language":"ruby"}
-gem install 'purecloudplatformclientv2', '~> 87.0.0'
+gem install 'purecloudplatformclientv2', '~> 92.0.0'
 ```
 
 ### Install from Git
@@ -59,6 +59,6 @@ The SDK's version is incremented according to the [Semantic Versioning Specifica
 
 ## Support
 
-This package is intended to be forwards compatible with v2 of PureCloud's Platform API. While the general policy for the API is not to introduce breaking changes, there are certain additions and changes to the API that cause breaking changes for the SDK, often due to the way the API is expressed in its swagger definition. Because of this, the SDK can have a major version bump while the API remains at major version 2. While the SDK is intended to be forward compatible, patches will only be released to the latest version. For these reasons, it is strongly recommended that all applications using this SDK are kept up to date and use the latest version of the SDK.
+This package is intended to be forwards compatible with v2 of Genesys Cloud's Platform API. While the general policy for the API is not to introduce breaking changes, there are certain additions and changes to the API that cause breaking changes for the SDK, often due to the way the API is expressed in its swagger definition. Because of this, the SDK can have a major version bump while the API remains at major version 2. While the SDK is intended to be forward compatible, patches will only be released to the latest version. For these reasons, it is strongly recommended that all applications using this SDK are kept up to date and use the latest version of the SDK.
 
-For any issues, questions, or suggestions for the SDK, visit the [PureCloud Developer Forum](https://developer.mypurecloud.com/forum/).
+For any issues, questions, or suggestions for the SDK, visit the [Genesys Cloud Developer Forum](https://developer.mypurecloud.com/forum/).

data/docs/AmazonLexRequest.md

@@ -0,0 +1,14 @@
+---
+title: AmazonLexRequest
+---
+## PureCloud::AmazonLexRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **request_attributes** | **Hash<String, String>** | AttributeName/AttributeValue pairs of User Defined Request Attributes to be sent to the amazon bot See - https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs | [optional] |
+| **session_attributes** | **Hash<String, String>** | AttributeName/AttributeValue pairs of Session Attributes to be sent to the amazon bot. See - https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs | [optional] |
+{: class="table table-striped"}
+
+

data/docs/AnalyticsEvaluation.md

@@ -18,8 +18,8 @@ title: AnalyticsEvaluation
 | **calibration_id** | **String** | The calibration id used for the purpose of training evaluators | [optional] |
 | **rescored** | **BOOLEAN** | Whether this evaluation has ever been rescored | [optional] |
 | **deleted** | **BOOLEAN** | Whether this evaluation has been deleted | [optional] |
-| **o_total_score** | **Integer** |  | [optional] |
 | **o_total_critical_score** | **Integer** |  | [optional] |
+| **o_total_score** | **Integer** |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/ApiUsageQuery.md

@@ -0,0 +1,16 @@
+---
+title: ApiUsageQuery
+---
+## PureCloud::ApiUsageQuery
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **interval** | **String** | Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | |
+| **granularity** | **String** | Date granularity of the results | [optional] |
+| **group_by** | **Array<String>** | Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. | [optional] |
+| **metrics** | **Array<String>** | Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *). | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ApiUsageQueryResult.md

@@ -0,0 +1,14 @@
+---
+title: ApiUsageQueryResult
+---
+## PureCloud::ApiUsageQueryResult
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **results** | [**Array<ApiUsageRow>**](ApiUsageRow.html) | Query results | [optional] |
+| **query_status** | **String** | Query status | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ApiUsageRow.md

@@ -0,0 +1,25 @@
+---
+title: ApiUsageRow
+---
+## PureCloud::ApiUsageRow
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **client_id** | **String** | Client Id associated with this query result | [optional] |
+| **client_name** | **String** | Client Name associated with this query result | [optional] |
+| **organization_id** | **String** | Organization Id associated with this query result | [optional] |
+| **user_id** | **String** | User Id associated with this query result | [optional] |
+| **template_uri** | **String** | Template Uri associated with this query result | [optional] |
+| **http_method** | **String** | HTTP Method associated with this query result | [optional] |
+| **status200** | **Integer** | Number of requests resulting in a 2xx HTTP status code | [optional] |
+| **status300** | **Integer** | Number of requests resulting in a 3xx HTTP status code | [optional] |
+| **status400** | **Integer** | Number of requests resulting in a 4xx HTTP status code | [optional] |
+| **status500** | **Integer** | Number of requests resulting in a 5xx HTTP status code | [optional] |
+| **status429** | **Integer** | Number of requests resulting in a 429 HTTP status code, this is a subset of the count returned with status400 | [optional] |
+| **requests** | **Integer** | Total number of requests | [optional] |
+| **date** | **DateTime** | Date of requests, based on granularity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ArchitectApi.md

@@ -63,6 +63,7 @@ Method | Description
 [**get_flows_datatable_rows**](ArchitectApi.html#get_flows_datatable_rows) | Returns the rows for the datatable with the given id
 [**get_flows_datatables**](ArchitectApi.html#get_flows_datatables) | Retrieve a list of datatables for the org
 [**get_flows_divisionviews**](ArchitectApi.html#get_flows_divisionviews) | Get a pageable list of basic flow information objects filterable by query parameters.
+[**get_flows_execution**](ArchitectApi.html#get_flows_execution) | Get a flow execution's details. Flow execution details are available for several days after the flow is started.
 [**get_flows_outcome**](ArchitectApi.html#get_flows_outcome) | Get a flow outcome
 [**get_flows_outcomes**](ArchitectApi.html#get_flows_outcomes) | Get a pageable list of flow outcomes, filtered by query parameters
 [**post_architect_dependencytracking_build**](ArchitectApi.html#post_architect_dependencytracking_build) | Rebuild Dependency Tracking data for an organization
@@ -87,6 +88,7 @@ Method | Description
 [**post_flows_datatable_import_jobs**](ArchitectApi.html#post_flows_datatable_import_jobs) | Begin an import process for importing rows into a datatable
 [**post_flows_datatable_rows**](ArchitectApi.html#post_flows_datatable_rows) | Create a new row entry for the datatable.
 [**post_flows_datatables**](ArchitectApi.html#post_flows_datatables) | Create a new datatable with the specified json-schema definition
+[**post_flows_executions**](ArchitectApi.html#post_flows_executions) | Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type.
 [**post_flows_outcomes**](ArchitectApi.html#post_flows_outcomes) | Create a flow outcome
 [**put_architect_emergencygroup**](ArchitectApi.html#put_architect_emergencygroup) | Updates a emergency group by ID
 [**put_architect_ivr**](ArchitectApi.html#put_architect_ivr) | Update an IVR Config.
@@ -4026,6 +4028,71 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_flows_execution"></a>
+
+## [**FlowRuntimeExecution**](FlowRuntimeExecution.html) get_flows_execution(flow_execution_id)
+
+
+
+Get a flow execution's details. Flow execution details are available for several days after the flow is started.
+
+
+
+Wraps GET /api/v2/flows/executions/{flowExecutionId} 
+
+Requires ANY permissions: 
+
+* architect:flowExecution:view
+
+
+### Example
+```{"language":"ruby"}
+# load the gem
+require 'purecloudplatformclientv2'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::ArchitectApi.new
+
+flow_execution_id = "flow_execution_id_example" # String | flow execution ID
+
+
+begin
+  #Get a flow execution's details. Flow execution details are available for several days after the flow is started.
+  result = api_instance.get_flows_execution(flow_execution_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling ArchitectApi->get_flows_execution: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **flow_execution_id** | **String**| flow execution ID |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**FlowRuntimeExecution**](FlowRuntimeExecution.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_flows_outcome"></a>
 
 ## [**FlowOutcome**](FlowOutcome.html) get_flows_outcome(flow_outcome_id)
@@ -5615,6 +5682,71 @@ Name | Type | Description  | Notes
 
 
 
+<a name="post_flows_executions"></a>
+
+## [**FlowExecutionLaunchResponse**](FlowExecutionLaunchResponse.html) post_flows_executions(flow_launch_request)
+
+
+
+Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type.
+
+The launch is asynchronous, it returns as soon as the flow starts. You can use the returned ID to query its status if you need.
+
+Wraps POST /api/v2/flows/executions 
+
+Requires ANY permissions: 
+
+* architect:flow:launch
+
+
+### Example
+```{"language":"ruby"}
+# load the gem
+require 'purecloudplatformclientv2'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::ArchitectApi.new
+
+flow_launch_request = PureCloud::FlowExecutionLaunchRequest.new # FlowExecutionLaunchRequest | 
+
+
+begin
+  #Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type.
+  result = api_instance.post_flows_executions(flow_launch_request)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling ArchitectApi->post_flows_executions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **flow_launch_request** | [**FlowExecutionLaunchRequest**](FlowExecutionLaunchRequest.html)|  |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**FlowExecutionLaunchResponse**](FlowExecutionLaunchResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="post_flows_outcomes"></a>
 
 ## [**FlowOutcome**](FlowOutcome.html) post_flows_outcomes(opts)

data/docs/AuditApi.md

@@ -8,11 +8,72 @@ All URIs are relative to *https://api.mypurecloud.com*
 
 Method | Description
 ------------- | ------------- | -------------
+[**get_audits_query_servicemapping**](AuditApi.html#get_audits_query_servicemapping) | Get service mapping information used in audits.
 [**get_audits_query_transaction_id**](AuditApi.html#get_audits_query_transaction_id) | Get status of audit query execution
 [**get_audits_query_transaction_id_results**](AuditApi.html#get_audits_query_transaction_id_results) | Get results of audit query
 [**post_audits_query**](AuditApi.html#post_audits_query) | Create audit query execution
+[**post_audits_query_realtime**](AuditApi.html#post_audits_query_realtime) | This endpoint will only retrieve 7 days worth of audits for certain services. Please use /query to get a full list and older audits.
 {: class="table table-striped"}
 
+<a name="get_audits_query_servicemapping"></a>
+
+## [**AuditQueryServiceMapping**](AuditQueryServiceMapping.html) get_audits_query_servicemapping
+
+
+
+Get service mapping information used in audits.
+
+
+
+Wraps GET /api/v2/audits/query/servicemapping 
+
+Requires ALL permissions: 
+
+* audits:audit:view
+
+
+### Example
+```{"language":"ruby"}
+# load the gem
+require 'purecloudplatformclientv2'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::AuditApi.new
+
+begin
+  #Get service mapping information used in audits.
+  result = api_instance.get_audits_query_servicemapping
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling AuditApi->get_audits_query_servicemapping: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+{: class="table table-striped"}
+
+
+### Return type
+
+[**AuditQueryServiceMapping**](AuditQueryServiceMapping.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_audits_query_transaction_id"></a>
 
 ## [**AuditQueryExecutionStatusResponse**](AuditQueryExecutionStatusResponse.html) get_audits_query_transaction_id(transaction_id)
@@ -216,3 +277,72 @@ Name | Type | Description  | Notes
 
 
 
+<a name="post_audits_query_realtime"></a>
+
+## [**AuditRealtimeQueryResultsResponse**](AuditRealtimeQueryResultsResponse.html) post_audits_query_realtime(body, opts)
+
+
+
+This endpoint will only retrieve 7 days worth of audits for certain services. Please use /query to get a full list and older audits.
+
+
+
+Wraps POST /api/v2/audits/query/realtime 
+
+Requires ALL permissions: 
+
+* audits:audit:view
+
+
+### Example
+```{"language":"ruby"}
+# load the gem
+require 'purecloudplatformclientv2'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::AuditApi.new
+
+body = PureCloud::AuditRealtimeQueryRequest.new # AuditRealtimeQueryRequest | query
+
+opts = { 
+  expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
+}
+
+begin
+  #This endpoint will only retrieve 7 days worth of audits for certain services. Please use /query to get a full list and older audits.
+  result = api_instance.post_audits_query_realtime(body, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling AuditApi->post_audits_query_realtime: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**AuditRealtimeQueryRequest**](AuditRealtimeQueryRequest.html)| query |  |
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: user |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**AuditRealtimeQueryResultsResponse**](AuditRealtimeQueryResultsResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/AuditQueryEntity.md

@@ -0,0 +1,14 @@
+---
+title: AuditQueryEntity
+---
+## PureCloud::AuditQueryEntity
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | Name of the Entity | [optional] |
+| **actions** | **Array<String>** | List of Actions | [optional] |
+{: class="table table-striped"}
+
+

data/docs/AuditQueryExecutionStatusResponse.md

@@ -13,6 +13,7 @@ title: AuditQueryExecutionStatusResponse
 | **interval** | **String** | Interval for the audit query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
 | **service_name** | **String** | Service name for the audit query. | [optional] |
 | **filters** | [**Array<AuditQueryFilter>**](AuditQueryFilter.html) | Filters for the audit query. | [optional] |
+| **sort** | [**Array<AuditQuerySort>**](AuditQuerySort.html) | Sort parameter for the audit query. | [optional] |
 {: class="table table-striped"}