Class SASjsApiClient

Hierarchy

SASjsApiClient

Index

Constructors

Methods

deploy executeJob executeScript getAccessToken refreshTokens

Constructors

constructor

new SASjsApiClient(requestClient: RequestClient): SASjsApiClient
Parameters
- requestClient: RequestClient
Returns SASjsApiClient
- Defined in SASjsApiClient.ts:9

Methods

deploy

deploy(dataJson: ServicePackSASjs, appLoc: string, authConfig?: AuthConfig): Promise<{ example?: {}; message: string; status: string; streamServiceName?: string }>
Parameters
- dataJson: ServicePackSASjs
- appLoc: string
- Optional authConfig: AuthConfig
Returns Promise<{ example?: {}; message: string; status: string; streamServiceName?: string }>
- Defined in SASjsApiClient.ts:11

executeJob

executeJob(query: ExecutionQuery, appLoc: string, authConfig?: AuthConfig): Promise<{ log: any; result: any }>
Parameters
- query: ExecutionQuery
- appLoc: string
- Optional authConfig: AuthConfig
Returns Promise<{ log: any; result: any }>
- Defined in SASjsApiClient.ts:44

executeScript

executeScript(code: string, runTime?: string, authConfig?: AuthConfig): Promise<string>
Executes code on a SASJS server.
Parameters
- code: string
  
  a string of code to execute.
- runTime: string = 'sas'
  
  a string to representing runTime for code execution
- Optional authConfig: AuthConfig
  
  an object for authentication.
Returns Promise<string>
- Defined in SASjsApiClient.ts:71

getAccessToken

getAccessToken(clientId: string, authCode: string): Promise<SASjsAuthResponse>
Exchanges the auth code for an access token for the given client.
Parameters
- clientId: string
  
  the client ID to authenticate with.
- authCode: string
  
  the auth code received from the server.
Returns Promise<SASjsAuthResponse>
- Defined in SASjsApiClient.ts:101

refreshTokens

refreshTokens(refreshToken: string): Promise<SASjsAuthResponse>
Exchanges the refresh token for an access token.
Parameters
- refreshToken: string
  
  the refresh token received from the server.
Returns Promise<SASjsAuthResponse>
- Defined in SASjsApiClient.ts:112

Generated using TypeDoc