doc_out/AnalyticsApi.html.md in purecloud-0.44.1 vs doc_out/AnalyticsApi.html.md in purecloud-0.45.1

- old
+ new

@@ -656,11 +656,11 @@ <a name="post_conversations_aggregates_query"></a> -## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_conversations_aggregates_query(opts) +## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_conversations_aggregates_query(body) Query for conversation aggregates @@ -679,28 +679,27 @@ config.access_token = @authToken end api_instance = PureCloud::AnalyticsApi.new -opts = { - body: PureCloud::AggregationQuery.new # AggregationQuery | query -} +body = PureCloud::AggregationQuery.new # AggregationQuery | query + begin #Query for conversation aggregates - result = api_instance.post_conversations_aggregates_query(opts) + result = api_instance.post_conversations_aggregates_query(body) p result rescue PureCloud::ApiError => e puts "Exception when calling AnalyticsApi->post_conversations_aggregates_query: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**AggregationQuery**](AggregationQuery.html)| query | [optional] + **body** | [**AggregationQuery**](AggregationQuery.html)| query | {: class="table table-striped"} ### Return type @@ -713,11 +712,11 @@ <a name="post_conversations_conversation_id_details_properties"></a> -## -[**PropertyIndexRequest**](PropertyIndexRequest.html) post_conversations_conversation_id_details_properties(conversation_id, opts) +## -[**PropertyIndexRequest**](PropertyIndexRequest.html) post_conversations_conversation_id_details_properties(conversation_id, body) Index conversation properties @@ -738,17 +737,16 @@ api_instance = PureCloud::AnalyticsApi.new conversation_id = "conversation_id_example" # String | conversationId -opts = { - body: PureCloud::PropertyIndexRequest.new # PropertyIndexRequest | request -} +body = PureCloud::PropertyIndexRequest.new # PropertyIndexRequest | request + begin #Index conversation properties - result = api_instance.post_conversations_conversation_id_details_properties(conversation_id, opts) + result = api_instance.post_conversations_conversation_id_details_properties(conversation_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling AnalyticsApi->post_conversations_conversation_id_details_properties: #{e}" end ~~~ @@ -756,11 +754,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **conversation_id** | **String**| conversationId | - **body** | [**PropertyIndexRequest**](PropertyIndexRequest.html)| request | [optional] + **body** | [**PropertyIndexRequest**](PropertyIndexRequest.html)| request | {: class="table table-striped"} ### Return type @@ -773,11 +771,11 @@ <a name="post_conversations_details_query"></a> -## -[**AnalyticsConversationQueryResponse**](AnalyticsConversationQueryResponse.html) post_conversations_details_query(opts) +## -[**AnalyticsConversationQueryResponse**](AnalyticsConversationQueryResponse.html) post_conversations_details_query(body) Query for conversation details @@ -796,28 +794,27 @@ config.access_token = @authToken end api_instance = PureCloud::AnalyticsApi.new -opts = { - body: PureCloud::ConversationQuery.new # ConversationQuery | query -} +body = PureCloud::ConversationQuery.new # ConversationQuery | query + begin #Query for conversation details - result = api_instance.post_conversations_details_query(opts) + result = api_instance.post_conversations_details_query(body) p result rescue PureCloud::ApiError => e puts "Exception when calling AnalyticsApi->post_conversations_details_query: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**ConversationQuery**](ConversationQuery.html)| query | [optional] + **body** | [**ConversationQuery**](ConversationQuery.html)| query | {: class="table table-striped"} ### Return type @@ -830,11 +827,11 @@ <a name="post_evaluations_aggregates_query"></a> -## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_evaluations_aggregates_query(opts) +## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_evaluations_aggregates_query(body) Query for evaluation aggregates @@ -853,28 +850,27 @@ config.access_token = @authToken end api_instance = PureCloud::AnalyticsApi.new -opts = { - body: PureCloud::AggregationQuery.new # AggregationQuery | query -} +body = PureCloud::AggregationQuery.new # AggregationQuery | query + begin #Query for evaluation aggregates - result = api_instance.post_evaluations_aggregates_query(opts) + result = api_instance.post_evaluations_aggregates_query(body) p result rescue PureCloud::ApiError => e puts "Exception when calling AnalyticsApi->post_evaluations_aggregates_query: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**AggregationQuery**](AggregationQuery.html)| query | [optional] + **body** | [**AggregationQuery**](AggregationQuery.html)| query | {: class="table table-striped"} ### Return type @@ -887,11 +883,11 @@ <a name="post_queues_observations_query"></a> -## -[**ObservationQueryResponse**](ObservationQueryResponse.html) post_queues_observations_query(opts) +## -[**ObservationQueryResponse**](ObservationQueryResponse.html) post_queues_observations_query(body) Query for queue observations @@ -910,28 +906,27 @@ config.access_token = @authToken end api_instance = PureCloud::AnalyticsApi.new -opts = { - body: PureCloud::ObservationQuery.new # ObservationQuery | query -} +body = PureCloud::ObservationQuery.new # ObservationQuery | query + begin #Query for queue observations - result = api_instance.post_queues_observations_query(opts) + result = api_instance.post_queues_observations_query(body) p result rescue PureCloud::ApiError => e puts "Exception when calling AnalyticsApi->post_queues_observations_query: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**ObservationQuery**](ObservationQuery.html)| query | [optional] + **body** | [**ObservationQuery**](ObservationQuery.html)| query | {: class="table table-striped"} ### Return type @@ -944,11 +939,11 @@ <a name="post_reporting_schedules"></a> -## -[**ReportSchedule**](ReportSchedule.html) post_reporting_schedules(opts) +## -[**ReportSchedule**](ReportSchedule.html) post_reporting_schedules(body) Create a scheduled report job Create a scheduled report job. @@ -967,28 +962,27 @@ config.access_token = @authToken end api_instance = PureCloud::AnalyticsApi.new -opts = { - body: PureCloud::ReportSchedule.new # ReportSchedule | ReportSchedule -} +body = PureCloud::ReportSchedule.new # ReportSchedule | ReportSchedule + begin #Create a scheduled report job - result = api_instance.post_reporting_schedules(opts) + result = api_instance.post_reporting_schedules(body) p result rescue PureCloud::ApiError => e puts "Exception when calling AnalyticsApi->post_reporting_schedules: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**ReportSchedule**](ReportSchedule.html)| ReportSchedule | [optional] + **body** | [**ReportSchedule**](ReportSchedule.html)| ReportSchedule | {: class="table table-striped"} ### Return type @@ -1057,11 +1051,11 @@ <a name="post_users_aggregates_query"></a> -## -[**PresenceQueryResponse**](PresenceQueryResponse.html) post_users_aggregates_query(opts) +## -[**PresenceQueryResponse**](PresenceQueryResponse.html) post_users_aggregates_query(body) Query for user aggregates @@ -1080,28 +1074,27 @@ config.access_token = @authToken end api_instance = PureCloud::AnalyticsApi.new -opts = { - body: PureCloud::AggregationQuery.new # AggregationQuery | query -} +body = PureCloud::AggregationQuery.new # AggregationQuery | query + begin #Query for user aggregates - result = api_instance.post_users_aggregates_query(opts) + result = api_instance.post_users_aggregates_query(body) p result rescue PureCloud::ApiError => e puts "Exception when calling AnalyticsApi->post_users_aggregates_query: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**AggregationQuery**](AggregationQuery.html)| query | [optional] + **body** | [**AggregationQuery**](AggregationQuery.html)| query | {: class="table table-striped"} ### Return type @@ -1114,11 +1107,11 @@ <a name="post_users_observations_query"></a> -## -[**ObservationQueryResponse**](ObservationQueryResponse.html) post_users_observations_query(opts) +## -[**ObservationQueryResponse**](ObservationQueryResponse.html) post_users_observations_query(body) Query for user observations @@ -1137,28 +1130,27 @@ config.access_token = @authToken end api_instance = PureCloud::AnalyticsApi.new -opts = { - body: PureCloud::ObservationQuery.new # ObservationQuery | query -} +body = PureCloud::ObservationQuery.new # ObservationQuery | query + begin #Query for user observations - result = api_instance.post_users_observations_query(opts) + result = api_instance.post_users_observations_query(body) p result rescue PureCloud::ApiError => e puts "Exception when calling AnalyticsApi->post_users_observations_query: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**ObservationQuery**](ObservationQuery.html)| query | [optional] + **body** | [**ObservationQuery**](ObservationQuery.html)| query | {: class="table table-striped"} ### Return type @@ -1171,11 +1163,11 @@ <a name="put_reporting_schedules_schedule_id"></a> -## -[**ReportSchedule**](ReportSchedule.html) put_reporting_schedules_schedule_id(schedule_id, opts) +## -[**ReportSchedule**](ReportSchedule.html) put_reporting_schedules_schedule_id(schedule_id, body) Update a scheduled report job. @@ -1196,17 +1188,16 @@ api_instance = PureCloud::AnalyticsApi.new schedule_id = "schedule_id_example" # String | Schedule ID -opts = { - body: PureCloud::ReportSchedule.new # ReportSchedule | ReportSchedule -} +body = PureCloud::ReportSchedule.new # ReportSchedule | ReportSchedule + begin #Update a scheduled report job. - result = api_instance.put_reporting_schedules_schedule_id(schedule_id, opts) + result = api_instance.put_reporting_schedules_schedule_id(schedule_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling AnalyticsApi->put_reporting_schedules_schedule_id: #{e}" end ~~~ @@ -1214,10 +1205,10 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **schedule_id** | **String**| Schedule ID | - **body** | [**ReportSchedule**](ReportSchedule.html)| ReportSchedule | [optional] + **body** | [**ReportSchedule**](ReportSchedule.html)| ReportSchedule | {: class="table table-striped"} ### Return type