All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

Go to download

The newest version!
/*
 * 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.ContainerOfWorkflowSchemeAssociations;
import java.util.Set;
import software.tnb.jira.validation.generated.model.WorkflowSchemeProjectAssociation;

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

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

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

    public WorkflowSchemeProjectAssociationsApi(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 assignSchemeToProject
     * @param workflowSchemeProjectAssociation  (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 not valid.   -  

        
 401  Returned if the authentication credentials are incorrect or missing.   -  

        
 403  Returned if the user does not have the required permissions.   -  

        
 404  Returned if the workflow scheme or the project are not found.   -  

     

     */
    public okhttp3.Call assignSchemeToProjectCall(WorkflowSchemeProjectAssociation workflowSchemeProjectAssociation, 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 = workflowSchemeProjectAssociation;

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

        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, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
    }

    @SuppressWarnings("rawtypes")
    private okhttp3.Call assignSchemeToProjectValidateBeforeCall(WorkflowSchemeProjectAssociation workflowSchemeProjectAssociation, final ApiCallback _callback) throws ApiException {
        // verify the required parameter 'workflowSchemeProjectAssociation' is set
        if (workflowSchemeProjectAssociation == null) {
            throw new ApiException("Missing the required parameter 'workflowSchemeProjectAssociation' when calling assignSchemeToProject(Async)");
        }

        return assignSchemeToProjectCall(workflowSchemeProjectAssociation, _callback);

    }

    /**
     * Assign workflow scheme to project
     * Assigns a workflow scheme to a project. This operation is performed only when there are no issues in the project.  Workflow schemes can only be assigned to classic projects.  **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
     * @param workflowSchemeProjectAssociation  (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 not valid.   -  

        
 401  Returned if the authentication credentials are incorrect or missing.   -  

        
 403  Returned if the user does not have the required permissions.   -  

        
 404  Returned if the workflow scheme or the project are not found.   -  

     

     */
    public Object assignSchemeToProject(WorkflowSchemeProjectAssociation workflowSchemeProjectAssociation) throws ApiException {
        ApiResponse localVarResp = assignSchemeToProjectWithHttpInfo(workflowSchemeProjectAssociation);
        return localVarResp.getData();
    }

    /**
     * Assign workflow scheme to project
     * Assigns a workflow scheme to a project. This operation is performed only when there are no issues in the project.  Workflow schemes can only be assigned to classic projects.  **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
     * @param workflowSchemeProjectAssociation  (required)
     * @return 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 

        
 204  Returned if the request is successful.   -  

        
 400  Returned if the request is not valid.   -  

        
 401  Returned if the authentication credentials are incorrect or missing.   -  

        
 403  Returned if the user does not have the required permissions.   -  

        
 404  Returned if the workflow scheme or the project are not found.   -  

     

     */
    public ApiResponse assignSchemeToProjectWithHttpInfo(WorkflowSchemeProjectAssociation workflowSchemeProjectAssociation) throws ApiException {
        okhttp3.Call localVarCall = assignSchemeToProjectValidateBeforeCall(workflowSchemeProjectAssociation, null);
        Type localVarReturnType = new TypeToken(){}.getType();
        return localVarApiClient.execute(localVarCall, localVarReturnType);
    }

    /**
     * Assign workflow scheme to project (asynchronously)
     * Assigns a workflow scheme to a project. This operation is performed only when there are no issues in the project.  Workflow schemes can only be assigned to classic projects.  **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
     * @param workflowSchemeProjectAssociation  (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.   -  

        
 400  Returned if the request is not valid.   -  

        
 401  Returned if the authentication credentials are incorrect or missing.   -  

        
 403  Returned if the user does not have the required permissions.   -  

        
 404  Returned if the workflow scheme or the project are not found.   -  

     

     */
    public okhttp3.Call assignSchemeToProjectAsync(WorkflowSchemeProjectAssociation workflowSchemeProjectAssociation, final ApiCallback _callback) throws ApiException {

        okhttp3.Call localVarCall = assignSchemeToProjectValidateBeforeCall(workflowSchemeProjectAssociation, _callback);
        Type localVarReturnType = new TypeToken(){}.getType();
        localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
        return localVarCall;
    }
    /**
     * Build call for getWorkflowSchemeProjectAssociations
     * @param projectId The ID of a project to return the workflow schemes for. To include multiple projects, provide an ampersand-Jim: oneseparated list. For example, `projectId=10000&projectId=10001`. (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.   -  

     

     */
    public okhttp3.Call getWorkflowSchemeProjectAssociationsCall(Set projectId, 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/workflowscheme/project";

        List localVarQueryParams = new ArrayList();
        List localVarCollectionQueryParams = new ArrayList();
        Map localVarHeaderParams = new HashMap();
        Map localVarCookieParams = new HashMap();
        Map localVarFormParams = new HashMap();

        if (projectId != null) {
            localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "projectId", projectId));
        }

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

        return getWorkflowSchemeProjectAssociationsCall(projectId, _callback);

    }

    /**
     * Get workflow scheme project associations
     * Returns a list of the workflow schemes associated with a list of projects. Each returned workflow scheme includes a list of the requested projects associated with it. Any team-managed or non-existent projects in the request are ignored and no errors are returned.  If the project is associated with the `Default Workflow Scheme` no ID is returned. This is because the way the `Default Workflow Scheme` is stored means it has no ID.  **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
     * @param projectId The ID of a project to return the workflow schemes for. To include multiple projects, provide an ampersand-Jim: oneseparated list. For example, `projectId=10000&projectId=10001`. (required)
     * @return ContainerOfWorkflowSchemeAssociations
     * @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.   -  

     

     */
    public ContainerOfWorkflowSchemeAssociations getWorkflowSchemeProjectAssociations(Set projectId) throws ApiException {
        ApiResponse localVarResp = getWorkflowSchemeProjectAssociationsWithHttpInfo(projectId);
        return localVarResp.getData();
    }

    /**
     * Get workflow scheme project associations
     * Returns a list of the workflow schemes associated with a list of projects. Each returned workflow scheme includes a list of the requested projects associated with it. Any team-managed or non-existent projects in the request are ignored and no errors are returned.  If the project is associated with the `Default Workflow Scheme` no ID is returned. This is because the way the `Default Workflow Scheme` is stored means it has no ID.  **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
     * @param projectId The ID of a project to return the workflow schemes for. To include multiple projects, provide an ampersand-Jim: oneseparated list. For example, `projectId=10000&projectId=10001`. (required)
     * @return ApiResponse<ContainerOfWorkflowSchemeAssociations>
     * @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.   -  

     

     */
    public ApiResponse getWorkflowSchemeProjectAssociationsWithHttpInfo(Set projectId) throws ApiException {
        okhttp3.Call localVarCall = getWorkflowSchemeProjectAssociationsValidateBeforeCall(projectId, null);
        Type localVarReturnType = new TypeToken(){}.getType();
        return localVarApiClient.execute(localVarCall, localVarReturnType);
    }

    /**
     * Get workflow scheme project associations (asynchronously)
     * Returns a list of the workflow schemes associated with a list of projects. Each returned workflow scheme includes a list of the requested projects associated with it. Any team-managed or non-existent projects in the request are ignored and no errors are returned.  If the project is associated with the `Default Workflow Scheme` no ID is returned. This is because the way the `Default Workflow Scheme` is stored means it has no ID.  **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
     * @param projectId The ID of a project to return the workflow schemes for. To include multiple projects, provide an ampersand-Jim: oneseparated list. For example, `projectId=10000&projectId=10001`. (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.   -  

     

     */
    public okhttp3.Call getWorkflowSchemeProjectAssociationsAsync(Set projectId, final ApiCallback _callback) throws ApiException {

        okhttp3.Call localVarCall = getWorkflowSchemeProjectAssociationsValidateBeforeCall(projectId, _callback);
        Type localVarReturnType = new TypeToken(){}.getType();
        localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
        return localVarCall;
    }
}
 















© 2015 - 2024 Weber Informatics LLC | Privacy Policy