org.bonitasoft.web.client.api.UploadApi Maven / Gradle / Ivy

Go to download
/** 
 * Copyright (C) 2023 BonitaSoft S.A.
 * BonitaSoft, 32 rue Gustave Eiffel - 38000 Grenoble
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2.0 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see .
 */
package org.bonitasoft.web.client.api;

import java.io.File;

import org.bonitasoft.web.client.invoker.ApiClient;
import org.bonitasoft.web.client.model.ApiResponse;

import feign.*;

@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public interface UploadApi extends ApiClient.Api {

    /**
     * Upload a living application
     * Upload application
     * 
     * @param file (optional)
     * @return String
     */
    @RequestLine("POST /portal/applicationsUpload")
    @Headers({
            "Content-Type: multipart/form-data",
            "Accept: application/json",
    })
    String uploadApplication(@Param("file") File file);

    /**
     * Upload a living application
     * Similar to uploadApplication but it also returns the http response headers .
     * Upload application
     * 
     * @param file (optional)
     * @return A ApiResponse that wraps the response boyd and the http headers.
     */
    @RequestLine("POST /portal/applicationsUpload")
    @Headers({
            "Content-Type: multipart/form-data",
            "Accept: application/json",
    })
    ApiResponse uploadApplicationWithHttpInfo(@Param("file") File file);

    /**
     * Upload a BDM Access Control
     * ![edition](https://img.shields.io/badge/edition-entreprise-blue) Upload BDM Access Control
     * 
     * @param file (optional)
     * @return String
     */
    @RequestLine("POST /portal/bdmAccessControlUpload")
    @Headers({
            "Content-Type: multipart/form-data",
            "Accept: application/json",
    })
    String uploadBDMAccessControl(@Param("file") File file);

    /**
     * Upload a BDM Access Control
     * Similar to uploadBDMAccessControl but it also returns the http response headers .
     * ![edition](https://img.shields.io/badge/edition-entreprise-blue) Upload BDM Access Control
     * 
     * @param file (optional)
     * @return A ApiResponse that wraps the response boyd and the http headers.
     */
    @RequestLine("POST /portal/bdmAccessControlUpload")
    @Headers({
            "Content-Type: multipart/form-data",
            "Accept: application/json",
    })
    ApiResponse uploadBDMAccessControlWithHttpInfo(@Param("file") File file);

    /**
     * Upload a file
     * Upload file. **NOTE:** If this file is a BDM zip, to do this, your tenant services need to be paused. In Enterprise editions, if you have an access control
     * file installed on your tenant, you need to delete it before installing or updating your BDM.
     * 
     * @param file (optional)
     * @return String
     */
    @RequestLine("POST /portal/fileUpload")
    @Headers({
            "Content-Type: multipart/form-data",
            "Accept: application/json",
    })
    String uploadFile(@Param("file") File file);

    /**
     * Upload a file
     * Similar to uploadFile but it also returns the http response headers .
     * Upload file. **NOTE:** If this file is a BDM zip, to do this, your tenant services need to be paused. In Enterprise editions, if you have an access control
     * file installed on your tenant, you need to delete it before installing or updating your BDM.
     * 
     * @param file (optional)
     * @return A ApiResponse that wraps the response boyd and the http headers.
     */
    @RequestLine("POST /portal/fileUpload")
    @Headers({
            "Content-Type: multipart/form-data",
            "Accept: application/json",
    })
    ApiResponse uploadFileWithHttpInfo(@Param("file") File file);

    /**
     * Import an organization
     * Upload organization
     * 
     * @param file (optional)
     * @return String
     */
    @RequestLine("POST /portal/organizationUpload")
    @Headers({
            "Content-Type: multipart/form-data",
            "Accept: application/json",
    })
    String uploadOrganization(@Param("file") File file);

    /**
     * Import an organization
     * Similar to uploadOrganization but it also returns the http response headers .
     * Upload organization
     * 
     * @param file (optional)
     * @return A ApiResponse that wraps the response boyd and the http headers.
     */
    @RequestLine("POST /portal/organizationUpload")
    @Headers({
            "Content-Type: multipart/form-data",
            "Accept: application/json",
    })
    ApiResponse uploadOrganizationWithHttpInfo(@Param("file") File file);

    /**
     * Upload a Page
     * Upload Page
     * 
     * @param file (optional)
     * @return String
     */
    @RequestLine("POST /portal/pageUpload")
    @Headers({
            "Content-Type: multipart/form-data",
            "Accept: application/json",
    })
    String uploadPage(@Param("file") File file);

    /**
     * Upload a Page
     * Similar to uploadPage but it also returns the http response headers .
     * Upload Page
     * 
     * @param file (optional)
     * @return A ApiResponse that wraps the response boyd and the http headers.
     */
    @RequestLine("POST /portal/pageUpload")
    @Headers({
            "Content-Type: multipart/form-data",
            "Accept: application/json",
    })
    ApiResponse uploadPageWithHttpInfo(@Param("file") File file);

    /**
     * Upload a bar file
     * Upload a bar file
     * 
     * @param file (optional)
     * @return String
     */
    @RequestLine("POST /portal/processUpload")
    @Headers({
            "Content-Type: multipart/form-data",
            "Accept: application/json",
    })
    String uploadProcess(@Param("file") File file);

    /**
     * Upload a bar file
     * Similar to uploadProcess but it also returns the http response headers .
     * Upload a bar file
     * 
     * @param file (optional)
     * @return A ApiResponse that wraps the response boyd and the http headers.
     */
    @RequestLine("POST /portal/processUpload")
    @Headers({
            "Content-Type: multipart/form-data",
            "Accept: application/json",
    })
    ApiResponse uploadProcessWithHttpInfo(@Param("file") File file);

    /**
     * Upload profiles
     * Upload profiles
     * 
     * @param file (optional)
     * @return String
     */
    @RequestLine("POST /portal/profilesUpload")
    @Headers({
            "Content-Type: multipart/form-data",
            "Accept: application/json",
    })
    String uploadprofiles(@Param("file") File file);

    /**
     * Upload profiles
     * Similar to uploadprofiles but it also returns the http response headers .
     * Upload profiles
     * 
     * @param file (optional)
     * @return A ApiResponse that wraps the response boyd and the http headers.
     */
    @RequestLine("POST /portal/profilesUpload")
    @Headers({
            "Content-Type: multipart/form-data",
            "Accept: application/json",
    })
    ApiResponse uploadprofilesWithHttpInfo(@Param("file") File file);

}