Package com.twitter.clientlib.api

Class GeneralApi

java.lang.Object

com.twitter.clientlib.api.ApiCommon

com.twitter.clientlib.api.GeneralApi

public class GeneralApi
extends ApiCommon

Field Summary

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

localVarApiClient

Constructor Summary

Constructors

Constructor	Description
GeneralApi()

Method Summary

Modifier and Type	Method	Description
Object	getOpenApiSpec()	Returns the open api spec document.
okhttp3.Call	getOpenApiSpecAsync(ApiCallback<Object> _callback)	Returns the open api spec document.
okhttp3.Call	getOpenApiSpecCall(ApiCallback _callback)	Build call for getOpenApiSpec
ApiResponse<Object>	getOpenApiSpecWithHttpInfo()	Returns the open api spec document.

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

isOAUth2AutoRefreshToken, reduceAuthNames, refreshToken, setClient

Methods inherited from class java.lang.Object

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

Constructor Detail

GeneralApi

public GeneralApi()

Method Detail

getOpenApiSpecCall

public okhttp3.Call getOpenApiSpecCall(ApiCallback _callback)
                                throws ApiException

Build call for getOpenApiSpec

Parameters:

_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	-

getOpenApiSpec

public Object getOpenApiSpec()
                      throws ApiException

Returns the open api spec document. Full open api spec in JSON format. (See https://github.com/OAI/OpenAPI-Specification/blob/master/README.md)

Returns:

Object

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	-

getOpenApiSpecWithHttpInfo

public ApiResponse<Object> getOpenApiSpecWithHttpInfo()
                                               throws ApiException

Returns the open api spec document. Full open api spec in JSON format. (See https://github.com/OAI/OpenAPI-Specification/blob/master/README.md)

Returns:

ApiResponse<Object>

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	-

getOpenApiSpecAsync

public okhttp3.Call getOpenApiSpecAsync(ApiCallback<Object> _callback)
                                 throws ApiException

Returns the open api spec document. (asynchronously) Full open api spec in JSON format. (See https://github.com/OAI/OpenAPI-Specification/blob/master/README.md)

Parameters:

_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	-