/** * Cloud API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { AxiosPromise, AxiosInstance } from 'axios'; import { Configuration } from '../configuration'; import { RequestArgs, BaseAPI } from '../base'; import { CreateProjectDto } from '../models'; import { ImportScriptDto } from '../models'; import { InvitationsPageDto } from '../models'; import { ProjectDto } from '../models'; import { ProjectPageDto } from '../models'; import { ProjectUserPageDto } from '../models'; import { UpdateProjectDto } from '../models'; /** * ProjectsApi - axios parameter creator * @export */ export declare const ProjectsApiAxiosParamCreator: (axiosClientConfiguration?: Configuration) => { /** * * @summary Create project * @param {CreateProjectDto} createProject * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createProject: (createProject: CreateProjectDto, translate?: string, options?: any) => Promise; /** * * @summary Removes a project * @param {string} projectId * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteProject: (projectId: string, translate?: string, options?: any) => Promise; /** * * @param {string} projectId * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ exportProject: (projectId: string, translate?: string, options?: any) => Promise; /** * * @param {string} projectId * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAvailableProjectPermissions: (projectId: string, translate?: string, options?: any) => Promise; /** * * @summary get project by projectId * @param {string} projectId * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProject: (projectId: string, translate?: string, options?: any) => Promise; /** * * @param {string} projectId * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProjectInvitations: (projectId: string, page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any) => Promise; /** * * @summary Returns all projects for current user * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProjects: (page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any) => Promise; /** * * @summary Returns users for given project * @param {string} projectId * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUsersForProject: (projectId: string, page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any) => Promise; /** * * @summary patches a project * @param {string} projectId * @param {UpdateProjectDto} updateProject * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchProject: (projectId: string, updateProject: UpdateProjectDto, translate?: string, options?: any) => Promise; /** * * @summary updates a project * @param {string} projectId * @param {UpdateProjectDto} updateProject * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putProject: (projectId: string, updateProject: UpdateProjectDto, translate?: string, options?: any) => Promise; /** * * @summary Removes a user from the project * @param {string} projectId * @param {string} userId * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeUserFromProject: (projectId: string, userId: string, translate?: string, options?: any) => Promise; }; /** * ProjectsApi - functional programming interface * @export */ export declare const ProjectsApiFp: (axiosClientConfiguration?: Configuration) => { /** * * @summary Create project * @param {CreateProjectDto} createProject * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createProject(createProject: CreateProjectDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Removes a project * @param {string} projectId * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteProject(projectId: string, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} projectId * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ exportProject(projectId: string, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * * @param {string} projectId * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAvailableProjectPermissions(projectId: string, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * * @summary get project by projectId * @param {string} projectId * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProject(projectId: string, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} projectId * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProjectInvitations(projectId: string, page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Returns all projects for current user * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProjects(page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Returns users for given project * @param {string} projectId * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUsersForProject(projectId: string, page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary patches a project * @param {string} projectId * @param {UpdateProjectDto} updateProject * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchProject(projectId: string, updateProject: UpdateProjectDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary updates a project * @param {string} projectId * @param {UpdateProjectDto} updateProject * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putProject(projectId: string, updateProject: UpdateProjectDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Removes a user from the project * @param {string} projectId * @param {string} userId * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeUserFromProject(projectId: string, userId: string, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ProjectsApi - factory interface * @export */ export declare const ProjectsApiFactory: (axiosClientConfiguration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Create project * @param {CreateProjectDto} createProject * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createProject(createProject: CreateProjectDto, translate?: string, options?: any): AxiosPromise; /** * * @summary Removes a project * @param {string} projectId * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteProject(projectId: string, translate?: string, options?: any): AxiosPromise; /** * * @param {string} projectId * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ exportProject(projectId: string, translate?: string, options?: any): AxiosPromise>; /** * * @param {string} projectId * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAvailableProjectPermissions(projectId: string, translate?: string, options?: any): AxiosPromise>; /** * * @summary get project by projectId * @param {string} projectId * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProject(projectId: string, translate?: string, options?: any): AxiosPromise; /** * * @param {string} projectId * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProjectInvitations(projectId: string, page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any): AxiosPromise; /** * * @summary Returns all projects for current user * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProjects(page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any): AxiosPromise; /** * * @summary Returns users for given project * @param {string} projectId * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUsersForProject(projectId: string, page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any): AxiosPromise; /** * * @summary patches a project * @param {string} projectId * @param {UpdateProjectDto} updateProject * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchProject(projectId: string, updateProject: UpdateProjectDto, translate?: string, options?: any): AxiosPromise; /** * * @summary updates a project * @param {string} projectId * @param {UpdateProjectDto} updateProject * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putProject(projectId: string, updateProject: UpdateProjectDto, translate?: string, options?: any): AxiosPromise; /** * * @summary Removes a user from the project * @param {string} projectId * @param {string} userId * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeUserFromProject(projectId: string, userId: string, translate?: string, options?: any): AxiosPromise; }; /** * Request parameters for createProject operation in ProjectsApi. * @export * @interface ProjectsApiCreateProjectRequest */ export interface ProjectsApiCreateProjectRequest { /** * * @type {CreateProjectDto} * @memberof ProjectsApiCreateProject */ readonly createProject: CreateProjectDto; /** * * @type {string} * @memberof ProjectsApiCreateProject */ readonly translate?: string; } /** * Request parameters for deleteProject operation in ProjectsApi. * @export * @interface ProjectsApiDeleteProjectRequest */ export interface ProjectsApiDeleteProjectRequest { /** * * @type {string} * @memberof ProjectsApiDeleteProject */ readonly projectId: string; /** * * @type {string} * @memberof ProjectsApiDeleteProject */ readonly translate?: string; } /** * Request parameters for exportProject operation in ProjectsApi. * @export * @interface ProjectsApiExportProjectRequest */ export interface ProjectsApiExportProjectRequest { /** * * @type {string} * @memberof ProjectsApiExportProject */ readonly projectId: string; /** * * @type {string} * @memberof ProjectsApiExportProject */ readonly translate?: string; } /** * Request parameters for getAvailableProjectPermissions operation in ProjectsApi. * @export * @interface ProjectsApiGetAvailableProjectPermissionsRequest */ export interface ProjectsApiGetAvailableProjectPermissionsRequest { /** * * @type {string} * @memberof ProjectsApiGetAvailableProjectPermissions */ readonly projectId: string; /** * * @type {string} * @memberof ProjectsApiGetAvailableProjectPermissions */ readonly translate?: string; } /** * Request parameters for getProject operation in ProjectsApi. * @export * @interface ProjectsApiGetProjectRequest */ export interface ProjectsApiGetProjectRequest { /** * * @type {string} * @memberof ProjectsApiGetProject */ readonly projectId: string; /** * * @type {string} * @memberof ProjectsApiGetProject */ readonly translate?: string; } /** * Request parameters for getProjectInvitations operation in ProjectsApi. * @export * @interface ProjectsApiGetProjectInvitationsRequest */ export interface ProjectsApiGetProjectInvitationsRequest { /** * * @type {string} * @memberof ProjectsApiGetProjectInvitations */ readonly projectId: string; /** * * @type {number} * @memberof ProjectsApiGetProjectInvitations */ readonly page?: number; /** * * @type {number} * @memberof ProjectsApiGetProjectInvitations */ readonly size?: number; /** * * @type {string} * @memberof ProjectsApiGetProjectInvitations */ readonly sort?: string; /** * * @type {string} * @memberof ProjectsApiGetProjectInvitations */ readonly search?: string; /** * * @type {boolean} * @memberof ProjectsApiGetProjectInvitations */ readonly withReplacements?: boolean; /** * * @type {string} * @memberof ProjectsApiGetProjectInvitations */ readonly translate?: string; } /** * Request parameters for getProjects operation in ProjectsApi. * @export * @interface ProjectsApiGetProjectsRequest */ export interface ProjectsApiGetProjectsRequest { /** * * @type {number} * @memberof ProjectsApiGetProjects */ readonly page?: number; /** * * @type {number} * @memberof ProjectsApiGetProjects */ readonly size?: number; /** * * @type {string} * @memberof ProjectsApiGetProjects */ readonly sort?: string; /** * * @type {string} * @memberof ProjectsApiGetProjects */ readonly search?: string; /** * * @type {boolean} * @memberof ProjectsApiGetProjects */ readonly withReplacements?: boolean; /** * * @type {string} * @memberof ProjectsApiGetProjects */ readonly translate?: string; } /** * Request parameters for getUsersForProject operation in ProjectsApi. * @export * @interface ProjectsApiGetUsersForProjectRequest */ export interface ProjectsApiGetUsersForProjectRequest { /** * * @type {string} * @memberof ProjectsApiGetUsersForProject */ readonly projectId: string; /** * * @type {number} * @memberof ProjectsApiGetUsersForProject */ readonly page?: number; /** * * @type {number} * @memberof ProjectsApiGetUsersForProject */ readonly size?: number; /** * * @type {string} * @memberof ProjectsApiGetUsersForProject */ readonly sort?: string; /** * * @type {string} * @memberof ProjectsApiGetUsersForProject */ readonly search?: string; /** * * @type {boolean} * @memberof ProjectsApiGetUsersForProject */ readonly withReplacements?: boolean; /** * * @type {string} * @memberof ProjectsApiGetUsersForProject */ readonly translate?: string; } /** * Request parameters for patchProject operation in ProjectsApi. * @export * @interface ProjectsApiPatchProjectRequest */ export interface ProjectsApiPatchProjectRequest { /** * * @type {string} * @memberof ProjectsApiPatchProject */ readonly projectId: string; /** * * @type {UpdateProjectDto} * @memberof ProjectsApiPatchProject */ readonly updateProject: UpdateProjectDto; /** * * @type {string} * @memberof ProjectsApiPatchProject */ readonly translate?: string; } /** * Request parameters for putProject operation in ProjectsApi. * @export * @interface ProjectsApiPutProjectRequest */ export interface ProjectsApiPutProjectRequest { /** * * @type {string} * @memberof ProjectsApiPutProject */ readonly projectId: string; /** * * @type {UpdateProjectDto} * @memberof ProjectsApiPutProject */ readonly updateProject: UpdateProjectDto; /** * * @type {string} * @memberof ProjectsApiPutProject */ readonly translate?: string; } /** * Request parameters for removeUserFromProject operation in ProjectsApi. * @export * @interface ProjectsApiRemoveUserFromProjectRequest */ export interface ProjectsApiRemoveUserFromProjectRequest { /** * * @type {string} * @memberof ProjectsApiRemoveUserFromProject */ readonly projectId: string; /** * * @type {string} * @memberof ProjectsApiRemoveUserFromProject */ readonly userId: string; /** * * @type {string} * @memberof ProjectsApiRemoveUserFromProject */ readonly translate?: string; } /** * ProjectsApi - object-oriented interface * @export * @class ProjectsApi * @extends {BaseAPI} */ export declare class ProjectsApi extends BaseAPI { /** * * @summary Create project * @param {ProjectsApiCreateProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ createProject(requestParameters: ProjectsApiCreateProjectRequest, options?: any): Promise>; /** * * @summary Removes a project * @param {ProjectsApiDeleteProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ deleteProject(requestParameters: ProjectsApiDeleteProjectRequest, options?: any): Promise>; /** * * @param {ProjectsApiExportProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ exportProject(requestParameters: ProjectsApiExportProjectRequest, options?: any): Promise>; /** * * @param {ProjectsApiGetAvailableProjectPermissionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ getAvailableProjectPermissions(requestParameters: ProjectsApiGetAvailableProjectPermissionsRequest, options?: any): Promise>; /** * * @summary get project by projectId * @param {ProjectsApiGetProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ getProject(requestParameters: ProjectsApiGetProjectRequest, options?: any): Promise>; /** * * @param {ProjectsApiGetProjectInvitationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ getProjectInvitations(requestParameters: ProjectsApiGetProjectInvitationsRequest, options?: any): Promise>; /** * * @summary Returns all projects for current user * @param {ProjectsApiGetProjectsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ getProjects(requestParameters?: ProjectsApiGetProjectsRequest, options?: any): Promise>; /** * * @summary Returns users for given project * @param {ProjectsApiGetUsersForProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ getUsersForProject(requestParameters: ProjectsApiGetUsersForProjectRequest, options?: any): Promise>; /** * * @summary patches a project * @param {ProjectsApiPatchProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ patchProject(requestParameters: ProjectsApiPatchProjectRequest, options?: any): Promise>; /** * * @summary updates a project * @param {ProjectsApiPutProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ putProject(requestParameters: ProjectsApiPutProjectRequest, options?: any): Promise>; /** * * @summary Removes a user from the project * @param {ProjectsApiRemoveUserFromProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ removeUserFromProject(requestParameters: ProjectsApiRemoveUserFromProjectRequest, options?: any): Promise>; }