/** * Qase.io TestOps API v1 * Qase TestOps API v1 Specification. * * The version of the OpenAPI document: 1.0.0 * Contact: support@qase.io * * 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, AxiosRequestConfig } from 'axios'; import { Configuration } from '../configuration'; import { RequestArgs, BaseAPI } from '../base'; import { BaseResponse } from '../model'; import { ProjectAccess } from '../model'; import { ProjectCodeResponse } from '../model'; import { ProjectCreate } from '../model'; import { ProjectListResponse } from '../model'; import { ProjectResponse } from '../model'; /** * ProjectsApi - axios parameter creator * @export */ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuration) => { /** * This method is used to create a new project through API. * @summary Create new project * @param {ProjectCreate} projectCreate * @param {*} [options] Override http request option. * @throws {RequiredError} */ createProject: (projectCreate: ProjectCreate, options?: AxiosRequestConfig) => Promise; /** * This method allows to delete a specific project. * @summary Delete Project by code * @param {string} code Code of project, where to search entities. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteProject: (code: string, options?: AxiosRequestConfig) => Promise; /** * This method allows to retrieve a specific project. * @summary Get Project by code * @param {string} code Code of project, where to search entities. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProject: (code: string, options?: AxiosRequestConfig) => Promise; /** * This method allows to retrieve all projects available for your account. You can limit and offset params to paginate. * @summary Get All Projects * @param {number} [limit] A number of entities in result set. * @param {number} [offset] How many entities should be skipped. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProjects: (limit?: number, offset?: number, options?: AxiosRequestConfig) => Promise; /** * This method allows to grant access to a specific project. * @summary Grant access to project by code * @param {string} code Code of project, where to search entities. * @param {ProjectAccess} projectAccess * @param {*} [options] Override http request option. * @throws {RequiredError} */ grantAccessToProject: (code: string, projectAccess: ProjectAccess, options?: AxiosRequestConfig) => Promise; /** * This method allows to revoke access to a specific project. * @summary Revoke access to project by code * @param {string} code Code of project, where to search entities. * @param {ProjectAccess} projectAccess * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeAccessToProject: (code: string, projectAccess: ProjectAccess, options?: AxiosRequestConfig) => Promise; }; /** * ProjectsApi - functional programming interface * @export */ export declare const ProjectsApiFp: (configuration?: Configuration) => { /** * This method is used to create a new project through API. * @summary Create new project * @param {ProjectCreate} projectCreate * @param {*} [options] Override http request option. * @throws {RequiredError} */ createProject(projectCreate: ProjectCreate, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This method allows to delete a specific project. * @summary Delete Project by code * @param {string} code Code of project, where to search entities. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteProject(code: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This method allows to retrieve a specific project. * @summary Get Project by code * @param {string} code Code of project, where to search entities. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProject(code: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This method allows to retrieve all projects available for your account. You can limit and offset params to paginate. * @summary Get All Projects * @param {number} [limit] A number of entities in result set. * @param {number} [offset] How many entities should be skipped. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProjects(limit?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This method allows to grant access to a specific project. * @summary Grant access to project by code * @param {string} code Code of project, where to search entities. * @param {ProjectAccess} projectAccess * @param {*} [options] Override http request option. * @throws {RequiredError} */ grantAccessToProject(code: string, projectAccess: ProjectAccess, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This method allows to revoke access to a specific project. * @summary Revoke access to project by code * @param {string} code Code of project, where to search entities. * @param {ProjectAccess} projectAccess * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeAccessToProject(code: string, projectAccess: ProjectAccess, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ProjectsApi - factory interface * @export */ export declare const ProjectsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This method is used to create a new project through API. * @summary Create new project * @param {ProjectCreate} projectCreate * @param {*} [options] Override http request option. * @throws {RequiredError} */ createProject(projectCreate: ProjectCreate, options?: any): AxiosPromise; /** * This method allows to delete a specific project. * @summary Delete Project by code * @param {string} code Code of project, where to search entities. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteProject(code: string, options?: any): AxiosPromise; /** * This method allows to retrieve a specific project. * @summary Get Project by code * @param {string} code Code of project, where to search entities. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProject(code: string, options?: any): AxiosPromise; /** * This method allows to retrieve all projects available for your account. You can limit and offset params to paginate. * @summary Get All Projects * @param {number} [limit] A number of entities in result set. * @param {number} [offset] How many entities should be skipped. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProjects(limit?: number, offset?: number, options?: any): AxiosPromise; /** * This method allows to grant access to a specific project. * @summary Grant access to project by code * @param {string} code Code of project, where to search entities. * @param {ProjectAccess} projectAccess * @param {*} [options] Override http request option. * @throws {RequiredError} */ grantAccessToProject(code: string, projectAccess: ProjectAccess, options?: any): AxiosPromise; /** * This method allows to revoke access to a specific project. * @summary Revoke access to project by code * @param {string} code Code of project, where to search entities. * @param {ProjectAccess} projectAccess * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeAccessToProject(code: string, projectAccess: ProjectAccess, options?: any): AxiosPromise; }; /** * ProjectsApi - object-oriented interface * @export * @class ProjectsApi * @extends {BaseAPI} */ export declare class ProjectsApi extends BaseAPI { /** * This method is used to create a new project through API. * @summary Create new project * @param {ProjectCreate} projectCreate * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ createProject(projectCreate: ProjectCreate, options?: AxiosRequestConfig): Promise>; /** * This method allows to delete a specific project. * @summary Delete Project by code * @param {string} code Code of project, where to search entities. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ deleteProject(code: string, options?: AxiosRequestConfig): Promise>; /** * This method allows to retrieve a specific project. * @summary Get Project by code * @param {string} code Code of project, where to search entities. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ getProject(code: string, options?: AxiosRequestConfig): Promise>; /** * This method allows to retrieve all projects available for your account. You can limit and offset params to paginate. * @summary Get All Projects * @param {number} [limit] A number of entities in result set. * @param {number} [offset] How many entities should be skipped. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ getProjects(limit?: number, offset?: number, options?: AxiosRequestConfig): Promise>; /** * This method allows to grant access to a specific project. * @summary Grant access to project by code * @param {string} code Code of project, where to search entities. * @param {ProjectAccess} projectAccess * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ grantAccessToProject(code: string, projectAccess: ProjectAccess, options?: AxiosRequestConfig): Promise>; /** * This method allows to revoke access to a specific project. * @summary Revoke access to project by code * @param {string} code Code of project, where to search entities. * @param {ProjectAccess} projectAccess * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ revokeAccessToProject(code: string, projectAccess: ProjectAccess, options?: AxiosRequestConfig): Promise>; }