Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SASjsApiClient

Hierarchy

  • SASjsApiClient

Index

Constructors

Methods

Constructors

constructor

  • new SASjsApiClient(serverUrl: string, requestClient: RequestClient): SASjsApiClient

Methods

deploy

  • deploy(members: FileTree, appLoc: string, authConfig?: AuthConfig): Promise<{ example?: {}; message: string; status: string }>

  • Parameters

    • members: FileTree
    • appLoc: string
    • Optional authConfig: AuthConfig

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

executeJob

  • executeJob(query: ExecutionQuery): Promise<{ _webout?: string; error?: {}; log?: string; logPath?: string; message: string; status: string }>

  • Parameters

    Returns Promise<{ _webout?: string; error?: {}; log?: string; logPath?: string; message: string; status: string }>

getAccessToken

  • 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>

getAuthCode

  • getAuthCode(username: string, password: string, clientId: string): Promise<string>

  • Performs a login authenticate and returns an auth code for the given client.

    Parameters

    • username: string

      a string representing the username.

    • password: string

      a string representing the password.

    • clientId: string

      the client ID to authenticate with.

    Returns Promise<string>

refreshTokens

  • Exchanges the refresh token for an access token.

    Parameters

    • refreshToken: string

      the refresh token received from the server.

    Returns Promise<SASjsAuthResponse>

setConfig

  • setConfig(serverUrl: string): void

Generated using TypeDoc