/** * 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 { CreateNoteDto } from '../models'; import { NoteDto } from '../models'; import { NotePageDto } from '../models'; import { NoteSearchResultPageDto } from '../models'; import { SearchRequestDto } from '../models'; /** * NotesApi - axios parameter creator * @export */ export declare const NotesApiAxiosParamCreator: (axiosClientConfiguration?: Configuration) => { /** * * @param {CreateNoteDto} createNote * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createNote: (createNote: CreateNoteDto, translate?: string, options?: any) => Promise; /** * * @param {Array} ids * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteManyNotes: (ids: Array, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteNote: (id: string, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNote: (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} */ getNotes: (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} */ getNotesCount: (page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any) => Promise; /** * This is a very performant method for checking if a Note exists. * @summary Check if Note exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ noteExists: (id: string, options?: any) => Promise; /** * * @param {string} id * @param {any} note * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchNote: (id: string, note: any, translate?: string, options?: any) => Promise; /** * * @param {SearchRequestDto} searchRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ performNoteSearch: (searchRequest: SearchRequestDto, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {NoteDto} note * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putNote: (id: string, note: NoteDto, translate?: string, options?: any) => Promise; }; /** * NotesApi - functional programming interface * @export */ export declare const NotesApiFp: (axiosClientConfiguration?: Configuration) => { /** * * @param {CreateNoteDto} createNote * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createNote(createNote: CreateNoteDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {Array} ids * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteManyNotes(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} */ deleteNote(id: string, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNote(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} */ getNotes(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} */ getNotesCount(page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This is a very performant method for checking if a Note exists. * @summary Check if Note exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ noteExists(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {any} note * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchNote(id: string, note: 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} */ performNoteSearch(searchRequest: SearchRequestDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {NoteDto} note * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putNote(id: string, note: NoteDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * NotesApi - factory interface * @export */ export declare const NotesApiFactory: (axiosClientConfiguration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @param {CreateNoteDto} createNote * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createNote(createNote: CreateNoteDto, translate?: string, options?: any): AxiosPromise; /** * * @param {Array} ids * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteManyNotes(ids: Array, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteNote(id: string, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNote(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} */ getNotes(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} */ getNotesCount(page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any): AxiosPromise; /** * This is a very performant method for checking if a Note exists. * @summary Check if Note exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ noteExists(id: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {any} note * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchNote(id: string, note: any, translate?: string, options?: any): AxiosPromise; /** * * @param {SearchRequestDto} searchRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ performNoteSearch(searchRequest: SearchRequestDto, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {NoteDto} note * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putNote(id: string, note: NoteDto, translate?: string, options?: any): AxiosPromise; }; /** * Request parameters for createNote operation in NotesApi. * @export * @interface NotesApiCreateNoteRequest */ export interface NotesApiCreateNoteRequest { /** * * @type {CreateNoteDto} * @memberof NotesApiCreateNote */ readonly createNote: CreateNoteDto; /** * * @type {string} * @memberof NotesApiCreateNote */ readonly translate?: string; } /** * Request parameters for deleteManyNotes operation in NotesApi. * @export * @interface NotesApiDeleteManyNotesRequest */ export interface NotesApiDeleteManyNotesRequest { /** * * @type {Array} * @memberof NotesApiDeleteManyNotes */ readonly ids: Array; /** * * @type {string} * @memberof NotesApiDeleteManyNotes */ readonly translate?: string; } /** * Request parameters for deleteNote operation in NotesApi. * @export * @interface NotesApiDeleteNoteRequest */ export interface NotesApiDeleteNoteRequest { /** * * @type {string} * @memberof NotesApiDeleteNote */ readonly id: string; /** * * @type {string} * @memberof NotesApiDeleteNote */ readonly translate?: string; } /** * Request parameters for getNote operation in NotesApi. * @export * @interface NotesApiGetNoteRequest */ export interface NotesApiGetNoteRequest { /** * * @type {string} * @memberof NotesApiGetNote */ readonly id: string; /** * * @type {string} * @memberof NotesApiGetNote */ readonly translate?: string; } /** * Request parameters for getNotes operation in NotesApi. * @export * @interface NotesApiGetNotesRequest */ export interface NotesApiGetNotesRequest { /** * * @type {number} * @memberof NotesApiGetNotes */ readonly page?: number; /** * * @type {number} * @memberof NotesApiGetNotes */ readonly size?: number; /** * * @type {string} * @memberof NotesApiGetNotes */ readonly translate?: string; /** * * @type {boolean} * @memberof NotesApiGetNotes */ readonly withReplacements?: boolean; /** * * @type {string} * @memberof NotesApiGetNotes */ readonly sort?: string; /** * * @type {string} * @memberof NotesApiGetNotes */ readonly search?: string; } /** * Request parameters for getNotesCount operation in NotesApi. * @export * @interface NotesApiGetNotesCountRequest */ export interface NotesApiGetNotesCountRequest { /** * * @type {number} * @memberof NotesApiGetNotesCount */ readonly page?: number; /** * * @type {number} * @memberof NotesApiGetNotesCount */ readonly size?: number; /** * * @type {string} * @memberof NotesApiGetNotesCount */ readonly sort?: string; /** * * @type {string} * @memberof NotesApiGetNotesCount */ readonly search?: string; /** * * @type {boolean} * @memberof NotesApiGetNotesCount */ readonly withReplacements?: boolean; /** * * @type {string} * @memberof NotesApiGetNotesCount */ readonly translate?: string; } /** * Request parameters for noteExists operation in NotesApi. * @export * @interface NotesApiNoteExistsRequest */ export interface NotesApiNoteExistsRequest { /** * * @type {string} * @memberof NotesApiNoteExists */ readonly id: string; } /** * Request parameters for patchNote operation in NotesApi. * @export * @interface NotesApiPatchNoteRequest */ export interface NotesApiPatchNoteRequest { /** * * @type {string} * @memberof NotesApiPatchNote */ readonly id: string; /** * * @type {any} * @memberof NotesApiPatchNote */ readonly note: any; /** * * @type {string} * @memberof NotesApiPatchNote */ readonly translate?: string; } /** * Request parameters for performNoteSearch operation in NotesApi. * @export * @interface NotesApiPerformNoteSearchRequest */ export interface NotesApiPerformNoteSearchRequest { /** * * @type {SearchRequestDto} * @memberof NotesApiPerformNoteSearch */ readonly searchRequest: SearchRequestDto; /** * * @type {string} * @memberof NotesApiPerformNoteSearch */ readonly translate?: string; } /** * Request parameters for putNote operation in NotesApi. * @export * @interface NotesApiPutNoteRequest */ export interface NotesApiPutNoteRequest { /** * * @type {string} * @memberof NotesApiPutNote */ readonly id: string; /** * * @type {NoteDto} * @memberof NotesApiPutNote */ readonly note: NoteDto; /** * * @type {string} * @memberof NotesApiPutNote */ readonly translate?: string; } /** * NotesApi - object-oriented interface * @export * @class NotesApi * @extends {BaseAPI} */ export declare class NotesApi extends BaseAPI { /** * * @param {NotesApiCreateNoteRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotesApi */ createNote(requestParameters: NotesApiCreateNoteRequest, options?: any): Promise>; /** * * @param {NotesApiDeleteManyNotesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotesApi */ deleteManyNotes(requestParameters: NotesApiDeleteManyNotesRequest, options?: any): Promise>; /** * * @param {NotesApiDeleteNoteRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotesApi */ deleteNote(requestParameters: NotesApiDeleteNoteRequest, options?: any): Promise>; /** * * @param {NotesApiGetNoteRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotesApi */ getNote(requestParameters: NotesApiGetNoteRequest, options?: any): Promise>; /** * * @param {NotesApiGetNotesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotesApi */ getNotes(requestParameters?: NotesApiGetNotesRequest, options?: any): Promise>; /** * * @param {NotesApiGetNotesCountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotesApi */ getNotesCount(requestParameters?: NotesApiGetNotesCountRequest, options?: any): Promise>; /** * This is a very performant method for checking if a Note exists. * @summary Check if Note exists * @param {NotesApiNoteExistsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotesApi */ noteExists(requestParameters: NotesApiNoteExistsRequest, options?: any): Promise>; /** * * @param {NotesApiPatchNoteRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotesApi */ patchNote(requestParameters: NotesApiPatchNoteRequest, options?: any): Promise>; /** * * @param {NotesApiPerformNoteSearchRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotesApi */ performNoteSearch(requestParameters: NotesApiPerformNoteSearchRequest, options?: any): Promise>; /** * * @param {NotesApiPutNoteRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotesApi */ putNote(requestParameters: NotesApiPutNoteRequest, options?: any): Promise>; }