/** * 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 { IdResponse } from '../model'; import { SuiteCreate } from '../model'; import { SuiteDelete } from '../model'; import { SuiteListResponse } from '../model'; import { SuiteResponse } from '../model'; import { SuiteUpdate } from '../model'; /** * SuitesApi - axios parameter creator * @export */ export declare const SuitesApiAxiosParamCreator: (configuration?: Configuration) => { /** * This method is used to create a new test suite through API. * @summary Create a new test suite * @param {string} code Code of project, where to search entities. * @param {SuiteCreate} suiteCreate * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSuite: (code: string, suiteCreate: SuiteCreate, options?: AxiosRequestConfig) => Promise; /** * This method completely deletes a test suite with test cases from repository. * @summary Delete test suite * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {SuiteDelete} [suiteDelete] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSuite: (code: string, id: number, suiteDelete?: SuiteDelete, options?: AxiosRequestConfig) => Promise; /** * This method allows to retrieve a specific test suite. * @summary Get a specific test suite * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSuite: (code: string, id: number, options?: AxiosRequestConfig) => Promise; /** * This method allows to retrieve all test suites stored in selected project. * @summary Get all test suites * @param {string} code Code of project, where to search entities. * @param {string} [search] Provide a string that will be used to search by name. * @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} */ getSuites: (code: string, search?: string, limit?: number, offset?: number, options?: AxiosRequestConfig) => Promise; /** * This method is used to update a test suite through API. * @summary Update test suite * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {SuiteUpdate} suiteUpdate * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSuite: (code: string, id: number, suiteUpdate: SuiteUpdate, options?: AxiosRequestConfig) => Promise; }; /** * SuitesApi - functional programming interface * @export */ export declare const SuitesApiFp: (configuration?: Configuration) => { /** * This method is used to create a new test suite through API. * @summary Create a new test suite * @param {string} code Code of project, where to search entities. * @param {SuiteCreate} suiteCreate * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSuite(code: string, suiteCreate: SuiteCreate, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This method completely deletes a test suite with test cases from repository. * @summary Delete test suite * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {SuiteDelete} [suiteDelete] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSuite(code: string, id: number, suiteDelete?: SuiteDelete, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This method allows to retrieve a specific test suite. * @summary Get a specific test suite * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSuite(code: string, id: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This method allows to retrieve all test suites stored in selected project. * @summary Get all test suites * @param {string} code Code of project, where to search entities. * @param {string} [search] Provide a string that will be used to search by name. * @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} */ getSuites(code: string, search?: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This method is used to update a test suite through API. * @summary Update test suite * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {SuiteUpdate} suiteUpdate * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSuite(code: string, id: number, suiteUpdate: SuiteUpdate, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SuitesApi - factory interface * @export */ export declare const SuitesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This method is used to create a new test suite through API. * @summary Create a new test suite * @param {string} code Code of project, where to search entities. * @param {SuiteCreate} suiteCreate * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSuite(code: string, suiteCreate: SuiteCreate, options?: any): AxiosPromise; /** * This method completely deletes a test suite with test cases from repository. * @summary Delete test suite * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {SuiteDelete} [suiteDelete] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSuite(code: string, id: number, suiteDelete?: SuiteDelete, options?: any): AxiosPromise; /** * This method allows to retrieve a specific test suite. * @summary Get a specific test suite * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSuite(code: string, id: number, options?: any): AxiosPromise; /** * This method allows to retrieve all test suites stored in selected project. * @summary Get all test suites * @param {string} code Code of project, where to search entities. * @param {string} [search] Provide a string that will be used to search by name. * @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} */ getSuites(code: string, search?: string, limit?: number, offset?: number, options?: any): AxiosPromise; /** * This method is used to update a test suite through API. * @summary Update test suite * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {SuiteUpdate} suiteUpdate * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSuite(code: string, id: number, suiteUpdate: SuiteUpdate, options?: any): AxiosPromise; }; /** * SuitesApi - object-oriented interface * @export * @class SuitesApi * @extends {BaseAPI} */ export declare class SuitesApi extends BaseAPI { /** * This method is used to create a new test suite through API. * @summary Create a new test suite * @param {string} code Code of project, where to search entities. * @param {SuiteCreate} suiteCreate * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SuitesApi */ createSuite(code: string, suiteCreate: SuiteCreate, options?: AxiosRequestConfig): Promise>; /** * This method completely deletes a test suite with test cases from repository. * @summary Delete test suite * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {SuiteDelete} [suiteDelete] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SuitesApi */ deleteSuite(code: string, id: number, suiteDelete?: SuiteDelete, options?: AxiosRequestConfig): Promise>; /** * This method allows to retrieve a specific test suite. * @summary Get a specific test suite * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SuitesApi */ getSuite(code: string, id: number, options?: AxiosRequestConfig): Promise>; /** * This method allows to retrieve all test suites stored in selected project. * @summary Get all test suites * @param {string} code Code of project, where to search entities. * @param {string} [search] Provide a string that will be used to search by name. * @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 SuitesApi */ getSuites(code: string, search?: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise>; /** * This method is used to update a test suite through API. * @summary Update test suite * @param {string} code Code of project, where to search entities. * @param {number} id Identifier. * @param {SuiteUpdate} suiteUpdate * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SuitesApi */ updateSuite(code: string, id: number, suiteUpdate: SuiteUpdate, options?: AxiosRequestConfig): Promise>; }