UiPath
UiPath SDK - Legacy class providing all services through property getters.
Extends core UiPath. For modular usage, import from specific service modules.
Deprecated¶
This class is provided for backward compatibility only.
Use the modular pattern with @uipath/uipath-typescript/core instead.
Examples¶
// Legacy pattern (deprecated)
import { UiPath } from '@uipath/uipath-typescript';
const sdk = new UiPath(config);
await sdk.initialize();
const data = await sdk.entities.getAll();
// New modular pattern (recommended)
import { UiPath } from '@uipath/uipath-typescript/core';
import { Entities } from '@uipath/uipath-typescript/entities';
const sdk = new UiPath(config);
await sdk.initialize();
const entitiesService = new Entities(sdk);
const data = await entitiesService.getAll();
Extends¶
UiPath
Constructors¶
Constructor¶
new UiPath(
config?:Partial<BaseConfig&OAuthFields& {secret:string; }>):UiPath
Parameters¶
| Parameter | Type |
|---|---|
config? |
Partial<BaseConfig & OAuthFields & { secret: string; }> |
Returns¶
UiPath
Inherited from¶
UiPathCore.constructor
Properties¶
| Property | Modifier | Type | Description |
|---|---|---|---|
~~config~~ |
readonly |
Readonly<BaseConfig> |
Read-only config for user convenience |
Accessors¶
~~assets~~¶
Get Signature¶
get assets():
AssetService
Access to Orchestrator Assets service
Returns¶
AssetService
~~buckets~~¶
Get Signature¶
get buckets():
BucketService
Access to Orchestrator Buckets service
Returns¶
BucketService
~~entities~~¶
Get Signature¶
get entities():
EntityService& {choicesets:ChoiceSetService; }
Access to Entity service
Returns¶
~~maestro~~¶
Get Signature¶
get maestro(): {
cases:CasesService& {instances:CaseInstancesService; };processes:MaestroProcessesService& {incidents:ProcessIncidentsService;instances:ProcessInstancesService; }; }
Access to Maestro services
Returns¶
~~cases~~¶
cases:
CasesService& {instances:CaseInstancesService; }
Access to Maestro Cases service
Type Declaration¶
~~instances~~¶
instances:
CaseInstancesService
Access to Case Instances service
~~processes~~¶
processes:
MaestroProcessesService& {incidents:ProcessIncidentsService;instances:ProcessInstancesService; }
Access to Maestro Processes service
Type Declaration¶
~~incidents~~¶
incidents:
ProcessIncidentsService
Access to Process Incidents service
~~instances~~¶
instances:
ProcessInstancesService
Access to Process Instances service
~~processes~~¶
Get Signature¶
get processes():
ProcessService
Access to Orchestrator Processes service
Returns¶
ProcessService
~~queues~~¶
Get Signature¶
get queues():
QueueService
Access to Orchestrator Queues service
Returns¶
QueueService
~~tasks~~¶
Get Signature¶
get tasks():
TaskService
Access to Tasks service
Returns¶
TaskService
Methods¶
~~completeOAuth()~~¶
completeOAuth():
Promise<boolean>
Complete OAuth authentication flow (only call if isInOAuthCallback() is true)
Returns¶
Promise<boolean>
Inherited from¶
UiPathCore.completeOAuth
~~getToken()~~¶
getToken():
undefined|string
Get the current authentication token
Returns¶
undefined | string
Inherited from¶
UiPathCore.getToken
~~initialize()~~¶
initialize():
Promise<void>
Initialize the SDK based on the provided configuration. This method handles both OAuth flow initiation and completion automatically. For secret-based authentication, initialization is automatic and this returns immediately. If no config was provided in constructor, loads from meta tags.
Returns¶
Promise<void>
Inherited from¶
UiPathCore.initialize
~~isAuthenticated()~~¶
isAuthenticated():
boolean
Check if the user is authenticated (has valid token)
Returns¶
boolean
Inherited from¶
UiPathCore.isAuthenticated
~~isInitialized()~~¶
isInitialized():
boolean
Check if the SDK has been initialized
Returns¶
boolean
Inherited from¶
UiPathCore.isInitialized
~~isInOAuthCallback()~~¶
isInOAuthCallback():
boolean
Check if we're in an OAuth callback state
Returns¶
boolean
Inherited from¶
UiPathCore.isInOAuthCallback
~~logout()~~¶
logout():
void
Logout from the SDK, clearing all authentication state. After calling this method, the user will need to re-initialize to authenticate again.
Returns¶
void
Inherited from¶
UiPathCore.logout
~~updateToken()~~¶
updateToken(
tokenInfo:TokenInfo):void
Updates the access token used for API requests. Use this to inject or refresh a token externally.
Parameters¶
| Parameter | Type | Description |
|---|---|---|
tokenInfo |
TokenInfo |
The token information containing the access token, type, expiration, and optional refresh token |
Returns¶
void
Inherited from¶
UiPathCore.updateToken