Package com.mypurecloud.sdk.v2.api

Class FlowsApi

java.lang.Object

com.mypurecloud.sdk.v2.api.FlowsApi

public class FlowsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
FlowsApi()
FlowsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteAnalyticsFlowsAggregatesJob(DeleteAnalyticsFlowsAggregatesJobRequest request)	Delete/cancel an async request for flow aggregates
ApiResponse<Void>	deleteAnalyticsFlowsAggregatesJob(ApiRequest<Void> request)	Delete/cancel an async request for flow aggregates
void	deleteAnalyticsFlowsAggregatesJob(String jobId)	Delete/cancel an async request for flow aggregates
ApiResponse<Void>	deleteAnalyticsFlowsAggregatesJobWithHttpInfo(String jobId)	Delete/cancel an async request for flow aggregates
AsyncQueryStatus	getAnalyticsFlowsAggregatesJob(GetAnalyticsFlowsAggregatesJobRequest request)	Get status for async query for Flow aggregates
ApiResponse<AsyncQueryStatus>	getAnalyticsFlowsAggregatesJob(ApiRequest<Void> request)	Get status for async query for Flow aggregates
AsyncQueryStatus	getAnalyticsFlowsAggregatesJob(String jobId)	Get status for async query for Flow aggregates
FlowAsyncAggregateQueryResponse	getAnalyticsFlowsAggregatesJobResults(GetAnalyticsFlowsAggregatesJobResultsRequest request)	Fetch a page of results for an async aggregates query
ApiResponse<FlowAsyncAggregateQueryResponse>	getAnalyticsFlowsAggregatesJobResults(ApiRequest<Void> request)	Fetch a page of results for an async aggregates query
FlowAsyncAggregateQueryResponse	getAnalyticsFlowsAggregatesJobResults(String jobId, String cursor)	Fetch a page of results for an async aggregates query
ApiResponse<FlowAsyncAggregateQueryResponse>	getAnalyticsFlowsAggregatesJobResultsWithHttpInfo(String jobId, String cursor)	Fetch a page of results for an async aggregates query
ApiResponse<AsyncQueryStatus>	getAnalyticsFlowsAggregatesJobWithHttpInfo(String jobId)	Get status for async query for Flow aggregates
FlowActivityResponse	postAnalyticsFlowsActivityQuery(PostAnalyticsFlowsActivityQueryRequest request)	Query for flow activity observations
ApiResponse<FlowActivityResponse>	postAnalyticsFlowsActivityQuery(ApiRequest<FlowActivityQuery> request)	Query for flow activity observations
FlowActivityResponse	postAnalyticsFlowsActivityQuery(FlowActivityQuery body, Integer pageSize, Integer pageNumber)	Query for flow activity observations
ApiResponse<FlowActivityResponse>	postAnalyticsFlowsActivityQueryWithHttpInfo(FlowActivityQuery body, Integer pageSize, Integer pageNumber)	Query for flow activity observations
AsyncQueryResponse	postAnalyticsFlowsAggregatesJobs(PostAnalyticsFlowsAggregatesJobsRequest request)	Query for flow aggregates asynchronously
ApiResponse<AsyncQueryResponse>	postAnalyticsFlowsAggregatesJobs(ApiRequest<FlowAsyncAggregationQuery> request)	Query for flow aggregates asynchronously
AsyncQueryResponse	postAnalyticsFlowsAggregatesJobs(FlowAsyncAggregationQuery body)	Query for flow aggregates asynchronously
ApiResponse<AsyncQueryResponse>	postAnalyticsFlowsAggregatesJobsWithHttpInfo(FlowAsyncAggregationQuery body)	Query for flow aggregates asynchronously
FlowAggregateQueryResponse	postAnalyticsFlowsAggregatesQuery(PostAnalyticsFlowsAggregatesQueryRequest request)	Query for flow aggregates
ApiResponse<FlowAggregateQueryResponse>	postAnalyticsFlowsAggregatesQuery(ApiRequest<FlowAggregationQuery> request)	Query for flow aggregates
FlowAggregateQueryResponse	postAnalyticsFlowsAggregatesQuery(FlowAggregationQuery body)	Query for flow aggregates
ApiResponse<FlowAggregateQueryResponse>	postAnalyticsFlowsAggregatesQueryWithHttpInfo(FlowAggregationQuery body)	Query for flow aggregates
FlowObservationQueryResponse	postAnalyticsFlowsObservationsQuery(PostAnalyticsFlowsObservationsQueryRequest request)	Query for flow observations
ApiResponse<FlowObservationQueryResponse>	postAnalyticsFlowsObservationsQuery(ApiRequest<FlowObservationQuery> request)	Query for flow observations
FlowObservationQueryResponse	postAnalyticsFlowsObservationsQuery(FlowObservationQuery body)	Query for flow observations
ApiResponse<FlowObservationQueryResponse>	postAnalyticsFlowsObservationsQueryWithHttpInfo(FlowObservationQuery body)	Query for flow observations

Methods inherited from class java.lang.Object

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

Constructor Details

FlowsApi

public FlowsApi()

FlowsApi

public FlowsApi(ApiClient apiClient)

Method Details

deleteAnalyticsFlowsAggregatesJob

public void deleteAnalyticsFlowsAggregatesJob(String jobId)
                                       throws IOException,
ApiException

Delete/cancel an async request for flow aggregates

Parameters:

jobId - jobId (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteAnalyticsFlowsAggregatesJobWithHttpInfo

public ApiResponse<Void> deleteAnalyticsFlowsAggregatesJobWithHttpInfo(String jobId)
                                                                throws IOException

Delete/cancel an async request for flow aggregates

Parameters:

jobId - jobId (required)

Throws:

IOException - if the request fails to be processed

deleteAnalyticsFlowsAggregatesJob

public void deleteAnalyticsFlowsAggregatesJob(DeleteAnalyticsFlowsAggregatesJobRequest request)
                                       throws IOException,
ApiException

Delete/cancel an async request for flow aggregates

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteAnalyticsFlowsAggregatesJob

public ApiResponse<Void> deleteAnalyticsFlowsAggregatesJob(ApiRequest<Void> request)
                                                    throws IOException

Delete/cancel an async request for flow aggregates

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getAnalyticsFlowsAggregatesJob

public AsyncQueryStatus getAnalyticsFlowsAggregatesJob(String jobId)
                                                throws IOException,
ApiException

Get status for async query for Flow aggregates

Parameters:

jobId - jobId (required)

Returns:

AsyncQueryStatus

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAnalyticsFlowsAggregatesJobWithHttpInfo

public ApiResponse<AsyncQueryStatus> getAnalyticsFlowsAggregatesJobWithHttpInfo(String jobId)
                                                                         throws IOException

Get status for async query for Flow aggregates

Parameters:

jobId - jobId (required)

Returns:

AsyncQueryStatus

Throws:

IOException - if the request fails to be processed

getAnalyticsFlowsAggregatesJob

public AsyncQueryStatus getAnalyticsFlowsAggregatesJob(GetAnalyticsFlowsAggregatesJobRequest request)
                                                throws IOException,
ApiException

Get status for async query for Flow aggregates

Parameters:

request - The request object

Returns:

AsyncQueryStatus

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAnalyticsFlowsAggregatesJob

public ApiResponse<AsyncQueryStatus> getAnalyticsFlowsAggregatesJob(ApiRequest<Void> request)
                                                             throws IOException

Get status for async query for Flow aggregates

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getAnalyticsFlowsAggregatesJobResults

public FlowAsyncAggregateQueryResponse getAnalyticsFlowsAggregatesJobResults(String jobId,
 String cursor)
                                                                      throws IOException,
ApiException

Fetch a page of results for an async aggregates query

Parameters:

jobId - jobId (required)

cursor - Cursor token to retrieve next page (optional)

Returns:

FlowAsyncAggregateQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAnalyticsFlowsAggregatesJobResultsWithHttpInfo

public ApiResponse<FlowAsyncAggregateQueryResponse> getAnalyticsFlowsAggregatesJobResultsWithHttpInfo(String jobId,
 String cursor)
                                                                                               throws IOException

Fetch a page of results for an async aggregates query

Parameters:

jobId - jobId (required)

cursor - Cursor token to retrieve next page (optional)

Returns:

FlowAsyncAggregateQueryResponse

Throws:

IOException - if the request fails to be processed

getAnalyticsFlowsAggregatesJobResults

public FlowAsyncAggregateQueryResponse getAnalyticsFlowsAggregatesJobResults(GetAnalyticsFlowsAggregatesJobResultsRequest request)
                                                                      throws IOException,
ApiException

Fetch a page of results for an async aggregates query

Parameters:

request - The request object

Returns:

FlowAsyncAggregateQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAnalyticsFlowsAggregatesJobResults

public ApiResponse<FlowAsyncAggregateQueryResponse> getAnalyticsFlowsAggregatesJobResults(ApiRequest<Void> request)
                                                                                   throws IOException

Fetch a page of results for an async aggregates query

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postAnalyticsFlowsActivityQuery

public FlowActivityResponse postAnalyticsFlowsActivityQuery(FlowActivityQuery body,
 Integer pageSize,
 Integer pageNumber)
                                                     throws IOException,
ApiException

Query for flow activity observations

Parameters:

body - query (required)

pageSize - The desired page size (optional)

pageNumber - The desired page number (optional)

Returns:

FlowActivityResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAnalyticsFlowsActivityQueryWithHttpInfo

public ApiResponse<FlowActivityResponse> postAnalyticsFlowsActivityQueryWithHttpInfo(FlowActivityQuery body,
 Integer pageSize,
 Integer pageNumber)
                                                                              throws IOException

Query for flow activity observations

Parameters:

body - query (required)

pageSize - The desired page size (optional)

pageNumber - The desired page number (optional)

Returns:

FlowActivityResponse

Throws:

IOException - if the request fails to be processed

postAnalyticsFlowsActivityQuery

public FlowActivityResponse postAnalyticsFlowsActivityQuery(PostAnalyticsFlowsActivityQueryRequest request)
                                                     throws IOException,
ApiException

Query for flow activity observations

Parameters:

request - The request object

Returns:

FlowActivityResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAnalyticsFlowsActivityQuery

public ApiResponse<FlowActivityResponse> postAnalyticsFlowsActivityQuery(ApiRequest<FlowActivityQuery> request)
                                                                  throws IOException

Query for flow activity observations

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postAnalyticsFlowsAggregatesJobs

public AsyncQueryResponse postAnalyticsFlowsAggregatesJobs(FlowAsyncAggregationQuery body)
                                                    throws IOException,
ApiException

Query for flow aggregates asynchronously

Parameters:

body - query (required)

Returns:

AsyncQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAnalyticsFlowsAggregatesJobsWithHttpInfo

public ApiResponse<AsyncQueryResponse> postAnalyticsFlowsAggregatesJobsWithHttpInfo(FlowAsyncAggregationQuery body)
                                                                             throws IOException

Query for flow aggregates asynchronously

Parameters:

body - query (required)

Returns:

AsyncQueryResponse

Throws:

IOException - if the request fails to be processed

postAnalyticsFlowsAggregatesJobs

public AsyncQueryResponse postAnalyticsFlowsAggregatesJobs(PostAnalyticsFlowsAggregatesJobsRequest request)
                                                    throws IOException,
ApiException

Query for flow aggregates asynchronously

Parameters:

request - The request object

Returns:

AsyncQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAnalyticsFlowsAggregatesJobs

public ApiResponse<AsyncQueryResponse> postAnalyticsFlowsAggregatesJobs(ApiRequest<FlowAsyncAggregationQuery> request)
                                                                 throws IOException

Query for flow aggregates asynchronously

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postAnalyticsFlowsAggregatesQuery

public FlowAggregateQueryResponse postAnalyticsFlowsAggregatesQuery(FlowAggregationQuery body)
                                                             throws IOException,
ApiException

Query for flow aggregates

Parameters:

body - query (required)

Returns:

FlowAggregateQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAnalyticsFlowsAggregatesQueryWithHttpInfo

public ApiResponse<FlowAggregateQueryResponse> postAnalyticsFlowsAggregatesQueryWithHttpInfo(FlowAggregationQuery body)
                                                                                      throws IOException

Query for flow aggregates

Parameters:

body - query (required)

Returns:

FlowAggregateQueryResponse

Throws:

IOException - if the request fails to be processed

postAnalyticsFlowsAggregatesQuery

public FlowAggregateQueryResponse postAnalyticsFlowsAggregatesQuery(PostAnalyticsFlowsAggregatesQueryRequest request)
                                                             throws IOException,
ApiException

Query for flow aggregates

Parameters:

request - The request object

Returns:

FlowAggregateQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAnalyticsFlowsAggregatesQuery

public ApiResponse<FlowAggregateQueryResponse> postAnalyticsFlowsAggregatesQuery(ApiRequest<FlowAggregationQuery> request)
                                                                          throws IOException

Query for flow aggregates

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postAnalyticsFlowsObservationsQuery

public FlowObservationQueryResponse postAnalyticsFlowsObservationsQuery(FlowObservationQuery body)
                                                                 throws IOException,
ApiException

Query for flow observations

Parameters:

body - query (required)

Returns:

FlowObservationQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAnalyticsFlowsObservationsQueryWithHttpInfo

public ApiResponse<FlowObservationQueryResponse> postAnalyticsFlowsObservationsQueryWithHttpInfo(FlowObservationQuery body)
                                                                                          throws IOException

Query for flow observations

Parameters:

body - query (required)

Returns:

FlowObservationQueryResponse

Throws:

IOException - if the request fails to be processed

postAnalyticsFlowsObservationsQuery

public FlowObservationQueryResponse postAnalyticsFlowsObservationsQuery(PostAnalyticsFlowsObservationsQueryRequest request)
                                                                 throws IOException,
ApiException

Query for flow observations

Parameters:

request - The request object

Returns:

FlowObservationQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAnalyticsFlowsObservationsQuery

public ApiResponse<FlowObservationQueryResponse> postAnalyticsFlowsObservationsQuery(ApiRequest<FlowObservationQuery> request)
                                                                              throws IOException

Query for flow observations

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed