Package com.twitter.clientlib.api

Class ComplianceApi

java.lang.Object

com.twitter.clientlib.api.ApiCommon

com.twitter.clientlib.api.ComplianceApi

public class ComplianceApi
extends ApiCommon

Field Summary

Fields inherited from class com.twitter.clientlib.api.ApiCommon

localVarApiClient

Constructor Summary

Constructors

Constructor	Description
ComplianceApi()

Method Summary

Modifier and Type	Method	Description
SingleComplianceJobResponse	createBatchComplianceJob(CreateBatchComplianceJobRequest createBatchComplianceJobRequest)	Create compliance job Creates a compliance for the given job type
SingleComplianceJobResponse	createBatchComplianceJob(Integer retries, CreateBatchComplianceJobRequest createBatchComplianceJobRequest)	Calls the API using a retry mechanism to handle rate limits errors.
okhttp3.Call	createBatchComplianceJobAsync(CreateBatchComplianceJobRequest createBatchComplianceJobRequest, ApiCallback<SingleComplianceJobResponse> _callback)	Create compliance job (asynchronously) Creates a compliance for the given job type
okhttp3.Call	createBatchComplianceJobCall(CreateBatchComplianceJobRequest createBatchComplianceJobRequest, ApiCallback _callback)	Build call for createBatchComplianceJob
ApiResponse<SingleComplianceJobResponse>	createBatchComplianceJobWithHttpInfo(CreateBatchComplianceJobRequest createBatchComplianceJobRequest)	Create compliance job Creates a compliance for the given job type
SingleComplianceJobResponse	getBatchComplianceJob(Integer retries, String id)	Calls the API using a retry mechanism to handle rate limits errors.
SingleComplianceJobResponse	getBatchComplianceJob(String id)	Get compliance job Returns a single compliance job by ID
okhttp3.Call	getBatchComplianceJobAsync(String id, ApiCallback<SingleComplianceJobResponse> _callback)	Get compliance job (asynchronously) Returns a single compliance job by ID
okhttp3.Call	getBatchComplianceJobCall(String id, ApiCallback _callback)	Build call for getBatchComplianceJob
ApiResponse<SingleComplianceJobResponse>	getBatchComplianceJobWithHttpInfo(String id)	Get compliance job Returns a single compliance job by ID
MultiComplianceJobResponse	listBatchComplianceJobs(ComplianceJobType type, ComplianceJobStatus status)	List compliance jobs Returns recent compliance jobs for a given job type and optional job status
MultiComplianceJobResponse	listBatchComplianceJobs(Integer retries, ComplianceJobType type, ComplianceJobStatus status)	Calls the API using a retry mechanism to handle rate limits errors.
okhttp3.Call	listBatchComplianceJobsAsync(ComplianceJobType type, ComplianceJobStatus status, ApiCallback<MultiComplianceJobResponse> _callback)	List compliance jobs (asynchronously) Returns recent compliance jobs for a given job type and optional job status
okhttp3.Call	listBatchComplianceJobsCall(ComplianceJobType type, ComplianceJobStatus status, ApiCallback _callback)	Build call for listBatchComplianceJobs
ApiResponse<MultiComplianceJobResponse>	listBatchComplianceJobsWithHttpInfo(ComplianceJobType type, ComplianceJobStatus status)	List compliance jobs Returns recent compliance jobs for a given job type and optional job status

Methods inherited from class com.twitter.clientlib.api.ApiCommon

handleRateLimit, isOAUth2AutoRefreshToken, reduceAuthNames, refreshToken, setClient

Methods inherited from class java.lang.Object

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

Constructor Detail

ComplianceApi

public ComplianceApi()

Method Detail

createBatchComplianceJobCall

public okhttp3.Call createBatchComplianceJobCall(CreateBatchComplianceJobRequest createBatchComplianceJobRequest,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for createBatchComplianceJob

Parameters:

createBatchComplianceJobRequest - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

createBatchComplianceJob

public SingleComplianceJobResponse createBatchComplianceJob(CreateBatchComplianceJobRequest createBatchComplianceJobRequest)
                                                     throws ApiException

Create compliance job Creates a compliance for the given job type

Parameters:

createBatchComplianceJobRequest - (required)

Returns:

SingleComplianceJobResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

createBatchComplianceJob

public SingleComplianceJobResponse createBatchComplianceJob(Integer retries,
                                                            CreateBatchComplianceJobRequest createBatchComplianceJobRequest)
                                                     throws ApiException

Calls the API using a retry mechanism to handle rate limits errors.

Throws:

ApiException

createBatchComplianceJobWithHttpInfo

public ApiResponse<SingleComplianceJobResponse> createBatchComplianceJobWithHttpInfo(CreateBatchComplianceJobRequest createBatchComplianceJobRequest)
                                                                              throws ApiException

Create compliance job Creates a compliance for the given job type

Parameters:

createBatchComplianceJobRequest - (required)

Returns:

ApiResponse<SingleComplianceJobResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

createBatchComplianceJobAsync

public okhttp3.Call createBatchComplianceJobAsync(CreateBatchComplianceJobRequest createBatchComplianceJobRequest,
                                                  ApiCallback<SingleComplianceJobResponse> _callback)
                                           throws ApiException

Create compliance job (asynchronously) Creates a compliance for the given job type

Parameters:

createBatchComplianceJobRequest - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

getBatchComplianceJobCall

public okhttp3.Call getBatchComplianceJobCall(String id,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for getBatchComplianceJob

Parameters:

id - ID of the compliance job to retrieve. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

getBatchComplianceJob

public SingleComplianceJobResponse getBatchComplianceJob(String id)
                                                  throws ApiException

Get compliance job Returns a single compliance job by ID

Parameters:

id - ID of the compliance job to retrieve. (required)

Returns:

SingleComplianceJobResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

getBatchComplianceJob

public SingleComplianceJobResponse getBatchComplianceJob(Integer retries,
                                                         String id)
                                                  throws ApiException

Calls the API using a retry mechanism to handle rate limits errors.

Throws:

ApiException

getBatchComplianceJobWithHttpInfo

public ApiResponse<SingleComplianceJobResponse> getBatchComplianceJobWithHttpInfo(String id)
                                                                           throws ApiException

Get compliance job Returns a single compliance job by ID

Parameters:

id - ID of the compliance job to retrieve. (required)

Returns:

ApiResponse<SingleComplianceJobResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

getBatchComplianceJobAsync

public okhttp3.Call getBatchComplianceJobAsync(String id,
                                               ApiCallback<SingleComplianceJobResponse> _callback)
                                        throws ApiException

Get compliance job (asynchronously) Returns a single compliance job by ID

Parameters:

id - ID of the compliance job to retrieve. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listBatchComplianceJobsCall

public okhttp3.Call listBatchComplianceJobsCall(ComplianceJobType type,
                                                ComplianceJobStatus status,
                                                ApiCallback _callback)
                                         throws ApiException

Build call for listBatchComplianceJobs

Parameters:

type - Type of compliance job to list. (required)

status - Status of compliance job to list. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	List compliance jobs response	-
0	The request has failed.	-

listBatchComplianceJobs

public MultiComplianceJobResponse listBatchComplianceJobs(ComplianceJobType type,
                                                          ComplianceJobStatus status)
                                                   throws ApiException

List compliance jobs Returns recent compliance jobs for a given job type and optional job status

Parameters:

type - Type of compliance job to list. (required)

status - Status of compliance job to list. (optional)

Returns:

MultiComplianceJobResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	List compliance jobs response	-
0	The request has failed.	-

listBatchComplianceJobs

public MultiComplianceJobResponse listBatchComplianceJobs(Integer retries,
                                                          ComplianceJobType type,
                                                          ComplianceJobStatus status)
                                                   throws ApiException

Calls the API using a retry mechanism to handle rate limits errors.

Throws:

ApiException

listBatchComplianceJobsWithHttpInfo

public ApiResponse<MultiComplianceJobResponse> listBatchComplianceJobsWithHttpInfo(ComplianceJobType type,
                                                                                   ComplianceJobStatus status)
                                                                            throws ApiException

List compliance jobs Returns recent compliance jobs for a given job type and optional job status

Parameters:

type - Type of compliance job to list. (required)

status - Status of compliance job to list. (optional)

Returns:

ApiResponse<MultiComplianceJobResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	List compliance jobs response	-
0	The request has failed.	-

listBatchComplianceJobsAsync

public okhttp3.Call listBatchComplianceJobsAsync(ComplianceJobType type,
                                                 ComplianceJobStatus status,
                                                 ApiCallback<MultiComplianceJobResponse> _callback)
                                          throws ApiException

List compliance jobs (asynchronously) Returns recent compliance jobs for a given job type and optional job status

Parameters:

type - Type of compliance job to list. (required)

status - Status of compliance job to list. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	List compliance jobs response	-
0	The request has failed.	-