Class: ParmanaClient

Defined in: typescript/src/client/ParmanaClient.ts:64 Canonical Parmana SDK client.

​

Constructors

​

Constructor

new ParmanaClient(configuration): ParmanaClient

Defined in: typescript/src/client/ParmanaClient.ts:128 Creates a Parmana SDK client.

​

Parameters

configuration

Configuration

​

Returns

ParmanaClient

​

Properties

​

configuration

readonly configuration: Configuration

Defined in: typescript/src/client/ParmanaClient.ts:68 Immutable SDK configuration.

​

Methods

​

endpoint()

endpoint(): string

Defined in: typescript/src/client/ParmanaClient.ts:167 Returns the configured Runtime endpoint.

​

Returns

string

---

​

health()

health(): Promise<HealthStatus>

Defined in: typescript/src/client/ParmanaClient.ts:174 Performs a Runtime health check.

​

Returns

Promise<HealthStatus>

---

​

version()

version(): Promise<unknown>

Defined in: typescript/src/client/ParmanaClient.ts:181 Returns the Runtime name, version, and API version.

​

Returns

Promise<unknown>

---

​

execute()

execute(transaction): Promise<ExecutionTrustRecord>

Defined in: typescript/src/client/ParmanaClient.ts:188 Executes a Business Transaction.

​

Parameters

transaction

BusinessTransaction

​

Returns

Promise<ExecutionTrustRecord>

---

​

verify()

verify(businessTransactionId): Promise<Verification>

Defined in: typescript/src/client/ParmanaClient.ts:200 Runs a fresh verification of an Execution Trust Record, appending a new Verification to its history. Distinct from getLatestVerification(), which reads the most recent one without re-verifying.

​

Parameters

businessTransactionId

string

​

Returns

Promise<Verification>

---

​

getLatestVerification()

getLatestVerification(businessTransactionId): Promise<Verification>

Defined in: typescript/src/client/ParmanaClient.ts:207 Returns the latest Verification.

​

Parameters

businessTransactionId

string

​

Returns

Promise<Verification>

---

​

replay()

replay(businessTransactionId): Promise<ReplayResult>

Defined in: typescript/src/client/ParmanaClient.ts:216 Performs deterministic replay.

​

Parameters

businessTransactionId

string

​

Returns

Promise<ReplayResult>

---

​

receipt()

receipt(businessTransactionId): Promise<Receipt>

Defined in: typescript/src/client/ParmanaClient.ts:223 Generates an execution receipt.

​

Parameters

businessTransactionId

string

​

Returns

Promise<Receipt>

---

​

createTransaction()

createTransaction(transaction): Promise<ExecutionTrustRecord>

Defined in: typescript/src/client/ParmanaClient.ts:232 Creates (executes) a Business Transaction via POST /transactions, a second, independent entry point into the identical execution pipeline as execute() (POST /execute). See TransactionApi.create.

​

Parameters

transaction

BusinessTransaction

​

Returns

Promise<ExecutionTrustRecord>

---

​

transaction()

transaction(businessTransactionId): Promise<BusinessTransaction>

Defined in: typescript/src/client/ParmanaClient.ts:241 Retrieves a Business Transaction.

​

Parameters

businessTransactionId

string

​

Returns

Promise<BusinessTransaction>

---

​

transactions()

transactions(page?, pageSize?): Promise<BusinessTransaction[]>

Defined in: typescript/src/client/ParmanaClient.ts:250 Lists Business Transactions.

​

Parameters

page?

number = 1

pageSize?

number = 25

​

Returns

Promise<BusinessTransaction[]>

---

​

trustRecord()

trustRecord(businessTransactionId): Promise<ExecutionTrustRecord>

Defined in: typescript/src/client/ParmanaClient.ts:257 Retrieves an Execution Trust Record.

​

Parameters

businessTransactionId

string

​

Returns

Promise<ExecutionTrustRecord>

---

​

validatePolicy()

validatePolicy(policyId, policyVersion): Promise<PolicyValidationResult>

Defined in: typescript/src/client/ParmanaClient.ts:266 Confirms that a policy (name + version) is loadable by the Runtime.

​

Parameters

policyId

string

policyVersion

string

​

Returns

Promise<PolicyValidationResult>

---

​

refusalRecord()

refusalRecord(businessTransactionId): Promise<RefusalRecord>

Defined in: typescript/src/client/ParmanaClient.ts:276 Retrieves a Refusal Record by Business Transaction ID.

​

Parameters

businessTransactionId

string

​

Returns

Promise<RefusalRecord>

---

​

verifyRefusalRecord()

verifyRefusalRecord(record): Promise<boolean>

Defined in: typescript/src/client/ParmanaClient.ts:283 Verifies a Refusal Record’s signature.

​

Parameters

record

RefusalRecord

​

Returns

Promise<boolean>

---

​

verifyAuditEvent()

verifyAuditEvent(event, signature): Promise<boolean>

Defined in: typescript/src/client/ParmanaClient.ts:290 Verifies a signed caller-authentication audit event’s signature.

​

Parameters

event

AuditEvent

signature

Signature

​

Returns

Promise<boolean>