• Home
• software.tnb
• system-x-jira
• 0.0.14
• source code
• ProjectVersionsApi.java

×

Project download

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.

software.tnb.jira.validation.generated.api.ProjectVersionsApi Maven / Gradle / Ivy

/*
 * 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.DeleteAndReplaceVersionBean;
import software.tnb.jira.validation.generated.model.PageBeanVersion;
import software.tnb.jira.validation.generated.model.Version;
import software.tnb.jira.validation.generated.model.VersionIssueCounts;
import software.tnb.jira.validation.generated.model.VersionMoveBean;
import software.tnb.jira.validation.generated.model.VersionUnresolvedIssuesCount;

import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class ProjectVersionsApi {
    private ApiClient localVarApiClient;
    private int localHostIndex;
    private String localCustomBaseUrl;

    public ProjectVersionsApi() {
        this(Configuration.getDefaultApiClient());
    }

    public ProjectVersionsApi(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 createVersion
     * @param version  (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 
        
 201 
 Returned if the request is successful. 
  -  
        
 400 
 Returned if the request is invalid. 
  -  
        
 401 
 Returned if the authentication credentials are incorrect or missing. 
  -  
        
 404 
 Returned if:   *  the project is not found.  *  the user does not have the required permissions. 
  -  
     
     */
    public okhttp3.Call createVersionCall(Version version, 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 = version;

        // create path and map variables
        String localVarPath = "/rest/api/3/version";

        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 createVersionValidateBeforeCall(Version version, final ApiCallback _callback) throws ApiException {
        // verify the required parameter 'version' is set
        if (version == null) {
            throw new ApiException("Missing the required parameter 'version' when calling createVersion(Async)");
        }

        return createVersionCall(version, _callback);

    }

    /**
     * Create version
     * Creates a project version.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project the version is added to.
     * @param version  (required)
     * @return Version
     * @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 
        
 201 
 Returned if the request is successful. 
  -  
        
 400 
 Returned if the request is invalid. 
  -  
        
 401 
 Returned if the authentication credentials are incorrect or missing. 
  -  
        
 404 
 Returned if:   *  the project is not found.  *  the user does not have the required permissions. 
  -  
     
     */
    public Version createVersion(Version version) throws ApiException {
        ApiResponse localVarResp = createVersionWithHttpInfo(version);
        return localVarResp.getData();
    }

    /**
     * Create version
     * Creates a project version.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project the version is added to.
     * @param version  (required)
     * @return ApiResponse<Version>
     * @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 
        
 201 
 Returned if the request is successful. 
  -  
        
 400 
 Returned if the request is invalid. 
  -  
        
 401 
 Returned if the authentication credentials are incorrect or missing. 
  -  
        
 404 
 Returned if:   *  the project is not found.  *  the user does not have the required permissions. 
  -  
     
     */
    public ApiResponse createVersionWithHttpInfo(Version version) throws ApiException {
        okhttp3.Call localVarCall = createVersionValidateBeforeCall(version, null);
        Type localVarReturnType = new TypeToken(){}.getType();
        return localVarApiClient.execute(localVarCall, localVarReturnType);
    }

    /**
     * Create version (asynchronously)
     * Creates a project version.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project the version is added to.
     * @param version  (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 
        
 201 
 Returned if the request is successful. 
  -  
        
 400 
 Returned if the request is invalid. 
  -  
        
 401 
 Returned if the authentication credentials are incorrect or missing. 
  -  
        
 404 
 Returned if:   *  the project is not found.  *  the user does not have the required permissions. 
  -  
     
     */
    public okhttp3.Call createVersionAsync(Version version, final ApiCallback _callback) throws ApiException {

        okhttp3.Call localVarCall = createVersionValidateBeforeCall(version, _callback);
        Type localVarReturnType = new TypeToken(){}.getType();
        localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
        return localVarCall;
    }
    /**
     * Build call for deleteAndReplaceVersion
     * @param id The ID of the version. (required)
     * @param deleteAndReplaceVersionBean  (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 version is deleted. 
  -  
        
 400 
 Returned if the request is invalid. 
  -  
        
 401 
 Returned if the authentication credentials are incorrect or missing. 
  -  
        
 404 
 Returned if:   *  the version to delete is not found.  *  the user does not have the required permissions. 
  -  
     
     */
    public okhttp3.Call deleteAndReplaceVersionCall(String id, DeleteAndReplaceVersionBean deleteAndReplaceVersionBean, 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 = deleteAndReplaceVersionBean;

        // create path and map variables
        String localVarPath = "/rest/api/3/version/{id}/removeAndSwap"
            .replace("{" + "id" + "}", localVarApiClient.escapeString(id.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 deleteAndReplaceVersionValidateBeforeCall(String id, DeleteAndReplaceVersionBean deleteAndReplaceVersionBean, final ApiCallback _callback) throws ApiException {
        // verify the required parameter 'id' is set
        if (id == null) {
            throw new ApiException("Missing the required parameter 'id' when calling deleteAndReplaceVersion(Async)");
        }

        // verify the required parameter 'deleteAndReplaceVersionBean' is set
        if (deleteAndReplaceVersionBean == null) {
            throw new ApiException("Missing the required parameter 'deleteAndReplaceVersionBean' when calling deleteAndReplaceVersion(Async)");
        }

        return deleteAndReplaceVersionCall(id, deleteAndReplaceVersionBean, _callback);

    }

    /**
     * Delete and replace version
     * Deletes a project version.  Alternative versions can be provided to update issues that use the deleted version in `fixVersion`, `affectedVersion`, or any version picker custom fields. If alternatives are not provided, occurrences of `fixVersion`, `affectedVersion`, and any version picker custom field, that contain the deleted version, are cleared. Any replacement version must be in the same project as the version being deleted and cannot be the version being deleted.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that contains the version.
     * @param id The ID of the version. (required)
     * @param deleteAndReplaceVersionBean  (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 version is deleted. 
  -  
        
 400 
 Returned if the request is invalid. 
  -  
        
 401 
 Returned if the authentication credentials are incorrect or missing. 
  -  
        
 404 
 Returned if:   *  the version to delete is not found.  *  the user does not have the required permissions. 
  -  
     
     */
    public Object deleteAndReplaceVersion(String id, DeleteAndReplaceVersionBean deleteAndReplaceVersionBean) throws ApiException {
        ApiResponse