Class ApiBase

Index

Constructors

Methods

delete get getAuthSession getConfiguration getDomain jwt patch post put renewJwt

Constructors

constructor

new ApiBase(configuration: SDKConfiguration): ApiBase
Parameters
- configuration: SDKConfiguration
Returns ApiBase
- Defined in apiBase.ts:162

Methods

delete

delete(requestInfo: RequestInfo): Promise<void>
Performs an HTTP DELETE request given a parameters hash
Parameters
- requestInfo: RequestInfo
  Parameters to use while performing the request
Returns Promise<void>
Promise
- Defined in apiBase.ts:240

get

get<T>(requestInfo: RequestInfo): Promise<T>
Performs an HTTP GET request given a parameters hash
Type Parameters
- T
Parameters
- requestInfo: RequestInfo
  Parameters to use while performing the request
Returns Promise<T>
Promise
- Defined in apiBase.ts:200

getAuthSession

getAuthSession(): Promise<AuthSession>
Returns Promise<AuthSession>
- Defined in apiBase.ts:308

getConfiguration

getConfiguration(): SDKConfiguration
Returns the configuration of the api

Returns SDKConfiguration
- Defined in apiBase.ts:258

getDomain

getDomain(): string
Gets the current domain

Returns string
- Defined in apiBase.ts:249

jwt

jwt(): string
Proxy to get the JWT

Returns string
- the JWT calculated
- Defined in apiBase.ts:303

patch

patch<T>(requestInfo: RequestInfo): Promise<T>
Performs an HTTP PATCH request given a parameters hash
Type Parameters
- T
Parameters
- requestInfo: RequestInfo
  Parameters to use while performing the request
Returns Promise<T>
Promise
- Defined in apiBase.ts:230

post

post<T>(requestInfo: RequestInfo): Promise<T>
Performs an HTTP POST request given a parameters hash
Type Parameters
- T
Parameters
- requestInfo: RequestInfo
  Parameters to use while performing the request
Returns Promise<T>
Promise
- Defined in apiBase.ts:210

put

put<T>(requestInfo: RequestInfo): Promise<T>
Performs an HTTP POST request given a parameters hash
Type Parameters
- T
Parameters
- requestInfo: RequestInfo
  Parameters to use while performing the request
Returns Promise<T>
Promise
- Defined in apiBase.ts:220

renewJwt

renewJwt(): Promise<AccessTokens>
Renew the JWT using the auth property

Returns Promise<AccessTokens>
Promise Returns the new JWT string
- Defined in apiBase.ts:392