Class StartupApi

StartupApi - object-oriented interface

Export

StartupApi

Hierarchy

BaseAPI
- StartupApi

Index

Constructors

Properties

axios basePath configuration

Methods

completeWizard getFirstUser getFirstUser2 getStartupConfiguration setRemoteAccess updateInitialConfiguration updateStartupUser

Constructors

constructor

new StartupApi(configuration?, basePath?, axios?): StartupApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns StartupApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

completeWizard

completeWizard(options?): Promise<AxiosResponse<void, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Completes the startup wizard.

Throws
Memberof
StartupApi
- Defined in generated-client/api/startup-api.ts:514

getFirstUser

getFirstUser(options?): Promise<AxiosResponse<StartupUserDto, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<StartupUserDto, any>>
Summary
Gets the first user.

Throws
Memberof
StartupApi
- Defined in generated-client/api/startup-api.ts:525

getFirstUser2

getFirstUser2(options?): Promise<AxiosResponse<StartupUserDto, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<StartupUserDto, any>>
Summary
Gets the first user.

Throws
Memberof
StartupApi
- Defined in generated-client/api/startup-api.ts:536

getStartupConfiguration

getStartupConfiguration(options?): Promise<AxiosResponse<StartupConfigurationDto, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<StartupConfigurationDto, any>>
Summary
Gets the initial startup wizard configuration.

Throws
Memberof
StartupApi
- Defined in generated-client/api/startup-api.ts:547

setRemoteAccess

setRemoteAccess(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: StartupApiSetRemoteAccessRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Sets remote access and UPnP.

Throws
Memberof
StartupApi
- Defined in generated-client/api/startup-api.ts:559

updateInitialConfiguration

updateInitialConfiguration(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: StartupApiUpdateInitialConfigurationRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Sets the initial startup wizard configuration.

Throws
Memberof
StartupApi
- Defined in generated-client/api/startup-api.ts:571

updateStartupUser

updateStartupUser(requestParameters?, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: StartupApiUpdateStartupUserRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Sets the user name and password.

Throws
Memberof
StartupApi
- Defined in generated-client/api/startup-api.ts:583