Function StartupApiAxiosParamCreator

StartupApi - axios parameter creator

Export

  • StartupApiAxiosParamCreator(configuration?): {
        completeWizard: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getFirstUser: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getFirstUser2: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getStartupConfiguration: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        setRemoteAccess: ((startupRemoteAccessDto: StartupRemoteAccessDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        updateInitialConfiguration: ((startupConfigurationDto: StartupConfigurationDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        updateStartupUser: ((startupUserDto?: StartupUserDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        completeWizard: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getFirstUser: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getFirstUser2: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getStartupConfiguration: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        setRemoteAccess: ((startupRemoteAccessDto: StartupRemoteAccessDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        updateInitialConfiguration: ((startupConfigurationDto: StartupConfigurationDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        updateStartupUser: ((startupUserDto?: StartupUserDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • completeWizard: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Completes the startup wizard.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getFirstUser: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets the first user.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getFirstUser2: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets the first user.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getStartupConfiguration: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets the initial startup wizard configuration.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • setRemoteAccess: ((startupRemoteAccessDto: StartupRemoteAccessDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Sets remote access and UPnP.

      Throws

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

        • Parameters

          • startupRemoteAccessDto: StartupRemoteAccessDto

            The startup remote access dto.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • updateInitialConfiguration: ((startupConfigurationDto: StartupConfigurationDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Sets the initial startup wizard configuration.

      Throws

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

        • Parameters

          • startupConfigurationDto: StartupConfigurationDto

            The updated startup configuration.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • updateStartupUser: ((startupUserDto?: StartupUserDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Sets the user name and password.

      Throws

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

        • Parameters

          • OptionalstartupUserDto: StartupUserDto

            The DTO containing username and password.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility