/** * 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 { ClaimDeviceDto } from '../models'; import { DeviceDto } from '../models'; import { DevicePageDto } from '../models'; import { DeviceSearchResultPageDto } from '../models'; import { DeviceStatusDto } from '../models'; import { RegisteredDeviceRequestDto } from '../models'; import { SearchRequestDto } from '../models'; /** * DevicesApi - axios parameter creator * @export */ export declare const DevicesApiAxiosParamCreator: (axiosClientConfiguration?: Configuration) => { /** * Claims a device via pairing pin * @param {ClaimDeviceDto} claimDevice * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ claimDevice: (claimDevice: ClaimDeviceDto, translate?: string, options?: any) => Promise; /** * * @param {DeviceDto} device * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDevice: (device: DeviceDto, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDevice: (id: string, translate?: string, options?: any) => Promise; /** * * @param {Array} ids * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteManyDevices: (ids: Array, translate?: string, options?: any) => Promise; /** * This is a very performant method for checking if a Device exists. * @summary Check if Device exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ deviceExists: (id: string, options?: any) => Promise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDevice: (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} */ getDevices: (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} */ getDevicesCount: (page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {any} device * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchDevice: (id: string, device: any, translate?: string, options?: any) => Promise; /** * * @param {SearchRequestDto} searchRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ performDeviceSearch: (searchRequest: SearchRequestDto, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {DeviceDto} device * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putDevice: (id: string, device: DeviceDto, translate?: string, options?: any) => Promise; /** * Returns a device by given uuid and pairingPin * @param {RegisteredDeviceRequestDto} registeredDeviceRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveDeviceStatus: (registeredDeviceRequest: RegisteredDeviceRequestDto, translate?: string, options?: any) => Promise; }; /** * DevicesApi - functional programming interface * @export */ export declare const DevicesApiFp: (axiosClientConfiguration?: Configuration) => { /** * Claims a device via pairing pin * @param {ClaimDeviceDto} claimDevice * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ claimDevice(claimDevice: ClaimDeviceDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {DeviceDto} device * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDevice(device: DeviceDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDevice(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} */ deleteManyDevices(ids: Array, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This is a very performant method for checking if a Device exists. * @summary Check if Device exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ deviceExists(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDevice(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} */ getDevices(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} */ getDevicesCount(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} device * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchDevice(id: string, device: 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} */ performDeviceSearch(searchRequest: SearchRequestDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {DeviceDto} device * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putDevice(id: string, device: DeviceDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a device by given uuid and pairingPin * @param {RegisteredDeviceRequestDto} registeredDeviceRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveDeviceStatus(registeredDeviceRequest: RegisteredDeviceRequestDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DevicesApi - factory interface * @export */ export declare const DevicesApiFactory: (axiosClientConfiguration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Claims a device via pairing pin * @param {ClaimDeviceDto} claimDevice * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ claimDevice(claimDevice: ClaimDeviceDto, translate?: string, options?: any): AxiosPromise; /** * * @param {DeviceDto} device * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDevice(device: DeviceDto, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDevice(id: string, translate?: string, options?: any): AxiosPromise; /** * * @param {Array} ids * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteManyDevices(ids: Array, translate?: string, options?: any): AxiosPromise; /** * This is a very performant method for checking if a Device exists. * @summary Check if Device exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ deviceExists(id: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDevice(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} */ getDevices(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} */ getDevicesCount(page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {any} device * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchDevice(id: string, device: any, translate?: string, options?: any): AxiosPromise; /** * * @param {SearchRequestDto} searchRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ performDeviceSearch(searchRequest: SearchRequestDto, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {DeviceDto} device * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putDevice(id: string, device: DeviceDto, translate?: string, options?: any): AxiosPromise; /** * Returns a device by given uuid and pairingPin * @param {RegisteredDeviceRequestDto} registeredDeviceRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveDeviceStatus(registeredDeviceRequest: RegisteredDeviceRequestDto, translate?: string, options?: any): AxiosPromise; }; /** * Request parameters for claimDevice operation in DevicesApi. * @export * @interface DevicesApiClaimDeviceRequest */ export interface DevicesApiClaimDeviceRequest { /** * * @type {ClaimDeviceDto} * @memberof DevicesApiClaimDevice */ readonly claimDevice: ClaimDeviceDto; /** * * @type {string} * @memberof DevicesApiClaimDevice */ readonly translate?: string; } /** * Request parameters for createDevice operation in DevicesApi. * @export * @interface DevicesApiCreateDeviceRequest */ export interface DevicesApiCreateDeviceRequest { /** * * @type {DeviceDto} * @memberof DevicesApiCreateDevice */ readonly device: DeviceDto; /** * * @type {string} * @memberof DevicesApiCreateDevice */ readonly translate?: string; } /** * Request parameters for deleteDevice operation in DevicesApi. * @export * @interface DevicesApiDeleteDeviceRequest */ export interface DevicesApiDeleteDeviceRequest { /** * * @type {string} * @memberof DevicesApiDeleteDevice */ readonly id: string; /** * * @type {string} * @memberof DevicesApiDeleteDevice */ readonly translate?: string; } /** * Request parameters for deleteManyDevices operation in DevicesApi. * @export * @interface DevicesApiDeleteManyDevicesRequest */ export interface DevicesApiDeleteManyDevicesRequest { /** * * @type {Array} * @memberof DevicesApiDeleteManyDevices */ readonly ids: Array; /** * * @type {string} * @memberof DevicesApiDeleteManyDevices */ readonly translate?: string; } /** * Request parameters for deviceExists operation in DevicesApi. * @export * @interface DevicesApiDeviceExistsRequest */ export interface DevicesApiDeviceExistsRequest { /** * * @type {string} * @memberof DevicesApiDeviceExists */ readonly id: string; } /** * Request parameters for getDevice operation in DevicesApi. * @export * @interface DevicesApiGetDeviceRequest */ export interface DevicesApiGetDeviceRequest { /** * * @type {string} * @memberof DevicesApiGetDevice */ readonly id: string; /** * * @type {string} * @memberof DevicesApiGetDevice */ readonly translate?: string; } /** * Request parameters for getDevices operation in DevicesApi. * @export * @interface DevicesApiGetDevicesRequest */ export interface DevicesApiGetDevicesRequest { /** * * @type {number} * @memberof DevicesApiGetDevices */ readonly page?: number; /** * * @type {number} * @memberof DevicesApiGetDevices */ readonly size?: number; /** * * @type {string} * @memberof DevicesApiGetDevices */ readonly translate?: string; /** * * @type {boolean} * @memberof DevicesApiGetDevices */ readonly withReplacements?: boolean; /** * * @type {string} * @memberof DevicesApiGetDevices */ readonly sort?: string; /** * * @type {string} * @memberof DevicesApiGetDevices */ readonly search?: string; } /** * Request parameters for getDevicesCount operation in DevicesApi. * @export * @interface DevicesApiGetDevicesCountRequest */ export interface DevicesApiGetDevicesCountRequest { /** * * @type {number} * @memberof DevicesApiGetDevicesCount */ readonly page?: number; /** * * @type {number} * @memberof DevicesApiGetDevicesCount */ readonly size?: number; /** * * @type {string} * @memberof DevicesApiGetDevicesCount */ readonly sort?: string; /** * * @type {string} * @memberof DevicesApiGetDevicesCount */ readonly search?: string; /** * * @type {boolean} * @memberof DevicesApiGetDevicesCount */ readonly withReplacements?: boolean; /** * * @type {string} * @memberof DevicesApiGetDevicesCount */ readonly translate?: string; } /** * Request parameters for patchDevice operation in DevicesApi. * @export * @interface DevicesApiPatchDeviceRequest */ export interface DevicesApiPatchDeviceRequest { /** * * @type {string} * @memberof DevicesApiPatchDevice */ readonly id: string; /** * * @type {any} * @memberof DevicesApiPatchDevice */ readonly device: any; /** * * @type {string} * @memberof DevicesApiPatchDevice */ readonly translate?: string; } /** * Request parameters for performDeviceSearch operation in DevicesApi. * @export * @interface DevicesApiPerformDeviceSearchRequest */ export interface DevicesApiPerformDeviceSearchRequest { /** * * @type {SearchRequestDto} * @memberof DevicesApiPerformDeviceSearch */ readonly searchRequest: SearchRequestDto; /** * * @type {string} * @memberof DevicesApiPerformDeviceSearch */ readonly translate?: string; } /** * Request parameters for putDevice operation in DevicesApi. * @export * @interface DevicesApiPutDeviceRequest */ export interface DevicesApiPutDeviceRequest { /** * * @type {string} * @memberof DevicesApiPutDevice */ readonly id: string; /** * * @type {DeviceDto} * @memberof DevicesApiPutDevice */ readonly device: DeviceDto; /** * * @type {string} * @memberof DevicesApiPutDevice */ readonly translate?: string; } /** * Request parameters for retrieveDeviceStatus operation in DevicesApi. * @export * @interface DevicesApiRetrieveDeviceStatusRequest */ export interface DevicesApiRetrieveDeviceStatusRequest { /** * * @type {RegisteredDeviceRequestDto} * @memberof DevicesApiRetrieveDeviceStatus */ readonly registeredDeviceRequest: RegisteredDeviceRequestDto; /** * * @type {string} * @memberof DevicesApiRetrieveDeviceStatus */ readonly translate?: string; } /** * DevicesApi - object-oriented interface * @export * @class DevicesApi * @extends {BaseAPI} */ export declare class DevicesApi extends BaseAPI { /** * Claims a device via pairing pin * @param {DevicesApiClaimDeviceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DevicesApi */ claimDevice(requestParameters: DevicesApiClaimDeviceRequest, options?: any): Promise>; /** * * @param {DevicesApiCreateDeviceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DevicesApi */ createDevice(requestParameters: DevicesApiCreateDeviceRequest, options?: any): Promise>; /** * * @param {DevicesApiDeleteDeviceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DevicesApi */ deleteDevice(requestParameters: DevicesApiDeleteDeviceRequest, options?: any): Promise>; /** * * @param {DevicesApiDeleteManyDevicesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DevicesApi */ deleteManyDevices(requestParameters: DevicesApiDeleteManyDevicesRequest, options?: any): Promise>; /** * This is a very performant method for checking if a Device exists. * @summary Check if Device exists * @param {DevicesApiDeviceExistsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DevicesApi */ deviceExists(requestParameters: DevicesApiDeviceExistsRequest, options?: any): Promise>; /** * * @param {DevicesApiGetDeviceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DevicesApi */ getDevice(requestParameters: DevicesApiGetDeviceRequest, options?: any): Promise>; /** * * @param {DevicesApiGetDevicesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DevicesApi */ getDevices(requestParameters?: DevicesApiGetDevicesRequest, options?: any): Promise>; /** * * @param {DevicesApiGetDevicesCountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DevicesApi */ getDevicesCount(requestParameters?: DevicesApiGetDevicesCountRequest, options?: any): Promise>; /** * * @param {DevicesApiPatchDeviceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DevicesApi */ patchDevice(requestParameters: DevicesApiPatchDeviceRequest, options?: any): Promise>; /** * * @param {DevicesApiPerformDeviceSearchRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DevicesApi */ performDeviceSearch(requestParameters: DevicesApiPerformDeviceSearchRequest, options?: any): Promise>; /** * * @param {DevicesApiPutDeviceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DevicesApi */ putDevice(requestParameters: DevicesApiPutDeviceRequest, options?: any): Promise>; /** * Returns a device by given uuid and pairingPin * @param {DevicesApiRetrieveDeviceStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DevicesApi */ retrieveDeviceStatus(requestParameters: DevicesApiRetrieveDeviceStatusRequest, options?: any): Promise>; }