/** * 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 { OptInDto } from '../models'; import { OptInPageDto } from '../models'; import { OptInSearchResultPageDto } from '../models'; import { SearchRequestDto } from '../models'; /** * OptInsApi - axios parameter creator * @export */ export declare const OptInsApiAxiosParamCreator: (axiosClientConfiguration?: Configuration) => { /** * * @param {OptInDto} optIn * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOptIn: (optIn: OptInDto, translate?: string, options?: any) => Promise; /** * * @param {Array} ids * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteManyOptIns: (ids: Array, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteOptIn: (id: string, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptIn: (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} */ getOptIns: (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} */ getOptInsCount: (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 OptIn exists. * @summary Check if OptIn exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ optInExists: (id: string, options?: any) => Promise; /** * * @param {string} id * @param {any} optIn * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchOptIn: (id: string, optIn: any, translate?: string, options?: any) => Promise; /** * * @param {SearchRequestDto} searchRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ performOptInSearch: (searchRequest: SearchRequestDto, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {OptInDto} optIn * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putOptIn: (id: string, optIn: OptInDto, translate?: string, options?: any) => Promise; }; /** * OptInsApi - functional programming interface * @export */ export declare const OptInsApiFp: (axiosClientConfiguration?: Configuration) => { /** * * @param {OptInDto} optIn * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOptIn(optIn: OptInDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {Array} ids * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteManyOptIns(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} */ deleteOptIn(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} */ getOptIn(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} */ getOptIns(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} */ getOptInsCount(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 OptIn exists. * @summary Check if OptIn exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ optInExists(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {any} optIn * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchOptIn(id: string, optIn: 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} */ performOptInSearch(searchRequest: SearchRequestDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {OptInDto} optIn * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putOptIn(id: string, optIn: OptInDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * OptInsApi - factory interface * @export */ export declare const OptInsApiFactory: (axiosClientConfiguration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @param {OptInDto} optIn * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOptIn(optIn: OptInDto, translate?: string, options?: any): AxiosPromise; /** * * @param {Array} ids * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteManyOptIns(ids: Array, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteOptIn(id: string, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptIn(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} */ getOptIns(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} */ getOptInsCount(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 OptIn exists. * @summary Check if OptIn exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ optInExists(id: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {any} optIn * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchOptIn(id: string, optIn: any, translate?: string, options?: any): AxiosPromise; /** * * @param {SearchRequestDto} searchRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ performOptInSearch(searchRequest: SearchRequestDto, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {OptInDto} optIn * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putOptIn(id: string, optIn: OptInDto, translate?: string, options?: any): AxiosPromise; }; /** * Request parameters for createOptIn operation in OptInsApi. * @export * @interface OptInsApiCreateOptInRequest */ export interface OptInsApiCreateOptInRequest { /** * * @type {OptInDto} * @memberof OptInsApiCreateOptIn */ readonly optIn: OptInDto; /** * * @type {string} * @memberof OptInsApiCreateOptIn */ readonly translate?: string; } /** * Request parameters for deleteManyOptIns operation in OptInsApi. * @export * @interface OptInsApiDeleteManyOptInsRequest */ export interface OptInsApiDeleteManyOptInsRequest { /** * * @type {Array} * @memberof OptInsApiDeleteManyOptIns */ readonly ids: Array; /** * * @type {string} * @memberof OptInsApiDeleteManyOptIns */ readonly translate?: string; } /** * Request parameters for deleteOptIn operation in OptInsApi. * @export * @interface OptInsApiDeleteOptInRequest */ export interface OptInsApiDeleteOptInRequest { /** * * @type {string} * @memberof OptInsApiDeleteOptIn */ readonly id: string; /** * * @type {string} * @memberof OptInsApiDeleteOptIn */ readonly translate?: string; } /** * Request parameters for getOptIn operation in OptInsApi. * @export * @interface OptInsApiGetOptInRequest */ export interface OptInsApiGetOptInRequest { /** * * @type {string} * @memberof OptInsApiGetOptIn */ readonly id: string; /** * * @type {string} * @memberof OptInsApiGetOptIn */ readonly translate?: string; } /** * Request parameters for getOptIns operation in OptInsApi. * @export * @interface OptInsApiGetOptInsRequest */ export interface OptInsApiGetOptInsRequest { /** * * @type {number} * @memberof OptInsApiGetOptIns */ readonly page?: number; /** * * @type {number} * @memberof OptInsApiGetOptIns */ readonly size?: number; /** * * @type {string} * @memberof OptInsApiGetOptIns */ readonly translate?: string; /** * * @type {boolean} * @memberof OptInsApiGetOptIns */ readonly withReplacements?: boolean; /** * * @type {string} * @memberof OptInsApiGetOptIns */ readonly sort?: string; /** * * @type {string} * @memberof OptInsApiGetOptIns */ readonly search?: string; } /** * Request parameters for getOptInsCount operation in OptInsApi. * @export * @interface OptInsApiGetOptInsCountRequest */ export interface OptInsApiGetOptInsCountRequest { /** * * @type {number} * @memberof OptInsApiGetOptInsCount */ readonly page?: number; /** * * @type {number} * @memberof OptInsApiGetOptInsCount */ readonly size?: number; /** * * @type {string} * @memberof OptInsApiGetOptInsCount */ readonly sort?: string; /** * * @type {string} * @memberof OptInsApiGetOptInsCount */ readonly search?: string; /** * * @type {boolean} * @memberof OptInsApiGetOptInsCount */ readonly withReplacements?: boolean; /** * * @type {string} * @memberof OptInsApiGetOptInsCount */ readonly translate?: string; } /** * Request parameters for optInExists operation in OptInsApi. * @export * @interface OptInsApiOptInExistsRequest */ export interface OptInsApiOptInExistsRequest { /** * * @type {string} * @memberof OptInsApiOptInExists */ readonly id: string; } /** * Request parameters for patchOptIn operation in OptInsApi. * @export * @interface OptInsApiPatchOptInRequest */ export interface OptInsApiPatchOptInRequest { /** * * @type {string} * @memberof OptInsApiPatchOptIn */ readonly id: string; /** * * @type {any} * @memberof OptInsApiPatchOptIn */ readonly optIn: any; /** * * @type {string} * @memberof OptInsApiPatchOptIn */ readonly translate?: string; } /** * Request parameters for performOptInSearch operation in OptInsApi. * @export * @interface OptInsApiPerformOptInSearchRequest */ export interface OptInsApiPerformOptInSearchRequest { /** * * @type {SearchRequestDto} * @memberof OptInsApiPerformOptInSearch */ readonly searchRequest: SearchRequestDto; /** * * @type {string} * @memberof OptInsApiPerformOptInSearch */ readonly translate?: string; } /** * Request parameters for putOptIn operation in OptInsApi. * @export * @interface OptInsApiPutOptInRequest */ export interface OptInsApiPutOptInRequest { /** * * @type {string} * @memberof OptInsApiPutOptIn */ readonly id: string; /** * * @type {OptInDto} * @memberof OptInsApiPutOptIn */ readonly optIn: OptInDto; /** * * @type {string} * @memberof OptInsApiPutOptIn */ readonly translate?: string; } /** * OptInsApi - object-oriented interface * @export * @class OptInsApi * @extends {BaseAPI} */ export declare class OptInsApi extends BaseAPI { /** * * @param {OptInsApiCreateOptInRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OptInsApi */ createOptIn(requestParameters: OptInsApiCreateOptInRequest, options?: any): Promise>; /** * * @param {OptInsApiDeleteManyOptInsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OptInsApi */ deleteManyOptIns(requestParameters: OptInsApiDeleteManyOptInsRequest, options?: any): Promise>; /** * * @param {OptInsApiDeleteOptInRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OptInsApi */ deleteOptIn(requestParameters: OptInsApiDeleteOptInRequest, options?: any): Promise>; /** * * @param {OptInsApiGetOptInRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OptInsApi */ getOptIn(requestParameters: OptInsApiGetOptInRequest, options?: any): Promise>; /** * * @param {OptInsApiGetOptInsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OptInsApi */ getOptIns(requestParameters?: OptInsApiGetOptInsRequest, options?: any): Promise>; /** * * @param {OptInsApiGetOptInsCountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OptInsApi */ getOptInsCount(requestParameters?: OptInsApiGetOptInsCountRequest, options?: any): Promise>; /** * This is a very performant method for checking if a OptIn exists. * @summary Check if OptIn exists * @param {OptInsApiOptInExistsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OptInsApi */ optInExists(requestParameters: OptInsApiOptInExistsRequest, options?: any): Promise>; /** * * @param {OptInsApiPatchOptInRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OptInsApi */ patchOptIn(requestParameters: OptInsApiPatchOptInRequest, options?: any): Promise>; /** * * @param {OptInsApiPerformOptInSearchRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OptInsApi */ performOptInSearch(requestParameters: OptInsApiPerformOptInSearchRequest, options?: any): Promise>; /** * * @param {OptInsApiPutOptInRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OptInsApi */ putOptIn(requestParameters: OptInsApiPutOptInRequest, options?: any): Promise>; }