Function DevicesApiFp

DevicesApi - functional programming interface

Export

  • DevicesApiFp(configuration?): {
        deleteDevice(id: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        getDeviceInfo(id: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInfoDto>)>;
        getDeviceOptions(id: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceOptionsDto>)>;
        getDevices(userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInfoDtoQueryResult>)>;
        updateDeviceOptions(id: string, deviceOptionsDto: DeviceOptionsDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    }

  • Parameters

    Returns {
        deleteDevice(id: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        getDeviceInfo(id: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInfoDto>)>;
        getDeviceOptions(id: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceOptionsDto>)>;
        getDevices(userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInfoDtoQueryResult>)>;
        updateDeviceOptions(id: string, deviceOptionsDto: DeviceOptionsDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    }

    • deleteDevice:function
      • deleteDevice(id, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

      • Parameters

        • id: string

          Device Id.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Summary

        Deletes a device.

        Throws

    • getDeviceInfo:function
      • getDeviceInfo(id, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInfoDto>)>

      • Parameters

        • id: string

          Device Id.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInfoDto>)>

        Summary

        Get info for a device.

        Throws

    • getDeviceOptions:function
      • getDeviceOptions(id, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceOptionsDto>)>

      • Parameters

        • id: string

          Device Id.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceOptionsDto>)>

        Summary

        Get options for a device.

        Throws

    • getDevices:function
      • getDevices(userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInfoDtoQueryResult>)>

      • Parameters

        • OptionaluserId: string

          Gets or sets the user identifier.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInfoDtoQueryResult>)>

        Summary

        Get Devices.

        Throws

    • updateDeviceOptions:function
      • updateDeviceOptions(id, deviceOptionsDto, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

      • Parameters

        • id: string

          Device Id.

        • deviceOptionsDto: DeviceOptionsDto

          Device Options.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Summary

        Update device options.

        Throws

Settings

Member Visibility