/** * 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 { HashResponse } from '../model'; import { SharedStepCreate } from '../model'; import { SharedStepListResponse } from '../model'; import { SharedStepResponse } from '../model'; import { SharedStepUpdate } from '../model'; /** * SharedStepsApi - axios parameter creator * @export */ export declare const SharedStepsApiAxiosParamCreator: (configuration?: Configuration) => { /** * This method allows to create a shared step in selected project. * @summary Create a new shared step * @param {string} code Code of project, where to search entities. * @param {SharedStepCreate} sharedStepCreate * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSharedStep: (code: string, sharedStepCreate: SharedStepCreate, options?: AxiosRequestConfig) => Promise; /** * This method completely deletes a shared step from repository. * @summary Delete shared step * @param {string} code Code of project, where to search entities. * @param {string} hash Hash. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSharedStep: (code: string, hash: string, options?: AxiosRequestConfig) => Promise; /** * This method allows to retrieve a specific shared step. * @summary Get a specific shared step * @param {string} code Code of project, where to search entities. * @param {string} hash Hash. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSharedStep: (code: string, hash: string, options?: AxiosRequestConfig) => Promise; /** * This method allows to retrieve all shared steps stored in selected project. * @summary Get all shared steps * @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} */ getSharedSteps: (code: string, search?: string, limit?: number, offset?: number, options?: AxiosRequestConfig) => Promise; /** * This method updates a shared step. * @summary Update shared step * @param {string} code Code of project, where to search entities. * @param {string} hash Hash. * @param {SharedStepUpdate} sharedStepUpdate * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSharedStep: (code: string, hash: string, sharedStepUpdate: SharedStepUpdate, options?: AxiosRequestConfig) => Promise; }; /** * SharedStepsApi - functional programming interface * @export */ export declare const SharedStepsApiFp: (configuration?: Configuration) => { /** * This method allows to create a shared step in selected project. * @summary Create a new shared step * @param {string} code Code of project, where to search entities. * @param {SharedStepCreate} sharedStepCreate * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSharedStep(code: string, sharedStepCreate: SharedStepCreate, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This method completely deletes a shared step from repository. * @summary Delete shared step * @param {string} code Code of project, where to search entities. * @param {string} hash Hash. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSharedStep(code: string, hash: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This method allows to retrieve a specific shared step. * @summary Get a specific shared step * @param {string} code Code of project, where to search entities. * @param {string} hash Hash. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSharedStep(code: string, hash: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This method allows to retrieve all shared steps stored in selected project. * @summary Get all shared steps * @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} */ getSharedSteps(code: string, search?: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This method updates a shared step. * @summary Update shared step * @param {string} code Code of project, where to search entities. * @param {string} hash Hash. * @param {SharedStepUpdate} sharedStepUpdate * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSharedStep(code: string, hash: string, sharedStepUpdate: SharedStepUpdate, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SharedStepsApi - factory interface * @export */ export declare const SharedStepsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This method allows to create a shared step in selected project. * @summary Create a new shared step * @param {string} code Code of project, where to search entities. * @param {SharedStepCreate} sharedStepCreate * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSharedStep(code: string, sharedStepCreate: SharedStepCreate, options?: any): AxiosPromise; /** * This method completely deletes a shared step from repository. * @summary Delete shared step * @param {string} code Code of project, where to search entities. * @param {string} hash Hash. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSharedStep(code: string, hash: string, options?: any): AxiosPromise; /** * This method allows to retrieve a specific shared step. * @summary Get a specific shared step * @param {string} code Code of project, where to search entities. * @param {string} hash Hash. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSharedStep(code: string, hash: string, options?: any): AxiosPromise; /** * This method allows to retrieve all shared steps stored in selected project. * @summary Get all shared steps * @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} */ getSharedSteps(code: string, search?: string, limit?: number, offset?: number, options?: any): AxiosPromise; /** * This method updates a shared step. * @summary Update shared step * @param {string} code Code of project, where to search entities. * @param {string} hash Hash. * @param {SharedStepUpdate} sharedStepUpdate * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSharedStep(code: string, hash: string, sharedStepUpdate: SharedStepUpdate, options?: any): AxiosPromise; }; /** * SharedStepsApi - object-oriented interface * @export * @class SharedStepsApi * @extends {BaseAPI} */ export declare class SharedStepsApi extends BaseAPI { /** * This method allows to create a shared step in selected project. * @summary Create a new shared step * @param {string} code Code of project, where to search entities. * @param {SharedStepCreate} sharedStepCreate * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SharedStepsApi */ createSharedStep(code: string, sharedStepCreate: SharedStepCreate, options?: AxiosRequestConfig): Promise>; /** * This method completely deletes a shared step from repository. * @summary Delete shared step * @param {string} code Code of project, where to search entities. * @param {string} hash Hash. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SharedStepsApi */ deleteSharedStep(code: string, hash: string, options?: AxiosRequestConfig): Promise>; /** * This method allows to retrieve a specific shared step. * @summary Get a specific shared step * @param {string} code Code of project, where to search entities. * @param {string} hash Hash. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SharedStepsApi */ getSharedStep(code: string, hash: string, options?: AxiosRequestConfig): Promise>; /** * This method allows to retrieve all shared steps stored in selected project. * @summary Get all shared steps * @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 SharedStepsApi */ getSharedSteps(code: string, search?: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise>; /** * This method updates a shared step. * @summary Update shared step * @param {string} code Code of project, where to search entities. * @param {string} hash Hash. * @param {SharedStepUpdate} sharedStepUpdate * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SharedStepsApi */ updateSharedStep(code: string, hash: string, sharedStepUpdate: SharedStepUpdate, options?: AxiosRequestConfig): Promise>; }