Class SASjsApiClient

Hierarchy

SASjsApiClient

Index

Constructors

constructor

Methods

deploy deployZipFile executeJob executeScript getAccessToken refreshTokens

Constructors

constructor

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

Methods

deploy

deploy(dataJson: ServicePackSASjs, appLoc: string, authConfig?: AuthConfig): Promise<{
    example?: {};
    message: string;
    status: string;
    streamServiceName?: string;
}>
Creates the folders and services at the given location appLoc on the given server serverUrl.
Parameters
- dataJson: ServicePackSASjs
  
  the JSON specifying the folders and files to be created, can also includes appLoc, streamServiceName, streamWebFolder, streamLogo
- appLoc: string
  
  the base folder in which to create the new folders and services.
- Optional authConfig: AuthConfig
  
  (optional) a valid client, secret, refresh and access tokens that are authorised to execute compute jobs.
Returns Promise<{
    example?: {};
    message: string;
    status: string;
    streamServiceName?: string;
}>
- Defined in SASjsApiClient.ts:44

deployZipFile

deployZipFile(zipFilePath: string, authConfig?: AuthConfig): Promise<{
    example?: {};
    message: string;
    status: string;
    streamServiceName?: string;
}>
Creates/updates files within SASjs drive using uploaded json compressed file.
Parameters
- zipFilePath: string
  
  Compressed file path; file should only contain one JSON file and should have same name as of compressed file e.g. deploy.JSON should be compressed to deploy.JSON.zip Any other file or JSON file in zipped will be ignored!
- Optional authConfig: AuthConfig
  
  (optional) a valid client, secret, refresh and access tokens that are authorised to execute compute jobs.
Returns Promise<{
    example?: {};
    message: string;
    status: string;
    streamServiceName?: string;
}>
- Defined in SASjsApiClient.ts:76

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:103

executeScript

executeScript(code: string, runTime?: string, authConfig?: AuthConfig): Promise<ScriptExecutionResult>
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<ScriptExecutionResult>
- Defined in SASjsApiClient.ts:130

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:163

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:174

Class SASjsApiClient

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

requestClient: RequestClient

Returns SASjsApiClient

Methods

deploy

Parameters

dataJson: ServicePackSASjs

appLoc: string

Optional authConfig: AuthConfig

Returns Promise<{ example?: {}; message: string; status: string; streamServiceName?: string; }>

deployZipFile

Parameters

zipFilePath: string

Optional authConfig: AuthConfig

Returns Promise<{ example?: {}; message: string; status: string; streamServiceName?: string; }>

executeJob

Parameters

query: ExecutionQuery

appLoc: string

Optional authConfig: AuthConfig

Returns Promise<{ log: any; result: any; }>

executeScript

Parameters

code: string

runTime: string = 'sas'

Optional authConfig: AuthConfig

Returns Promise<ScriptExecutionResult>

getAccessToken

Parameters

clientId: string

authCode: string

Returns Promise<SASjsAuthResponse>

refreshTokens

Parameters

refreshToken: string

Returns Promise<SASjsAuthResponse>

Settings

Member Visibility

Theme

`Optional` authConfig: AuthConfig

Returns Promise<{
example?: {};
message: string;
status: string;
streamServiceName?: string;
}>

`Optional` authConfig: AuthConfig

Returns Promise<{
example?: {};
message: string;
status: string;
streamServiceName?: string;
}>

`Optional` authConfig: AuthConfig

Returns Promise<{
log: any;
result: any;
}>

`Optional` authConfig: AuthConfig