/** * 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 { CustomFieldDto } from '../models'; import { CustomFieldPageDto } from '../models'; import { CustomFieldSearchResultPageDto } from '../models'; import { SearchRequestDto } from '../models'; /** * CustomFieldsApi - axios parameter creator * @export */ export declare const CustomFieldsApiAxiosParamCreator: (axiosClientConfiguration?: Configuration) => { /** * * @param {CustomFieldDto} customField * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCustomField: (customField: CustomFieldDto, translate?: string, options?: any) => Promise; /** * This is a very performant method for checking if a CustomField exists. * @summary Check if CustomField exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ customFieldExists: (id: string, options?: any) => Promise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCustomField: (id: string, translate?: string, options?: any) => Promise; /** * * @param {Array} ids * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteManyCustomFields: (ids: Array, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomField: (id: string, translate?: string, options?: any) => Promise; /** * * @param {number} [page] * @param {number} [size] * @param {string} [translate] * @param {boolean} [withReplacements] * @param {string} [sort] * @param {string} [search] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomFields: (page?: number, size?: number, translate?: string, withReplacements?: boolean, sort?: string, search?: string, options?: any) => Promise; /** * * @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} */ getCustomFieldsCount: (page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {any} customField * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchCustomField: (id: string, customField: any, translate?: string, options?: any) => Promise; /** * * @param {SearchRequestDto} searchRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ performCustomFieldSearch: (searchRequest: SearchRequestDto, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {CustomFieldDto} customField * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putCustomField: (id: string, customField: CustomFieldDto, translate?: string, options?: any) => Promise; }; /** * CustomFieldsApi - functional programming interface * @export */ export declare const CustomFieldsApiFp: (axiosClientConfiguration?: Configuration) => { /** * * @param {CustomFieldDto} customField * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCustomField(customField: CustomFieldDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This is a very performant method for checking if a CustomField exists. * @summary Check if CustomField exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ customFieldExists(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCustomField(id: string, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {Array} ids * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteManyCustomFields(ids: Array, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomField(id: string, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {number} [page] * @param {number} [size] * @param {string} [translate] * @param {boolean} [withReplacements] * @param {string} [sort] * @param {string} [search] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomFields(page?: number, size?: number, translate?: string, withReplacements?: boolean, sort?: string, search?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @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} */ getCustomFieldsCount(page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {any} customField * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchCustomField(id: string, customField: any, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {SearchRequestDto} searchRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ performCustomFieldSearch(searchRequest: SearchRequestDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {CustomFieldDto} customField * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putCustomField(id: string, customField: CustomFieldDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CustomFieldsApi - factory interface * @export */ export declare const CustomFieldsApiFactory: (axiosClientConfiguration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @param {CustomFieldDto} customField * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCustomField(customField: CustomFieldDto, translate?: string, options?: any): AxiosPromise; /** * This is a very performant method for checking if a CustomField exists. * @summary Check if CustomField exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ customFieldExists(id: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCustomField(id: string, translate?: string, options?: any): AxiosPromise; /** * * @param {Array} ids * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteManyCustomFields(ids: Array, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomField(id: string, translate?: string, options?: any): AxiosPromise; /** * * @param {number} [page] * @param {number} [size] * @param {string} [translate] * @param {boolean} [withReplacements] * @param {string} [sort] * @param {string} [search] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomFields(page?: number, size?: number, translate?: string, withReplacements?: boolean, sort?: string, search?: string, options?: any): AxiosPromise; /** * * @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} */ getCustomFieldsCount(page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {any} customField * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchCustomField(id: string, customField: any, translate?: string, options?: any): AxiosPromise; /** * * @param {SearchRequestDto} searchRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ performCustomFieldSearch(searchRequest: SearchRequestDto, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {CustomFieldDto} customField * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putCustomField(id: string, customField: CustomFieldDto, translate?: string, options?: any): AxiosPromise; }; /** * Request parameters for createCustomField operation in CustomFieldsApi. * @export * @interface CustomFieldsApiCreateCustomFieldRequest */ export interface CustomFieldsApiCreateCustomFieldRequest { /** * * @type {CustomFieldDto} * @memberof CustomFieldsApiCreateCustomField */ readonly customField: CustomFieldDto; /** * * @type {string} * @memberof CustomFieldsApiCreateCustomField */ readonly translate?: string; } /** * Request parameters for customFieldExists operation in CustomFieldsApi. * @export * @interface CustomFieldsApiCustomFieldExistsRequest */ export interface CustomFieldsApiCustomFieldExistsRequest { /** * * @type {string} * @memberof CustomFieldsApiCustomFieldExists */ readonly id: string; } /** * Request parameters for deleteCustomField operation in CustomFieldsApi. * @export * @interface CustomFieldsApiDeleteCustomFieldRequest */ export interface CustomFieldsApiDeleteCustomFieldRequest { /** * * @type {string} * @memberof CustomFieldsApiDeleteCustomField */ readonly id: string; /** * * @type {string} * @memberof CustomFieldsApiDeleteCustomField */ readonly translate?: string; } /** * Request parameters for deleteManyCustomFields operation in CustomFieldsApi. * @export * @interface CustomFieldsApiDeleteManyCustomFieldsRequest */ export interface CustomFieldsApiDeleteManyCustomFieldsRequest { /** * * @type {Array} * @memberof CustomFieldsApiDeleteManyCustomFields */ readonly ids: Array; /** * * @type {string} * @memberof CustomFieldsApiDeleteManyCustomFields */ readonly translate?: string; } /** * Request parameters for getCustomField operation in CustomFieldsApi. * @export * @interface CustomFieldsApiGetCustomFieldRequest */ export interface CustomFieldsApiGetCustomFieldRequest { /** * * @type {string} * @memberof CustomFieldsApiGetCustomField */ readonly id: string; /** * * @type {string} * @memberof CustomFieldsApiGetCustomField */ readonly translate?: string; } /** * Request parameters for getCustomFields operation in CustomFieldsApi. * @export * @interface CustomFieldsApiGetCustomFieldsRequest */ export interface CustomFieldsApiGetCustomFieldsRequest { /** * * @type {number} * @memberof CustomFieldsApiGetCustomFields */ readonly page?: number; /** * * @type {number} * @memberof CustomFieldsApiGetCustomFields */ readonly size?: number; /** * * @type {string} * @memberof CustomFieldsApiGetCustomFields */ readonly translate?: string; /** * * @type {boolean} * @memberof CustomFieldsApiGetCustomFields */ readonly withReplacements?: boolean; /** * * @type {string} * @memberof CustomFieldsApiGetCustomFields */ readonly sort?: string; /** * * @type {string} * @memberof CustomFieldsApiGetCustomFields */ readonly search?: string; } /** * Request parameters for getCustomFieldsCount operation in CustomFieldsApi. * @export * @interface CustomFieldsApiGetCustomFieldsCountRequest */ export interface CustomFieldsApiGetCustomFieldsCountRequest { /** * * @type {number} * @memberof CustomFieldsApiGetCustomFieldsCount */ readonly page?: number; /** * * @type {number} * @memberof CustomFieldsApiGetCustomFieldsCount */ readonly size?: number; /** * * @type {string} * @memberof CustomFieldsApiGetCustomFieldsCount */ readonly sort?: string; /** * * @type {string} * @memberof CustomFieldsApiGetCustomFieldsCount */ readonly search?: string; /** * * @type {boolean} * @memberof CustomFieldsApiGetCustomFieldsCount */ readonly withReplacements?: boolean; /** * * @type {string} * @memberof CustomFieldsApiGetCustomFieldsCount */ readonly translate?: string; } /** * Request parameters for patchCustomField operation in CustomFieldsApi. * @export * @interface CustomFieldsApiPatchCustomFieldRequest */ export interface CustomFieldsApiPatchCustomFieldRequest { /** * * @type {string} * @memberof CustomFieldsApiPatchCustomField */ readonly id: string; /** * * @type {any} * @memberof CustomFieldsApiPatchCustomField */ readonly customField: any; /** * * @type {string} * @memberof CustomFieldsApiPatchCustomField */ readonly translate?: string; } /** * Request parameters for performCustomFieldSearch operation in CustomFieldsApi. * @export * @interface CustomFieldsApiPerformCustomFieldSearchRequest */ export interface CustomFieldsApiPerformCustomFieldSearchRequest { /** * * @type {SearchRequestDto} * @memberof CustomFieldsApiPerformCustomFieldSearch */ readonly searchRequest: SearchRequestDto; /** * * @type {string} * @memberof CustomFieldsApiPerformCustomFieldSearch */ readonly translate?: string; } /** * Request parameters for putCustomField operation in CustomFieldsApi. * @export * @interface CustomFieldsApiPutCustomFieldRequest */ export interface CustomFieldsApiPutCustomFieldRequest { /** * * @type {string} * @memberof CustomFieldsApiPutCustomField */ readonly id: string; /** * * @type {CustomFieldDto} * @memberof CustomFieldsApiPutCustomField */ readonly customField: CustomFieldDto; /** * * @type {string} * @memberof CustomFieldsApiPutCustomField */ readonly translate?: string; } /** * CustomFieldsApi - object-oriented interface * @export * @class CustomFieldsApi * @extends {BaseAPI} */ export declare class CustomFieldsApi extends BaseAPI { /** * * @param {CustomFieldsApiCreateCustomFieldRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomFieldsApi */ createCustomField(requestParameters: CustomFieldsApiCreateCustomFieldRequest, options?: any): Promise>; /** * This is a very performant method for checking if a CustomField exists. * @summary Check if CustomField exists * @param {CustomFieldsApiCustomFieldExistsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomFieldsApi */ customFieldExists(requestParameters: CustomFieldsApiCustomFieldExistsRequest, options?: any): Promise>; /** * * @param {CustomFieldsApiDeleteCustomFieldRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomFieldsApi */ deleteCustomField(requestParameters: CustomFieldsApiDeleteCustomFieldRequest, options?: any): Promise>; /** * * @param {CustomFieldsApiDeleteManyCustomFieldsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomFieldsApi */ deleteManyCustomFields(requestParameters: CustomFieldsApiDeleteManyCustomFieldsRequest, options?: any): Promise>; /** * * @param {CustomFieldsApiGetCustomFieldRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomFieldsApi */ getCustomField(requestParameters: CustomFieldsApiGetCustomFieldRequest, options?: any): Promise>; /** * * @param {CustomFieldsApiGetCustomFieldsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomFieldsApi */ getCustomFields(requestParameters?: CustomFieldsApiGetCustomFieldsRequest, options?: any): Promise>; /** * * @param {CustomFieldsApiGetCustomFieldsCountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomFieldsApi */ getCustomFieldsCount(requestParameters?: CustomFieldsApiGetCustomFieldsCountRequest, options?: any): Promise>; /** * * @param {CustomFieldsApiPatchCustomFieldRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomFieldsApi */ patchCustomField(requestParameters: CustomFieldsApiPatchCustomFieldRequest, options?: any): Promise>; /** * * @param {CustomFieldsApiPerformCustomFieldSearchRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomFieldsApi */ performCustomFieldSearch(requestParameters: CustomFieldsApiPerformCustomFieldSearchRequest, options?: any): Promise>; /** * * @param {CustomFieldsApiPutCustomFieldRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomFieldsApi */ putCustomField(requestParameters: CustomFieldsApiPutCustomFieldRequest, options?: any): Promise>; }