Function DevicesApiAxiosParamCreator

DevicesApi - axios parameter creator

Export

  • DevicesApiAxiosParamCreator(configuration?): {
        deleteDevice: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getDeviceInfo: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getDeviceOptions: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getDevices: ((userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        updateDeviceOptions: ((id: string, deviceOptionsDto: DeviceOptionsDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        deleteDevice: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getDeviceInfo: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getDeviceOptions: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getDevices: ((userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        updateDeviceOptions: ((id: string, deviceOptionsDto: DeviceOptionsDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • deleteDevice: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Deletes a device.

      Throws

        • (id, options?): Promise<RequestArgs>

        • Parameters

          • id: string

            Device Id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getDeviceInfo: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Get info for a device.

      Throws

        • (id, options?): Promise<RequestArgs>

        • Parameters

          • id: string

            Device Id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getDeviceOptions: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Get options for a device.

      Throws

        • (id, options?): Promise<RequestArgs>

        • Parameters

          • id: string

            Device Id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getDevices: ((userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Get Devices.

      Throws

        • (userId?, options?): Promise<RequestArgs>

        • Parameters

          • OptionaluserId: string

            Gets or sets the user identifier.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • updateDeviceOptions: ((id: string, deviceOptionsDto: DeviceOptionsDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Update device options.

      Throws

        • (id, deviceOptionsDto, options?): Promise<RequestArgs>

        • Parameters

          • id: string

            Device Id.

          • deviceOptionsDto: DeviceOptionsDto

            Device Options.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility