Class SystemClient

Unauthenticated platform connectivity and health probes.

Index

Constructors

Methods

health platformVersion testConnection

Constructors

constructor

new SystemClient(call: Caller): SystemClient
Parameters
- call: Caller
Returns SystemClient
- Defined in src/resources/system.ts:43

Methods

health

health(opts?: RequestOptions): Promise<HealthStatus>
Backend health endpoint (GET /health — unauthenticated).
Parameters
- Optionalopts: RequestOptions
Returns Promise<HealthStatus>
- Defined in src/resources/system.ts:51

platformVersion

platformVersion(opts?: RequestOptions): Promise<PlatformVersion>
Platform + backend version (GET /platform/version — unauthenticated).
Parameters
- Optionalopts: RequestOptions
Returns Promise<PlatformVersion>
- Defined in src/resources/system.ts:56

testConnection

testConnection(opts?: RequestOptions): Promise<TestConnectionResult>
API connectivity smoke test (GET /test — unauthenticated).
Parameters
- Optionalopts: RequestOptions
Returns Promise<TestConnectionResult>
- Defined in src/resources/system.ts:46