Class LoginApi

LoginApi - object-oriented interface

export

Hierarchy

BaseAPI
- LoginApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new LoginApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): LoginApi

Inherited from BaseAPI.constructor
- Defined in base.ts:50
Parameters
- Optional configuration: Configuration
- basePath: string = ...
- axios: AxiosInstance = ...
Returns LoginApi

Properties

Protected axios

axios: AxiosInstance = ...

Protected basePath

basePath: string = ...

Protected configuration

configuration: undefined | Configuration

Methods

loginPost

loginPost(request: LoginPostRequest, options?: any): Promise<AxiosResponse<LoginPostResponse>>

- Defined in api.ts:7088
Login to the Shifter. username and password are required. Return AccessToken and RefreshToken when the request succeeded.

throws

{RequiredError}

memberof

LoginApi

Parameters
- request: LoginPostRequest
- Optional options: any
Returns Promise<AxiosResponse<LoginPostResponse>>

loginPut

loginPut(request: InlineObject, options?: any): Promise<AxiosResponse<object>>

- Defined in api.ts:7099
Refresh AccessToken by RefreshToken. Return new AccessToken when request succeeded.

throws

{RequiredError}

memberof

LoginApi

Parameters
- request: InlineObject
- Optional options: any
Returns Promise<AxiosResponse<object>>

Generated using TypeDoc