Function DeviceApiFp

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?: string[],
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • Optionalid: string[]

      Device Ids.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getDeviceInfo: function

  • getDeviceInfo(
        id: string,
        options?: RawAxiosRequestConfig,
    ): 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>,
    >

    Throws

• getDeviceOptions: function

  • getDeviceOptions(
        id: string,
        options?: RawAxiosRequestConfig,
    ): 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>,
    >

    Throws

• getDevices: function

  • getDevices(
        userId?: string,
        options?: RawAxiosRequestConfig,
    ): 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>,
    >

    Throws

• updateDeviceOptions: function

  • updateDeviceOptions(
        id: string,
        deviceOptionsDto: DeviceOptionsDto,
        options?: RawAxiosRequestConfig,
    ): 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>>

    Throws