Package com.mypurecloud.sdk.v2.api

Class AuditApi

java.lang.Object

com.mypurecloud.sdk.v2.api.AuditApi

public class AuditApi
extends Object

Constructor Summary

Constructors

Constructor	Description
AuditApi()
AuditApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
AuditQueryServiceMapping	getAuditsQueryRealtimeServicemapping()	Get service mapping information used in realtime audits.
AuditQueryServiceMapping	getAuditsQueryRealtimeServicemapping(GetAuditsQueryRealtimeServicemappingRequest request)	Get service mapping information used in realtime audits.
ApiResponse<AuditQueryServiceMapping>	getAuditsQueryRealtimeServicemapping(ApiRequest<Void> request)	Get service mapping information used in realtime audits.
ApiResponse<AuditQueryServiceMapping>	getAuditsQueryRealtimeServicemappingWithHttpInfo()	Get service mapping information used in realtime audits.
AuditQueryServiceMapping	getAuditsQueryServicemapping()	Get service mapping information used in audits.
AuditQueryServiceMapping	getAuditsQueryServicemapping(GetAuditsQueryServicemappingRequest request)	Get service mapping information used in audits.
ApiResponse<AuditQueryServiceMapping>	getAuditsQueryServicemapping(ApiRequest<Void> request)	Get service mapping information used in audits.
ApiResponse<AuditQueryServiceMapping>	getAuditsQueryServicemappingWithHttpInfo()	Get service mapping information used in audits.
AuditQueryExecutionStatusResponse	getAuditsQueryTransactionId(GetAuditsQueryTransactionIdRequest request)	Get status of audit query execution
ApiResponse<AuditQueryExecutionStatusResponse>	getAuditsQueryTransactionId(ApiRequest<Void> request)	Get status of audit query execution
AuditQueryExecutionStatusResponse	getAuditsQueryTransactionId(String transactionId)	Get status of audit query execution
AuditQueryExecutionResultsResponse	getAuditsQueryTransactionIdResults(GetAuditsQueryTransactionIdResultsRequest request)	Get results of audit query
ApiResponse<AuditQueryExecutionResultsResponse>	getAuditsQueryTransactionIdResults(ApiRequest<Void> request)	Get results of audit query
AuditQueryExecutionResultsResponse	getAuditsQueryTransactionIdResults(String transactionId, String cursor, Integer pageSize, List<String> expand, Boolean allowRedirect)	Get results of audit query
ApiResponse<AuditQueryExecutionResultsResponse>	getAuditsQueryTransactionIdResultsWithHttpInfo(String transactionId, String cursor, Integer pageSize, List<String> expand, Boolean allowRedirect)	Get results of audit query
ApiResponse<AuditQueryExecutionStatusResponse>	getAuditsQueryTransactionIdWithHttpInfo(String transactionId)	Get status of audit query execution
AuditQueryExecutionStatusResponse	postAuditsQuery(PostAuditsQueryRequest request)	Create audit query execution Use /api/v2/audits/query/servicemapping endpoint for a list of valid values
ApiResponse<AuditQueryExecutionStatusResponse>	postAuditsQuery(ApiRequest<AuditQueryRequest> request)	Create audit query execution Use /api/v2/audits/query/servicemapping endpoint for a list of valid values
AuditQueryExecutionStatusResponse	postAuditsQuery(AuditQueryRequest body)	Create audit query execution Use /api/v2/audits/query/servicemapping endpoint for a list of valid values
AuditRealtimeQueryResultsResponse	postAuditsQueryRealtime(PostAuditsQueryRealtimeRequest request)	This endpoint will only retrieve 14 days worth of audits for certain services.
ApiResponse<AuditRealtimeQueryResultsResponse>	postAuditsQueryRealtime(ApiRequest<AuditRealtimeQueryRequest> request)	This endpoint will only retrieve 14 days worth of audits for certain services.
AuditRealtimeQueryResultsResponse	postAuditsQueryRealtime(AuditRealtimeQueryRequest body, List<String> expand)	This endpoint will only retrieve 14 days worth of audits for certain services.
AuditRealtimeRelatedResultsResponse	postAuditsQueryRealtimeRelated(PostAuditsQueryRealtimeRelatedRequest request)	Often a single action results in multiple audits.
ApiResponse<AuditRealtimeRelatedResultsResponse>	postAuditsQueryRealtimeRelated(ApiRequest<AuditRealtimeRelatedRequest> request)	Often a single action results in multiple audits.
AuditRealtimeRelatedResultsResponse	postAuditsQueryRealtimeRelated(AuditRealtimeRelatedRequest body, List<String> expand)	Often a single action results in multiple audits.
ApiResponse<AuditRealtimeRelatedResultsResponse>	postAuditsQueryRealtimeRelatedWithHttpInfo(AuditRealtimeRelatedRequest body, List<String> expand)	Often a single action results in multiple audits.
ApiResponse<AuditRealtimeQueryResultsResponse>	postAuditsQueryRealtimeWithHttpInfo(AuditRealtimeQueryRequest body, List<String> expand)	This endpoint will only retrieve 14 days worth of audits for certain services.
ApiResponse<AuditQueryExecutionStatusResponse>	postAuditsQueryWithHttpInfo(AuditQueryRequest body)	Create audit query execution Use /api/v2/audits/query/servicemapping endpoint for a list of valid values

Methods inherited from class java.lang.Object

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

Constructor Details

AuditApi

public AuditApi()

AuditApi

public AuditApi(ApiClient apiClient)

Method Details

getAuditsQueryRealtimeServicemapping

public AuditQueryServiceMapping getAuditsQueryRealtimeServicemapping()
                                                              throws IOException,
ApiException

Get service mapping information used in realtime audits.

Returns:

AuditQueryServiceMapping

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAuditsQueryRealtimeServicemappingWithHttpInfo

public ApiResponse<AuditQueryServiceMapping> getAuditsQueryRealtimeServicemappingWithHttpInfo()
                                                                                       throws IOException

Get service mapping information used in realtime audits.

Returns:

AuditQueryServiceMapping

Throws:

IOException - if the request fails to be processed

getAuditsQueryRealtimeServicemapping

public AuditQueryServiceMapping getAuditsQueryRealtimeServicemapping(GetAuditsQueryRealtimeServicemappingRequest request)
                                                              throws IOException,
ApiException

Get service mapping information used in realtime audits.

Parameters:

request - The request object

Returns:

AuditQueryServiceMapping

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAuditsQueryRealtimeServicemapping

public ApiResponse<AuditQueryServiceMapping> getAuditsQueryRealtimeServicemapping(ApiRequest<Void> request)
                                                                           throws IOException

Get service mapping information used in realtime audits.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getAuditsQueryServicemapping

public AuditQueryServiceMapping getAuditsQueryServicemapping()
                                                      throws IOException,
ApiException

Get service mapping information used in audits.

Returns:

AuditQueryServiceMapping

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAuditsQueryServicemappingWithHttpInfo

public ApiResponse<AuditQueryServiceMapping> getAuditsQueryServicemappingWithHttpInfo()
                                                                               throws IOException

Get service mapping information used in audits.

Returns:

AuditQueryServiceMapping

Throws:

IOException - if the request fails to be processed

getAuditsQueryServicemapping

public AuditQueryServiceMapping getAuditsQueryServicemapping(GetAuditsQueryServicemappingRequest request)
                                                      throws IOException,
ApiException

Get service mapping information used in audits.

Parameters:

request - The request object

Returns:

AuditQueryServiceMapping

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAuditsQueryServicemapping

public ApiResponse<AuditQueryServiceMapping> getAuditsQueryServicemapping(ApiRequest<Void> request)
                                                                   throws IOException

Get service mapping information used in audits.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getAuditsQueryTransactionId

public AuditQueryExecutionStatusResponse getAuditsQueryTransactionId(String transactionId)
                                                              throws IOException,
ApiException

Get status of audit query execution

Parameters:

transactionId - Transaction ID (required)

Returns:

AuditQueryExecutionStatusResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAuditsQueryTransactionIdWithHttpInfo

public ApiResponse<AuditQueryExecutionStatusResponse> getAuditsQueryTransactionIdWithHttpInfo(String transactionId)
                                                                                       throws IOException

Get status of audit query execution

Parameters:

transactionId - Transaction ID (required)

Returns:

AuditQueryExecutionStatusResponse

Throws:

IOException - if the request fails to be processed

getAuditsQueryTransactionId

public AuditQueryExecutionStatusResponse getAuditsQueryTransactionId(GetAuditsQueryTransactionIdRequest request)
                                                              throws IOException,
ApiException

Get status of audit query execution

Parameters:

request - The request object

Returns:

AuditQueryExecutionStatusResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAuditsQueryTransactionId

public ApiResponse<AuditQueryExecutionStatusResponse> getAuditsQueryTransactionId(ApiRequest<Void> request)
                                                                           throws IOException

Get status of audit query execution

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getAuditsQueryTransactionIdResults

public AuditQueryExecutionResultsResponse getAuditsQueryTransactionIdResults(String transactionId,
 String cursor,
 Integer pageSize,
 List<String> expand,
 Boolean allowRedirect)
                                                                      throws IOException,
ApiException

Get results of audit query

Parameters:

transactionId - Transaction ID (required)

cursor - Indicates where to resume query results (not required for first page) (optional)

pageSize - Indicates maximum number of results in response. Default page size is 25 results. The maximum page size is 500. (optional, default to 25)

expand - Which fields, if any, to expand (optional)

allowRedirect - Result sets with large amounts of data will respond with a download url (optional)

Returns:

AuditQueryExecutionResultsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAuditsQueryTransactionIdResultsWithHttpInfo

public ApiResponse<AuditQueryExecutionResultsResponse> getAuditsQueryTransactionIdResultsWithHttpInfo(String transactionId,
 String cursor,
 Integer pageSize,
 List<String> expand,
 Boolean allowRedirect)
                                                                                               throws IOException

Get results of audit query

Parameters:

transactionId - Transaction ID (required)

cursor - Indicates where to resume query results (not required for first page) (optional)

pageSize - Indicates maximum number of results in response. Default page size is 25 results. The maximum page size is 500. (optional, default to 25)

expand - Which fields, if any, to expand (optional)

allowRedirect - Result sets with large amounts of data will respond with a download url (optional)

Returns:

AuditQueryExecutionResultsResponse

Throws:

IOException - if the request fails to be processed

getAuditsQueryTransactionIdResults

public AuditQueryExecutionResultsResponse getAuditsQueryTransactionIdResults(GetAuditsQueryTransactionIdResultsRequest request)
                                                                      throws IOException,
ApiException

Get results of audit query

Parameters:

request - The request object

Returns:

AuditQueryExecutionResultsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAuditsQueryTransactionIdResults

public ApiResponse<AuditQueryExecutionResultsResponse> getAuditsQueryTransactionIdResults(ApiRequest<Void> request)
                                                                                   throws IOException

Get results of audit query

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postAuditsQuery

public AuditQueryExecutionStatusResponse postAuditsQuery(AuditQueryRequest body)
                                                  throws IOException,
ApiException

Create audit query execution Use /api/v2/audits/query/servicemapping endpoint for a list of valid values

Parameters:

body - query (required)

Returns:

AuditQueryExecutionStatusResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAuditsQueryWithHttpInfo

public ApiResponse<AuditQueryExecutionStatusResponse> postAuditsQueryWithHttpInfo(AuditQueryRequest body)
                                                                           throws IOException

Create audit query execution Use /api/v2/audits/query/servicemapping endpoint for a list of valid values

Parameters:

body - query (required)

Returns:

AuditQueryExecutionStatusResponse

Throws:

IOException - if the request fails to be processed

postAuditsQuery

public AuditQueryExecutionStatusResponse postAuditsQuery(PostAuditsQueryRequest request)
                                                  throws IOException,
ApiException

Create audit query execution Use /api/v2/audits/query/servicemapping endpoint for a list of valid values

Parameters:

request - The request object

Returns:

AuditQueryExecutionStatusResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAuditsQuery

public ApiResponse<AuditQueryExecutionStatusResponse> postAuditsQuery(ApiRequest<AuditQueryRequest> request)
                                                               throws IOException

Create audit query execution Use /api/v2/audits/query/servicemapping endpoint for a list of valid values

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postAuditsQueryRealtime

public AuditRealtimeQueryResultsResponse postAuditsQueryRealtime(AuditRealtimeQueryRequest body,
 List<String> expand)
                                                          throws IOException,
ApiException

This endpoint will only retrieve 14 days worth of audits for certain services. Please use /query to get a full list and older audits. Use /api/v2/audits/query/realtime/servicemapping endpoint for a list of valid values

Parameters:

body - query (required)

expand - Which fields, if any, to expand (optional)

Returns:

AuditRealtimeQueryResultsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAuditsQueryRealtimeWithHttpInfo

public ApiResponse<AuditRealtimeQueryResultsResponse> postAuditsQueryRealtimeWithHttpInfo(AuditRealtimeQueryRequest body,
 List<String> expand)
                                                                                   throws IOException

This endpoint will only retrieve 14 days worth of audits for certain services. Please use /query to get a full list and older audits. Use /api/v2/audits/query/realtime/servicemapping endpoint for a list of valid values

Parameters:

body - query (required)

expand - Which fields, if any, to expand (optional)

Returns:

AuditRealtimeQueryResultsResponse

Throws:

IOException - if the request fails to be processed

postAuditsQueryRealtime

public AuditRealtimeQueryResultsResponse postAuditsQueryRealtime(PostAuditsQueryRealtimeRequest request)
                                                          throws IOException,
ApiException

This endpoint will only retrieve 14 days worth of audits for certain services. Please use /query to get a full list and older audits. Use /api/v2/audits/query/realtime/servicemapping endpoint for a list of valid values

Parameters:

request - The request object

Returns:

AuditRealtimeQueryResultsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAuditsQueryRealtime

public ApiResponse<AuditRealtimeQueryResultsResponse> postAuditsQueryRealtime(ApiRequest<AuditRealtimeQueryRequest> request)
                                                                       throws IOException

This endpoint will only retrieve 14 days worth of audits for certain services. Please use /query to get a full list and older audits. Use /api/v2/audits/query/realtime/servicemapping endpoint for a list of valid values

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postAuditsQueryRealtimeRelated

public AuditRealtimeRelatedResultsResponse postAuditsQueryRealtimeRelated(AuditRealtimeRelatedRequest body,
 List<String> expand)
                                                                   throws IOException,
ApiException

Often a single action results in multiple audits. The endpoint retrieves all audits created by the same action as the given audit id.

Parameters:

body - query (required)

expand - Which fields, if any, to expand (optional)

Returns:

AuditRealtimeRelatedResultsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAuditsQueryRealtimeRelatedWithHttpInfo

public ApiResponse<AuditRealtimeRelatedResultsResponse> postAuditsQueryRealtimeRelatedWithHttpInfo(AuditRealtimeRelatedRequest body,
 List<String> expand)
                                                                                            throws IOException

Often a single action results in multiple audits. The endpoint retrieves all audits created by the same action as the given audit id.

Parameters:

body - query (required)

expand - Which fields, if any, to expand (optional)

Returns:

AuditRealtimeRelatedResultsResponse

Throws:

IOException - if the request fails to be processed

postAuditsQueryRealtimeRelated

public AuditRealtimeRelatedResultsResponse postAuditsQueryRealtimeRelated(PostAuditsQueryRealtimeRelatedRequest request)
                                                                   throws IOException,
ApiException

Often a single action results in multiple audits. The endpoint retrieves all audits created by the same action as the given audit id.

Parameters:

request - The request object

Returns:

AuditRealtimeRelatedResultsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAuditsQueryRealtimeRelated

public ApiResponse<AuditRealtimeRelatedResultsResponse> postAuditsQueryRealtimeRelated(ApiRequest<AuditRealtimeRelatedRequest> request)
                                                                                throws IOException

Often a single action results in multiple audits. The endpoint retrieves all audits created by the same action as the given audit id.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed