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

software.tnb.jira.validation.generated.api.UiModificationsAppsApi 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.CreateUiModificationDetails;
import software.tnb.jira.validation.generated.model.PageBeanUiModificationDetails;
import software.tnb.jira.validation.generated.model.UiModificationIdentifiers;
import software.tnb.jira.validation.generated.model.UpdateUiModificationDetails;

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

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

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

    public UiModificationsAppsApi(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 createUiModification
     * @param createUiModificationDetails Details of the UI modification. (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 UI modification is created.   -  

        
 400  Returned if the request is not valid.   -  

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

        
 403  Returned if the request is not from a Forge app.   -  

        
 404  Returned if a project or an issue type in the context are not found.   -  

     

     */
    public okhttp3.Call createUiModificationCall(CreateUiModificationDetails createUiModificationDetails, 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 = createUiModificationDetails;

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

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

        return createUiModificationCall(createUiModificationDetails, _callback);

    }

    /**
     * Create UI modification
     * Creates a UI modification. UI modification can only be created by Forge apps.  Each app can define up to 100 UI modifications. Each UI modification can define up to 1000 contexts.  **[Permissions](#permissions) required:**   *  *None* if the UI modification is created without contexts.  *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the UI modification is created with contexts.
     * @param createUiModificationDetails Details of the UI modification. (required)
     * @return UiModificationIdentifiers
     * @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 UI modification is created.   -  

        
 400  Returned if the request is not valid.   -  

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

        
 403  Returned if the request is not from a Forge app.   -  

        
 404  Returned if a project or an issue type in the context are not found.   -  

     

     */
    public UiModificationIdentifiers createUiModification(CreateUiModificationDetails createUiModificationDetails) throws ApiException {
        ApiResponse localVarResp = createUiModificationWithHttpInfo(createUiModificationDetails);
        return localVarResp.getData();
    }

    /**
     * Create UI modification
     * Creates a UI modification. UI modification can only be created by Forge apps.  Each app can define up to 100 UI modifications. Each UI modification can define up to 1000 contexts.  **[Permissions](#permissions) required:**   *  *None* if the UI modification is created without contexts.  *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the UI modification is created with contexts.
     * @param createUiModificationDetails Details of the UI modification. (required)
     * @return ApiResponse<UiModificationIdentifiers>
     * @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 UI modification is created.   -  

        
 400  Returned if the request is not valid.   -  

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

        
 403  Returned if the request is not from a Forge app.   -  

        
 404  Returned if a project or an issue type in the context are not found.   -  

     

     */
    public ApiResponse createUiModificationWithHttpInfo(CreateUiModificationDetails createUiModificationDetails) throws ApiException {
        okhttp3.Call localVarCall = createUiModificationValidateBeforeCall(createUiModificationDetails, null);
        Type localVarReturnType = new TypeToken(){}.getType();
        return localVarApiClient.execute(localVarCall, localVarReturnType);
    }

    /**
     * Create UI modification (asynchronously)
     * Creates a UI modification. UI modification can only be created by Forge apps.  Each app can define up to 100 UI modifications. Each UI modification can define up to 1000 contexts.  **[Permissions](#permissions) required:**   *  *None* if the UI modification is created without contexts.  *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the UI modification is created with contexts.
     * @param createUiModificationDetails Details of the UI modification. (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 UI modification is created.   -  

        
 400  Returned if the request is not valid.   -  

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

        
 403  Returned if the request is not from a Forge app.   -  

        
 404  Returned if a project or an issue type in the context are not found.   -  

     

     */
    public okhttp3.Call createUiModificationAsync(CreateUiModificationDetails createUiModificationDetails, final ApiCallback _callback) throws ApiException {

        okhttp3.Call localVarCall = createUiModificationValidateBeforeCall(createUiModificationDetails, _callback);
        Type localVarReturnType = new TypeToken(){}.getType();
        localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
        return localVarCall;
    }
    /**
     * Build call for deleteUiModification
     * @param uiModificationId The ID of the UI modification. (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 UI modification is deleted.   -  

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

        
 403  Returned if the request is not from a Forge app.   -  

        
 404  Returned if the UI modification is not found.   -  

     

     */
    public okhttp3.Call deleteUiModificationCall(String uiModificationId, 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/uiModifications/{uiModificationId}"
            .replace("{" + "uiModificationId" + "}", localVarApiClient.escapeString(uiModificationId.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, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
    }

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

        return deleteUiModificationCall(uiModificationId, _callback);

    }

    /**
     * Delete UI modification
     * Deletes a UI modification. All the contexts that belong to the UI modification are deleted too. UI modification can only be deleted by Forge apps.  **[Permissions](#permissions) required:** None.
     * @param uiModificationId The ID of the UI modification. (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 UI modification is deleted.   -  

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

        
 403  Returned if the request is not from a Forge app.   -  

        
 404  Returned if the UI modification is not found.   -  

     

     */
    public Object deleteUiModification(String uiModificationId) throws ApiException {
        ApiResponse localVarResp = deleteUiModificationWithHttpInfo(uiModificationId);
        return localVarResp.getData();
    }

    /**
     * Delete UI modification
     * Deletes a UI modification. All the contexts that belong to the UI modification are deleted too. UI modification can only be deleted by Forge apps.  **[Permissions](#permissions) required:** None.
     * @param uiModificationId The ID of the UI modification. (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 UI modification is deleted.   -  

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

        
 403  Returned if the request is not from a Forge app.   -  

        
 404  Returned if the UI modification is not found.   -  

     

     */
    public ApiResponse deleteUiModificationWithHttpInfo(String uiModificationId) throws ApiException {
        okhttp3.Call localVarCall = deleteUiModificationValidateBeforeCall(uiModificationId, null);
        Type localVarReturnType = new TypeToken(){}.getType();
        return localVarApiClient.execute(localVarCall, localVarReturnType);
    }

    /**
     * Delete UI modification (asynchronously)
     * Deletes a UI modification. All the contexts that belong to the UI modification are deleted too. UI modification can only be deleted by Forge apps.  **[Permissions](#permissions) required:** None.
     * @param uiModificationId The ID of the UI modification. (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 UI modification is deleted.   -  

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

        
 403  Returned if the request is not from a Forge app.   -  

        
 404  Returned if the UI modification is not found.   -  

     

     */
    public okhttp3.Call deleteUiModificationAsync(String uiModificationId, final ApiCallback _callback) throws ApiException {

        okhttp3.Call localVarCall = deleteUiModificationValidateBeforeCall(uiModificationId, _callback);
        Type localVarReturnType = new TypeToken(){}.getType();
        localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
        return localVarCall;
    }
    /**
     * Build call for getUiModifications
     * @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
     * @param maxResults The maximum number of items to return per page. (optional, default to 50)
     * @param expand Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:   *  `data` Returns UI modification data.  *  `contexts` Returns UI modification contexts. (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 request is not valid.   -  

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

        
 403  Returned if the request is not from a Forge app.   -  

     

     */
    public okhttp3.Call getUiModificationsCall(Long startAt, Integer maxResults, String expand, 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/uiModifications";

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

        if (startAt != null) {
            localVarQueryParams.addAll(localVarApiClient.parameterToPair("startAt", startAt));
        }

        if (maxResults != null) {
            localVarQueryParams.addAll(localVarApiClient.parameterToPair("maxResults", maxResults));
        }

        if (expand != null) {
            localVarQueryParams.addAll(localVarApiClient.parameterToPair("expand", expand));
        }

        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 getUiModificationsValidateBeforeCall(Long startAt, Integer maxResults, String expand, final ApiCallback _callback) throws ApiException {
        return getUiModificationsCall(startAt, maxResults, expand, _callback);

    }

    /**
     * Get UI modifications
     * Gets UI modifications. UI modifications can only be retrieved by Forge apps.  **[Permissions](#permissions) required:** None.
     * @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
     * @param maxResults The maximum number of items to return per page. (optional, default to 50)
     * @param expand Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:   *  `data` Returns UI modification data.  *  `contexts` Returns UI modification contexts. (optional)
     * @return PageBeanUiModificationDetails
     * @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 not valid.   -  

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

        
 403  Returned if the request is not from a Forge app.   -  

     

     */
    public PageBeanUiModificationDetails getUiModifications(Long startAt, Integer maxResults, String expand) throws ApiException {
        ApiResponse localVarResp = getUiModificationsWithHttpInfo(startAt, maxResults, expand);
        return localVarResp.getData();
    }

    /**
     * Get UI modifications
     * Gets UI modifications. UI modifications can only be retrieved by Forge apps.  **[Permissions](#permissions) required:** None.
     * @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
     * @param maxResults The maximum number of items to return per page. (optional, default to 50)
     * @param expand Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:   *  `data` Returns UI modification data.  *  `contexts` Returns UI modification contexts. (optional)
     * @return ApiResponse<PageBeanUiModificationDetails>
     * @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 not valid.   -  

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

        
 403  Returned if the request is not from a Forge app.   -  

     

     */
    public ApiResponse getUiModificationsWithHttpInfo(Long startAt, Integer maxResults, String expand) throws ApiException {
        okhttp3.Call localVarCall = getUiModificationsValidateBeforeCall(startAt, maxResults, expand, null);
        Type localVarReturnType = new TypeToken(){}.getType();
        return localVarApiClient.execute(localVarCall, localVarReturnType);
    }

    /**
     * Get UI modifications (asynchronously)
     * Gets UI modifications. UI modifications can only be retrieved by Forge apps.  **[Permissions](#permissions) required:** None.
     * @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
     * @param maxResults The maximum number of items to return per page. (optional, default to 50)
     * @param expand Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:   *  `data` Returns UI modification data.  *  `contexts` Returns UI modification contexts. (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 request is not valid.   -  

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

        
 403  Returned if the request is not from a Forge app.   -  

     

     */
    public okhttp3.Call getUiModificationsAsync(Long startAt, Integer maxResults, String expand, final ApiCallback _callback) throws ApiException {

        okhttp3.Call localVarCall = getUiModificationsValidateBeforeCall(startAt, maxResults, expand, _callback);
        Type localVarReturnType = new TypeToken(){}.getType();
        localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
        return localVarCall;
    }
    /**
     * Build call for updateUiModification
     * @param uiModificationId The ID of the UI modification. (required)
     * @param updateUiModificationDetails Details of the UI modification. (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 UI modification is updated.   -  

        
 400  Returned if the request is not valid.   -  

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

        
 403  Returned if the request is not from a Forge app.   -  

        
 404  Returned if the UI modification, a project or an issue type in the context are not found.   -  

     

     */
    public okhttp3.Call updateUiModificationCall(String uiModificationId, UpdateUiModificationDetails updateUiModificationDetails, 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 = updateUiModificationDetails;

        // create path and map variables
        String localVarPath = "/rest/api/3/uiModifications/{uiModificationId}"
            .replace("{" + "uiModificationId" + "}", localVarApiClient.escapeString(uiModificationId.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, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
    }

    @SuppressWarnings("rawtypes")
    private okhttp3.Call updateUiModificationValidateBeforeCall(String uiModificationId, UpdateUiModificationDetails updateUiModificationDetails, final ApiCallback _callback) throws ApiException {
        // verify the required parameter 'uiModificationId' is set
        if (uiModificationId == null) {
            throw new ApiException("Missing the required parameter 'uiModificationId' when calling updateUiModification(Async)");
        }

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

        return updateUiModificationCall(uiModificationId, updateUiModificationDetails, _callback);

    }

    /**
     * Update UI modification
     * Updates a UI modification. UI modification can only be updated by Forge apps.  Each UI modification can define up to 1000 contexts.  **[Permissions](#permissions) required:**   *  *None* if the UI modification is created without contexts.  *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the UI modification is created with contexts.
     * @param uiModificationId The ID of the UI modification. (required)
     * @param updateUiModificationDetails Details of the UI modification. (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 UI modification is updated.   -  

        
 400  Returned if the request is not valid.   -  

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

        
 403  Returned if the request is not from a Forge app.   -  

        
 404  Returned if the UI modification, a project or an issue type in the context are not found.   -  

     

     */
    public Object updateUiModification(String uiModificationId, UpdateUiModificationDetails updateUiModificationDetails) throws ApiException {
        ApiResponse localVarResp = updateUiModificationWithHttpInfo(uiModificationId, updateUiModificationDetails);
        return localVarResp.getData();
    }

    /**
     * Update UI modification
     * Updates a UI modification. UI modification can only be updated by Forge apps.  Each UI modification can define up to 1000 contexts.  **[Permissions](#permissions) required:**   *  *None* if the UI modification is created without contexts.  *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the UI modification is created with contexts.
     * @param uiModificationId The ID of the UI modification. (required)
     * @param updateUiModificationDetails Details of the UI modification. (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 UI modification is updated.   -  

        
 400  Returned if the request is not valid.   -  

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

        
 403  Returned if the request is not from a Forge app.   -  

        
 404  Returned if the UI modification, a project or an issue type in the context are not found.   -  

     

     */
    public ApiResponse updateUiModificationWithHttpInfo(String uiModificationId, UpdateUiModificationDetails updateUiModificationDetails) throws ApiException {
        okhttp3.Call localVarCall = updateUiModificationValidateBeforeCall(uiModificationId, updateUiModificationDetails, null);
        Type localVarReturnType = new TypeToken(){}.getType();
        return localVarApiClient.execute(localVarCall, localVarReturnType);
    }

    /**
     * Update UI modification (asynchronously)
     * Updates a UI modification. UI modification can only be updated by Forge apps.  Each UI modification can define up to 1000 contexts.  **[Permissions](#permissions) required:**   *  *None* if the UI modification is created without contexts.  *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the UI modification is created with contexts.
     * @param uiModificationId The ID of the UI modification. (required)
     * @param updateUiModificationDetails Details of the UI modification. (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 UI modification is updated.   -  

        
 400  Returned if the request is not valid.   -  

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

        
 403  Returned if the request is not from a Forge app.   -  

        
 404  Returned if the UI modification, a project or an issue type in the context are not found.   -  

     

     */
    public okhttp3.Call updateUiModificationAsync(String uiModificationId, UpdateUiModificationDetails updateUiModificationDetails, final ApiCallback _callback) throws ApiException {

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















© 2015 - 2024 Weber Informatics LLC | Privacy Policy