Class Api

constructor

• new Api(basePath, clientInfo, deviceInfo, accessToken?, axiosInstance?): Api

• Parameters

  • basePath: string
  • clientInfo: ClientInfo
  • deviceInfo: DeviceInfo
  • accessToken: string = ''
  • axiosInstance: AxiosInstance = globalInstance

  Returns Api

accessToken

axiosInstance

basePath

clientInfo

deviceInfo

authorizationHeader

• get authorizationHeader(): string

• Returns string

configuration

• get configuration(): Configuration

• Returns Configuration

authenticateUserByName

• authenticateUserByName(username, password?): Promise<AxiosResponse<AuthenticationResult, any>>

• Convenience method for authenticating a user by name and updating the internal state.

  Parameters

  • username: string

    The username.
  • Optionalpassword: string

    The user password if required.

  Returns Promise<AxiosResponse<AuthenticationResult, any>>

logout

• logout(): Promise<AxiosResponse<void, any> | AxiosResponse<never, any>>

• Convenience method for logging out and updating the internal state.

  Returns Promise<AxiosResponse<void, any> | AxiosResponse<never, any>>