Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* The Jira Cloud platform REST API
* Jira Cloud platform REST API documentation
*
* The version of the OpenAPI document: 1001.0.0-SNAPSHOT
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package software.tnb.jira.validation.generated.api;
import software.tnb.jira.validation.generated.ApiCallback;
import software.tnb.jira.validation.generated.ApiClient;
import software.tnb.jira.validation.generated.ApiException;
import software.tnb.jira.validation.generated.ApiResponse;
import software.tnb.jira.validation.generated.Configuration;
import software.tnb.jira.validation.generated.Pair;
import software.tnb.jira.validation.generated.ProgressRequestBody;
import software.tnb.jira.validation.generated.ProgressResponseBody;
import com.google.gson.reflect.TypeToken;
import java.io.IOException;
import software.tnb.jira.validation.generated.model.ScreenableTab;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class ScreenTabsApi {
private ApiClient localVarApiClient;
private int localHostIndex;
private String localCustomBaseUrl;
public ScreenTabsApi() {
this(Configuration.getDefaultApiClient());
}
public ScreenTabsApi(ApiClient apiClient) {
this.localVarApiClient = apiClient;
}
public ApiClient getApiClient() {
return localVarApiClient;
}
public void setApiClient(ApiClient apiClient) {
this.localVarApiClient = apiClient;
}
public int getHostIndex() {
return localHostIndex;
}
public void setHostIndex(int hostIndex) {
this.localHostIndex = hostIndex;
}
public String getCustomBaseUrl() {
return localCustomBaseUrl;
}
public void setCustomBaseUrl(String customBaseUrl) {
this.localCustomBaseUrl = customBaseUrl;
}
/**
* Build call for addScreenTab
* @param screenId The ID of the screen. (required)
* @param screenableTab (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Returned if the request is successful.
-
400
Returned if the request is invalid.
-
401
Returned if the authentication credentials are incorrect or missing.
-
403
Returned if the user does not have the necessary permission.
-
404
Returned if the screen is not found.
-
*/
public okhttp3.Call addScreenTabCall(Long screenId, ScreenableTab screenableTab, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = screenableTab;
// create path and map variables
String localVarPath = "/rest/api/3/screens/{screenId}/tabs"
.replace("{" + "screenId" + "}", localVarApiClient.escapeString(screenId.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "OAuth2", "basicAuth" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call addScreenTabValidateBeforeCall(Long screenId, ScreenableTab screenableTab, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'screenId' is set
if (screenId == null) {
throw new ApiException("Missing the required parameter 'screenId' when calling addScreenTab(Async)");
}
// verify the required parameter 'screenableTab' is set
if (screenableTab == null) {
throw new ApiException("Missing the required parameter 'screenableTab' when calling addScreenTab(Async)");
}
return addScreenTabCall(screenId, screenableTab, _callback);
}
/**
* Create screen tab
* Creates a tab for a screen. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param screenId The ID of the screen. (required)
* @param screenableTab (required)
* @return ScreenableTab
* @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
Returned if the request is successful.
-
400
Returned if the request is invalid.
-
401
Returned if the authentication credentials are incorrect or missing.
-
403
Returned if the user does not have the necessary permission.
-
404
Returned if the screen is not found.
-
*/
public ScreenableTab addScreenTab(Long screenId, ScreenableTab screenableTab) throws ApiException {
ApiResponse localVarResp = addScreenTabWithHttpInfo(screenId, screenableTab);
return localVarResp.getData();
}
/**
* Create screen tab
* Creates a tab for a screen. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param screenId The ID of the screen. (required)
* @param screenableTab (required)
* @return ApiResponse<ScreenableTab>
* @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
Returned if the request is successful.
-
400
Returned if the request is invalid.
-
401
Returned if the authentication credentials are incorrect or missing.
-
403
Returned if the user does not have the necessary permission.
-
404
Returned if the screen is not found.
-
*/
public ApiResponse addScreenTabWithHttpInfo(Long screenId, ScreenableTab screenableTab) throws ApiException {
okhttp3.Call localVarCall = addScreenTabValidateBeforeCall(screenId, screenableTab, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Create screen tab (asynchronously)
* Creates a tab for a screen. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param screenId The ID of the screen. (required)
* @param screenableTab (required)
* @param _callback The callback to be executed when the API call finishes
* @return 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
Returned if the request is successful.
-
400
Returned if the request is invalid.
-
401
Returned if the authentication credentials are incorrect or missing.
-
403
Returned if the user does not have the necessary permission.
-
404
Returned if the screen is not found.
-
*/
public okhttp3.Call addScreenTabAsync(Long screenId, ScreenableTab screenableTab, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = addScreenTabValidateBeforeCall(screenId, screenableTab, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for deleteScreenTab
* @param screenId The ID of the screen. (required)
* @param tabId The ID of the screen tab. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
204
Returned if the request is successful.
-
401
Returned if the authentication credentials are incorrect or missing.
-
403
Returned if the user does not have the necessary permission.
-
404
Returned if the screen or screen tab is not found.
-
*/
public okhttp3.Call deleteScreenTabCall(Long screenId, Long tabId, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/rest/api/3/screens/{screenId}/tabs/{tabId}"
.replace("{" + "screenId" + "}", localVarApiClient.escapeString(screenId.toString()))
.replace("{" + "tabId" + "}", localVarApiClient.escapeString(tabId.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "OAuth2", "basicAuth" };
return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call deleteScreenTabValidateBeforeCall(Long screenId, Long tabId, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'screenId' is set
if (screenId == null) {
throw new ApiException("Missing the required parameter 'screenId' when calling deleteScreenTab(Async)");
}
// verify the required parameter 'tabId' is set
if (tabId == null) {
throw new ApiException("Missing the required parameter 'tabId' when calling deleteScreenTab(Async)");
}
return deleteScreenTabCall(screenId, tabId, _callback);
}
/**
* Delete screen tab
* Deletes a screen tab. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param screenId The ID of the screen. (required)
* @param tabId The ID of the screen tab. (required)
* @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
204
Returned if the request is successful.
-
401
Returned if the authentication credentials are incorrect or missing.
-
403
Returned if the user does not have the necessary permission.
-
404
Returned if the screen or screen tab is not found.
-
*/
public void deleteScreenTab(Long screenId, Long tabId) throws ApiException {
deleteScreenTabWithHttpInfo(screenId, tabId);
}
/**
* Delete screen tab
* Deletes a screen tab. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param screenId The ID of the screen. (required)
* @param tabId The ID of the screen tab. (required)
* @return ApiResponse<Void>
* @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
204
Returned if the request is successful.
-
401
Returned if the authentication credentials are incorrect or missing.
-
403
Returned if the user does not have the necessary permission.
-
404
Returned if the screen or screen tab is not found.
-
*/
public ApiResponse deleteScreenTabWithHttpInfo(Long screenId, Long tabId) throws ApiException {
okhttp3.Call localVarCall = deleteScreenTabValidateBeforeCall(screenId, tabId, null);
return localVarApiClient.execute(localVarCall);
}
/**
* Delete screen tab (asynchronously)
* Deletes a screen tab. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param screenId The ID of the screen. (required)
* @param tabId The ID of the screen tab. (required)
* @param _callback The callback to be executed when the API call finishes
* @return 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
204
Returned if the request is successful.
-
401
Returned if the authentication credentials are incorrect or missing.
-
403
Returned if the user does not have the necessary permission.
-
404
Returned if the screen or screen tab is not found.
-
*/
public okhttp3.Call deleteScreenTabAsync(Long screenId, Long tabId, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = deleteScreenTabValidateBeforeCall(screenId, tabId, _callback);
localVarApiClient.executeAsync(localVarCall, _callback);
return localVarCall;
}
/**
* Build call for getAllScreenTabs
* @param screenId The ID of the screen. (required)
* @param projectKey The key of the project. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Returned if the request is successful.
-
400
Returned if the screen ID is invalid.
-
401
Returned if the authentication credentials are incorrect or missing.
-
403
Returned if the user does not have the necessary permission.
-
404
Returned if the screen is not found.
-
*/
public okhttp3.Call getAllScreenTabsCall(Long screenId, String projectKey, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/rest/api/3/screens/{screenId}/tabs"
.replace("{" + "screenId" + "}", localVarApiClient.escapeString(screenId.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (projectKey != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("projectKey", projectKey));
}
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "OAuth2", "basicAuth" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getAllScreenTabsValidateBeforeCall(Long screenId, String projectKey, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'screenId' is set
if (screenId == null) {
throw new ApiException("Missing the required parameter 'screenId' when calling getAllScreenTabs(Async)");
}
return getAllScreenTabsCall(screenId, projectKey, _callback);
}
/**
* Get all screen tabs
* Returns the list of tabs for a screen. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.
* @param screenId The ID of the screen. (required)
* @param projectKey The key of the project. (optional)
* @return List<ScreenableTab>
* @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
Returned if the request is successful.
-
400
Returned if the screen ID is invalid.
-
401
Returned if the authentication credentials are incorrect or missing.
-
403
Returned if the user does not have the necessary permission.
-
404
Returned if the screen is not found.
-
*/
public List getAllScreenTabs(Long screenId, String projectKey) throws ApiException {
ApiResponse> localVarResp = getAllScreenTabsWithHttpInfo(screenId, projectKey);
return localVarResp.getData();
}
/**
* Get all screen tabs
* Returns the list of tabs for a screen. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.
* @param screenId The ID of the screen. (required)
* @param projectKey The key of the project. (optional)
* @return ApiResponse<List<ScreenableTab>>
* @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
Returned if the request is successful.
-
400
Returned if the screen ID is invalid.
-
401
Returned if the authentication credentials are incorrect or missing.
-
403
Returned if the user does not have the necessary permission.
-
404
Returned if the screen is not found.
-
*/
public ApiResponse> getAllScreenTabsWithHttpInfo(Long screenId, String projectKey) throws ApiException {
okhttp3.Call localVarCall = getAllScreenTabsValidateBeforeCall(screenId, projectKey, null);
Type localVarReturnType = new TypeToken>(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Get all screen tabs (asynchronously)
* Returns the list of tabs for a screen. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.
* @param screenId The ID of the screen. (required)
* @param projectKey The key of the project. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return 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
Returned if the request is successful.
-
400
Returned if the screen ID is invalid.
-
401
Returned if the authentication credentials are incorrect or missing.
-
403
Returned if the user does not have the necessary permission.
-
404
Returned if the screen is not found.
-
*/
public okhttp3.Call getAllScreenTabsAsync(Long screenId, String projectKey, final ApiCallback> _callback) throws ApiException {
okhttp3.Call localVarCall = getAllScreenTabsValidateBeforeCall(screenId, projectKey, _callback);
Type localVarReturnType = new TypeToken>(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for moveScreenTab
* @param screenId The ID of the screen. (required)
* @param tabId The ID of the screen tab. (required)
* @param pos The position of tab. The base index is 0. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
204
Returned if the request is successful.
-
400
Returned if the request is invalid.
-
401
Returned if the authentication credentials are incorrect or missing.
-
403
Returned if the user does not have the necessary permission.
-
404
Returned if the screen or screen tab is not found or the position is invalid.
-
*/
public okhttp3.Call moveScreenTabCall(Long screenId, Long tabId, Integer pos, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/rest/api/3/screens/{screenId}/tabs/{tabId}/move/{pos}"
.replace("{" + "screenId" + "}", localVarApiClient.escapeString(screenId.toString()))
.replace("{" + "tabId" + "}", localVarApiClient.escapeString(tabId.toString()))
.replace("{" + "pos" + "}", localVarApiClient.escapeString(pos.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "OAuth2", "basicAuth" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call moveScreenTabValidateBeforeCall(Long screenId, Long tabId, Integer pos, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'screenId' is set
if (screenId == null) {
throw new ApiException("Missing the required parameter 'screenId' when calling moveScreenTab(Async)");
}
// verify the required parameter 'tabId' is set
if (tabId == null) {
throw new ApiException("Missing the required parameter 'tabId' when calling moveScreenTab(Async)");
}
// verify the required parameter 'pos' is set
if (pos == null) {
throw new ApiException("Missing the required parameter 'pos' when calling moveScreenTab(Async)");
}
return moveScreenTabCall(screenId, tabId, pos, _callback);
}
/**
* Move screen tab
* Moves a screen tab. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param screenId The ID of the screen. (required)
* @param tabId The ID of the screen tab. (required)
* @param pos The position of tab. The base index is 0. (required)
* @return 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
204
Returned if the request is successful.
-
400
Returned if the request is invalid.
-
401
Returned if the authentication credentials are incorrect or missing.
-
403
Returned if the user does not have the necessary permission.
-
404
Returned if the screen or screen tab is not found or the position is invalid.
-
*/
public Object moveScreenTab(Long screenId, Long tabId, Integer pos) throws ApiException {
ApiResponse
