io.qase.client.api

Class CustomFieldsApi

java.lang.Object

io.qase.client.api.CustomFieldsApi

public class CustomFieldsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
CustomFieldsApi()
CustomFieldsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
IdResponse	createCustomField(CustomFieldCreate customFieldCreate) Create new Custom Field.
okhttp3.Call	createCustomFieldAsync(CustomFieldCreate customFieldCreate, ApiCallback<IdResponse> _callback) Create new Custom Field.
okhttp3.Call	createCustomFieldCall(CustomFieldCreate customFieldCreate, ApiCallback _callback) Build call for createCustomField
ApiResponse<IdResponse>	createCustomFieldWithHttpInfo(CustomFieldCreate customFieldCreate) Create new Custom Field.
Response	deleteCustomField(Integer id) Delete Custom Field by id.
okhttp3.Call	deleteCustomFieldAsync(Integer id, ApiCallback<Response> _callback) Delete Custom Field by id.
okhttp3.Call	deleteCustomFieldCall(Integer id, ApiCallback _callback) Build call for deleteCustomField
ApiResponse<Response>	deleteCustomFieldWithHttpInfo(Integer id) Delete Custom Field by id.
ApiClient	getApiClient()
String	getCustomBaseUrl()
CustomFieldResponse	getCustomField(Integer id) Get Custom Field by id.
okhttp3.Call	getCustomFieldAsync(Integer id, ApiCallback<CustomFieldResponse> _callback) Get Custom Field by id.
okhttp3.Call	getCustomFieldCall(Integer id, ApiCallback _callback) Build call for getCustomField
CustomFieldsResponse	getCustomFields(GetCustomFieldsFiltersParameter filters, Integer limit, Integer offset) Get all Custom Fields.
okhttp3.Call	getCustomFieldsAsync(GetCustomFieldsFiltersParameter filters, Integer limit, Integer offset, ApiCallback<CustomFieldsResponse> _callback) Get all Custom Fields.
okhttp3.Call	getCustomFieldsCall(GetCustomFieldsFiltersParameter filters, Integer limit, Integer offset, ApiCallback _callback) Build call for getCustomFields
ApiResponse<CustomFieldsResponse>	getCustomFieldsWithHttpInfo(GetCustomFieldsFiltersParameter filters, Integer limit, Integer offset) Get all Custom Fields.
ApiResponse<CustomFieldResponse>	getCustomFieldWithHttpInfo(Integer id) Get Custom Field by id.
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
Response	updateCustomField(Integer id, CustomFieldUpdate customFieldUpdate) Update Custom Field by id.
okhttp3.Call	updateCustomFieldAsync(Integer id, CustomFieldUpdate customFieldUpdate, ApiCallback<Response> _callback) Update Custom Field by id.
okhttp3.Call	updateCustomFieldCall(Integer id, CustomFieldUpdate customFieldUpdate, ApiCallback _callback) Build call for updateCustomField
ApiResponse<Response>	updateCustomFieldWithHttpInfo(Integer id, CustomFieldUpdate customFieldUpdate) Update Custom Field by id.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomFieldsApi

public CustomFieldsApi()

CustomFieldsApi

public CustomFieldsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createCustomFieldCall

public okhttp3.Call createCustomFieldCall(CustomFieldCreate customFieldCreate,
                                          ApiCallback _callback)
                                   throws QaseException

Build call for createCustomField

Parameters:

customFieldCreate - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

createCustomField

public IdResponse createCustomField(CustomFieldCreate customFieldCreate)
                             throws QaseException

Create new Custom Field. This method allows to create custom field.

Parameters:

customFieldCreate - (required)

Returns:

IdResponse

Throws:

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

createCustomFieldWithHttpInfo

public ApiResponse<IdResponse> createCustomFieldWithHttpInfo(CustomFieldCreate customFieldCreate)
                                                      throws QaseException

Create new Custom Field. This method allows to create custom field.

Parameters:

customFieldCreate - (required)

Returns:

ApiResponse<IdResponse>

Throws:

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

createCustomFieldAsync

public okhttp3.Call createCustomFieldAsync(CustomFieldCreate customFieldCreate,
                                           ApiCallback<IdResponse> _callback)
                                    throws QaseException

Create new Custom Field. (asynchronously) This method allows to create custom field.

Parameters:

customFieldCreate - (required)

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

Returns:

The request call

Throws:

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

deleteCustomFieldCall

public okhttp3.Call deleteCustomFieldCall(Integer id,
                                          ApiCallback _callback)
                                   throws QaseException

Build call for deleteCustomField

Parameters:

id - Identifier. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

deleteCustomField

public Response deleteCustomField(Integer id)
                           throws QaseException

Delete Custom Field by id. This method allows to delete custom field.

Parameters:

id - Identifier. (required)

Returns:

Response

Throws:

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

deleteCustomFieldWithHttpInfo

public ApiResponse<Response> deleteCustomFieldWithHttpInfo(Integer id)
                                                    throws QaseException

Delete Custom Field by id. This method allows to delete custom field.

Parameters:

id - Identifier. (required)

Returns:

ApiResponse<Response>

Throws:

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

deleteCustomFieldAsync

public okhttp3.Call deleteCustomFieldAsync(Integer id,
                                           ApiCallback<Response> _callback)
                                    throws QaseException

Delete Custom Field by id. (asynchronously) This method allows to delete custom field.

Parameters:

id - Identifier. (required)

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

Returns:

The request call

Throws:

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

getCustomFieldCall

public okhttp3.Call getCustomFieldCall(Integer id,
                                       ApiCallback _callback)
                                throws QaseException

Build call for getCustomField

Parameters:

id - Identifier. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

getCustomField

public CustomFieldResponse getCustomField(Integer id)
                                   throws QaseException

Get Custom Field by id. This method allows to retrieve custom field.

Parameters:

id - Identifier. (required)

Returns:

CustomFieldResponse

Throws:

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

getCustomFieldWithHttpInfo

public ApiResponse<CustomFieldResponse> getCustomFieldWithHttpInfo(Integer id)
                                                            throws QaseException

Get Custom Field by id. This method allows to retrieve custom field.

Parameters:

id - Identifier. (required)

Returns:

ApiResponse<CustomFieldResponse>

Throws:

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

getCustomFieldAsync

public okhttp3.Call getCustomFieldAsync(Integer id,
                                        ApiCallback<CustomFieldResponse> _callback)
                                 throws QaseException

Get Custom Field by id. (asynchronously) This method allows to retrieve custom field.

Parameters:

id - Identifier. (required)

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

Returns:

The request call

Throws:

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

getCustomFieldsCall

public okhttp3.Call getCustomFieldsCall(GetCustomFieldsFiltersParameter filters,
                                        Integer limit,
                                        Integer offset,
                                        ApiCallback _callback)
                                 throws QaseException

Build call for getCustomFields

Parameters:

filters - (optional)

limit - A number of entities in result set. (optional, default to 10)

offset - How many entities should be skipped. (optional, default to 0)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

getCustomFields

public CustomFieldsResponse getCustomFields(GetCustomFieldsFiltersParameter filters,
                                            Integer limit,
                                            Integer offset)
                                     throws QaseException

Get all Custom Fields. This method allows to retrieve and filter custom fields.

Parameters:

filters - (optional)

limit - A number of entities in result set. (optional, default to 10)

offset - How many entities should be skipped. (optional, default to 0)

Returns:

CustomFieldsResponse

Throws:

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

getCustomFieldsWithHttpInfo

public ApiResponse<CustomFieldsResponse> getCustomFieldsWithHttpInfo(GetCustomFieldsFiltersParameter filters,
                                                                     Integer limit,
                                                                     Integer offset)
                                                              throws QaseException

Get all Custom Fields. This method allows to retrieve and filter custom fields.

Parameters:

filters - (optional)

limit - A number of entities in result set. (optional, default to 10)

offset - How many entities should be skipped. (optional, default to 0)

Returns:

ApiResponse<CustomFieldsResponse>

Throws:

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

getCustomFieldsAsync

public okhttp3.Call getCustomFieldsAsync(GetCustomFieldsFiltersParameter filters,
                                         Integer limit,
                                         Integer offset,
                                         ApiCallback<CustomFieldsResponse> _callback)
                                  throws QaseException

Get all Custom Fields. (asynchronously) This method allows to retrieve and filter custom fields.

Parameters:

filters - (optional)

limit - A number of entities in result set. (optional, default to 10)

offset - How many entities should be skipped. (optional, default to 0)

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

Returns:

The request call

Throws:

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

updateCustomFieldCall

public okhttp3.Call updateCustomFieldCall(Integer id,
                                          CustomFieldUpdate customFieldUpdate,
                                          ApiCallback _callback)
                                   throws QaseException

Build call for updateCustomField

Parameters:

id - Identifier. (required)

customFieldUpdate - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

updateCustomField

public Response updateCustomField(Integer id,
                                  CustomFieldUpdate customFieldUpdate)
                           throws QaseException

Update Custom Field by id. This method allows to update custom field.

Parameters:

id - Identifier. (required)

customFieldUpdate - (required)

Returns:

Response

Throws:

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

updateCustomFieldWithHttpInfo

public ApiResponse<Response> updateCustomFieldWithHttpInfo(Integer id,
                                                           CustomFieldUpdate customFieldUpdate)
                                                    throws QaseException

Update Custom Field by id. This method allows to update custom field.

Parameters:

id - Identifier. (required)

customFieldUpdate - (required)

Returns:

ApiResponse<Response>

Throws:

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

updateCustomFieldAsync

public okhttp3.Call updateCustomFieldAsync(Integer id,
                                           CustomFieldUpdate customFieldUpdate,
                                           ApiCallback<Response> _callback)
                                    throws QaseException

Update Custom Field by id. (asynchronously) This method allows to update custom field.

Parameters:

id - Identifier. (required)

customFieldUpdate - (required)

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

Returns:

The request call

Throws:

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