/** * 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 { EnvironmentCreate } from '../model'; import { EnvironmentListResponse } from '../model'; import { EnvironmentResponse } from '../model'; import { EnvironmentUpdate } from '../model'; import { IdResponse } from '../model'; /** * EnvironmentsApi - axios parameter creator * @export */ export declare const EnvironmentsApiAxiosParamCreator: (configuration?: Configuration) => { /** * This method allows to create an environment in selected project. * @summary Create a new environment * @param {string} code Code of project, where to search entities. * @param {EnvironmentCreate} environmentCreate * @param {*} [options] Override http request option. * @throws {RequiredError} */ createEnvironment: (code: string, environmentCreate: EnvironmentCreate, options?: AxiosRequestConfig) => Promise; /** * This method completely deletes an environment from repository. * @summary Delete environment * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEnvironment: (code: string, id: number, options?: AxiosRequestConfig) => Promise; /** * This method allows to retrieve a specific environment. * @summary Get a specific environment * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEnvironment: (code: string, id: number, options?: AxiosRequestConfig) => Promise; /** * This method allows to retrieve all environments stored in selected project. * @summary Get all environments * @param {string} code Code of project, where to search entities. * @param {string} [search] A search string. Will return all environments with titles containing provided string. * @param {string} [slug] A search string. Will return all environments with slugs equal to provided string. * @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} */ getEnvironments: (code: string, search?: string, slug?: string, limit?: number, offset?: number, options?: AxiosRequestConfig) => Promise; /** * This method updates an environment. * @summary Update environment * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {EnvironmentUpdate} environmentUpdate * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEnvironment: (code: string, id: number, environmentUpdate: EnvironmentUpdate, options?: AxiosRequestConfig) => Promise; }; /** * EnvironmentsApi - functional programming interface * @export */ export declare const EnvironmentsApiFp: (configuration?: Configuration) => { /** * This method allows to create an environment in selected project. * @summary Create a new environment * @param {string} code Code of project, where to search entities. * @param {EnvironmentCreate} environmentCreate * @param {*} [options] Override http request option. * @throws {RequiredError} */ createEnvironment(code: string, environmentCreate: EnvironmentCreate, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This method completely deletes an environment from repository. * @summary Delete environment * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEnvironment(code: string, id: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This method allows to retrieve a specific environment. * @summary Get a specific environment * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEnvironment(code: string, id: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This method allows to retrieve all environments stored in selected project. * @summary Get all environments * @param {string} code Code of project, where to search entities. * @param {string} [search] A search string. Will return all environments with titles containing provided string. * @param {string} [slug] A search string. Will return all environments with slugs equal to provided string. * @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} */ getEnvironments(code: string, search?: string, slug?: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This method updates an environment. * @summary Update environment * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {EnvironmentUpdate} environmentUpdate * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEnvironment(code: string, id: number, environmentUpdate: EnvironmentUpdate, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * EnvironmentsApi - factory interface * @export */ export declare const EnvironmentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This method allows to create an environment in selected project. * @summary Create a new environment * @param {string} code Code of project, where to search entities. * @param {EnvironmentCreate} environmentCreate * @param {*} [options] Override http request option. * @throws {RequiredError} */ createEnvironment(code: string, environmentCreate: EnvironmentCreate, options?: any): AxiosPromise; /** * This method completely deletes an environment from repository. * @summary Delete environment * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEnvironment(code: string, id: number, options?: any): AxiosPromise; /** * This method allows to retrieve a specific environment. * @summary Get a specific environment * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEnvironment(code: string, id: number, options?: any): AxiosPromise; /** * This method allows to retrieve all environments stored in selected project. * @summary Get all environments * @param {string} code Code of project, where to search entities. * @param {string} [search] A search string. Will return all environments with titles containing provided string. * @param {string} [slug] A search string. Will return all environments with slugs equal to provided string. * @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} */ getEnvironments(code: string, search?: string, slug?: string, limit?: number, offset?: number, options?: any): AxiosPromise; /** * This method updates an environment. * @summary Update environment * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {EnvironmentUpdate} environmentUpdate * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEnvironment(code: string, id: number, environmentUpdate: EnvironmentUpdate, options?: any): AxiosPromise; }; /** * EnvironmentsApi - object-oriented interface * @export * @class EnvironmentsApi * @extends {BaseAPI} */ export declare class EnvironmentsApi extends BaseAPI { /** * This method allows to create an environment in selected project. * @summary Create a new environment * @param {string} code Code of project, where to search entities. * @param {EnvironmentCreate} environmentCreate * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EnvironmentsApi */ createEnvironment(code: string, environmentCreate: EnvironmentCreate, options?: AxiosRequestConfig): Promise>; /** * This method completely deletes an environment from repository. * @summary Delete environment * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EnvironmentsApi */ deleteEnvironment(code: string, id: number, options?: AxiosRequestConfig): Promise>; /** * This method allows to retrieve a specific environment. * @summary Get a specific environment * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EnvironmentsApi */ getEnvironment(code: string, id: number, options?: AxiosRequestConfig): Promise>; /** * This method allows to retrieve all environments stored in selected project. * @summary Get all environments * @param {string} code Code of project, where to search entities. * @param {string} [search] A search string. Will return all environments with titles containing provided string. * @param {string} [slug] A search string. Will return all environments with slugs equal to provided string. * @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 EnvironmentsApi */ getEnvironments(code: string, search?: string, slug?: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise>; /** * This method updates an environment. * @summary Update environment * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {EnvironmentUpdate} environmentUpdate * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EnvironmentsApi */ updateEnvironment(code: string, id: number, environmentUpdate: EnvironmentUpdate, options?: AxiosRequestConfig): Promise>; }