Package com.mypurecloud.sdk.v2.api

Class OperationalEventsApi

java.lang.Object

com.mypurecloud.sdk.v2.api.OperationalEventsApi

public class OperationalEventsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
OperationalEventsApi()
OperationalEventsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
EventDefinition	getUsageEventsDefinition(GetUsageEventsDefinitionRequest request)	Get an operational event definition by its id
ApiResponse<EventDefinition>	getUsageEventsDefinition(ApiRequest<Void> request)	Get an operational event definition by its id
EventDefinition	getUsageEventsDefinition(String eventDefinitionId)	Get an operational event definition by its id
EventDefinitionListing	getUsageEventsDefinitions()	Get all operational event definitions
EventDefinitionListing	getUsageEventsDefinitions(GetUsageEventsDefinitionsRequest request)	Get all operational event definitions
ApiResponse<EventDefinitionListing>	getUsageEventsDefinitions(ApiRequest<Void> request)	Get all operational event definitions
ApiResponse<EventDefinitionListing>	getUsageEventsDefinitionsWithHttpInfo()	Get all operational event definitions
ApiResponse<EventDefinition>	getUsageEventsDefinitionWithHttpInfo(String eventDefinitionId)	Get an operational event definition by its id
EventAggregatesResponse	postUsageEventsAggregatesQuery(PostUsageEventsAggregatesQueryRequest request)	Get aggregates for operational events in a timeframe.
ApiResponse<EventAggregatesResponse>	postUsageEventsAggregatesQuery(ApiRequest<EventAggregatesQueryRequest> request)	Get aggregates for operational events in a timeframe.
EventAggregatesResponse	postUsageEventsAggregatesQuery(EventAggregatesQueryRequest body)	Get aggregates for operational events in a timeframe.
ApiResponse<EventAggregatesResponse>	postUsageEventsAggregatesQueryWithHttpInfo(EventAggregatesQueryRequest body)	Get aggregates for operational events in a timeframe.
EventQueryResponse	postUsageEventsQuery(PostUsageEventsQueryRequest request)	Query operational events in a timeframe.
ApiResponse<EventQueryResponse>	postUsageEventsQuery(ApiRequest<EventQueryRequest> request)	Query operational events in a timeframe.
EventQueryResponse	postUsageEventsQuery(String before, String after, String pageSize, EventQueryRequest body)	Query operational events in a timeframe.
ApiResponse<EventQueryResponse>	postUsageEventsQueryWithHttpInfo(String before, String after, String pageSize, EventQueryRequest body)	Query operational events in a timeframe.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OperationalEventsApi

public OperationalEventsApi()

OperationalEventsApi

public OperationalEventsApi(ApiClient apiClient)

Method Details

getUsageEventsDefinition

public EventDefinition getUsageEventsDefinition(String eventDefinitionId)
                                         throws IOException,
ApiException

Get an operational event definition by its id

Parameters:

eventDefinitionId - EventDefinition id (required)

Returns:

EventDefinition

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getUsageEventsDefinitionWithHttpInfo

public ApiResponse<EventDefinition> getUsageEventsDefinitionWithHttpInfo(String eventDefinitionId)
                                                                  throws IOException

Get an operational event definition by its id

Parameters:

eventDefinitionId - EventDefinition id (required)

Returns:

EventDefinition

Throws:

IOException - if the request fails to be processed

getUsageEventsDefinition

public EventDefinition getUsageEventsDefinition(GetUsageEventsDefinitionRequest request)
                                         throws IOException,
ApiException

Get an operational event definition by its id

Parameters:

request - The request object

Returns:

EventDefinition

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getUsageEventsDefinition

public ApiResponse<EventDefinition> getUsageEventsDefinition(ApiRequest<Void> request)
                                                      throws IOException

Get an operational event definition by its id

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getUsageEventsDefinitions

public EventDefinitionListing getUsageEventsDefinitions()
                                                 throws IOException,
ApiException

Get all operational event definitions

Returns:

EventDefinitionListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getUsageEventsDefinitionsWithHttpInfo

public ApiResponse<EventDefinitionListing> getUsageEventsDefinitionsWithHttpInfo()
                                                                          throws IOException

Get all operational event definitions

Returns:

EventDefinitionListing

Throws:

IOException - if the request fails to be processed

getUsageEventsDefinitions

public EventDefinitionListing getUsageEventsDefinitions(GetUsageEventsDefinitionsRequest request)
                                                 throws IOException,
ApiException

Get all operational event definitions

Parameters:

request - The request object

Returns:

EventDefinitionListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getUsageEventsDefinitions

public ApiResponse<EventDefinitionListing> getUsageEventsDefinitions(ApiRequest<Void> request)
                                                              throws IOException

Get all operational event definitions

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postUsageEventsAggregatesQuery

public EventAggregatesResponse postUsageEventsAggregatesQuery(EventAggregatesQueryRequest body)
                                                       throws IOException,
ApiException

Get aggregates for operational events in a timeframe.

Parameters:

body - (optional)

Returns:

EventAggregatesResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postUsageEventsAggregatesQueryWithHttpInfo

public ApiResponse<EventAggregatesResponse> postUsageEventsAggregatesQueryWithHttpInfo(EventAggregatesQueryRequest body)
                                                                                throws IOException

Get aggregates for operational events in a timeframe.

Parameters:

body - (optional)

Returns:

EventAggregatesResponse

Throws:

IOException - if the request fails to be processed

postUsageEventsAggregatesQuery

public EventAggregatesResponse postUsageEventsAggregatesQuery(PostUsageEventsAggregatesQueryRequest request)
                                                       throws IOException,
ApiException

Get aggregates for operational events in a timeframe.

Parameters:

request - The request object

Returns:

EventAggregatesResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postUsageEventsAggregatesQuery

public ApiResponse<EventAggregatesResponse> postUsageEventsAggregatesQuery(ApiRequest<EventAggregatesQueryRequest> request)
                                                                    throws IOException

Get aggregates for operational events in a timeframe.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postUsageEventsQuery

public EventQueryResponse postUsageEventsQuery(String before,
 String after,
 String pageSize,
 EventQueryRequest body)
                                        throws IOException,
ApiException

Query operational events in a timeframe.

Parameters:

before - The cursor that points to the start of the set of entities that has been returned. (optional)

after - The cursor that points to the end of the set of entities that has been returned. (optional)

pageSize - Number of entities to return. Maximum of 200. (optional)

body - (optional)

Returns:

EventQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postUsageEventsQueryWithHttpInfo

public ApiResponse<EventQueryResponse> postUsageEventsQueryWithHttpInfo(String before,
 String after,
 String pageSize,
 EventQueryRequest body)
                                                                 throws IOException

Query operational events in a timeframe.

Parameters:

before - The cursor that points to the start of the set of entities that has been returned. (optional)

after - The cursor that points to the end of the set of entities that has been returned. (optional)

pageSize - Number of entities to return. Maximum of 200. (optional)

body - (optional)

Returns:

EventQueryResponse

Throws:

IOException - if the request fails to be processed

postUsageEventsQuery

public EventQueryResponse postUsageEventsQuery(PostUsageEventsQueryRequest request)
                                        throws IOException,
ApiException

Query operational events in a timeframe.

Parameters:

request - The request object

Returns:

EventQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postUsageEventsQuery

public ApiResponse<EventQueryResponse> postUsageEventsQuery(ApiRequest<EventQueryRequest> request)
                                                     throws IOException

Query operational events in a timeframe.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed