Members
| Name | Kind | Type | Description |
|---|---|---|---|
configuration | Property | Configuration | Immutable SDK configuration. |
toJSON | Method | () => { endpoint: string; } | |
endpoint | Method | () => string | Returns the configured Runtime endpoint. |
health | Method | () => Promise<HealthStatus> | Performs a Runtime health check. |
version | Method | () => Promise<unknown> | Returns the Runtime name, version, and API version. |
execute | Method | (transaction: BusinessTransaction) => Promise<ExecutionTrustRecord> | Executes a Business Transaction. |
verify | Method | (businessTransactionId: string) => Promise<Verification> | 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. |
getLatestVerification | Method | (businessTransactionId: string) => Promise<Verification> | Returns the latest Verification. |
replay | Method | (businessTransactionId: string) => Promise<ReplayResult> | Performs deterministic replay. |
receipt | Method | (businessTransactionId: string) => Promise<Receipt> | Generates an execution receipt. |
createTransaction | Method | (transaction: BusinessTransaction) => Promise<ExecutionTrustRecord> | Declares and then executes a Business Transaction, in two calls: POST /transactions, then POST /transactions/{id}/execute. See TransactionApi.create. |
declareTransaction | Method | (transaction: BusinessTransaction) => Promise<DeclaredTransaction> | Declares a Business Transaction (POST /transactions). See TransactionApi.declare. |
executeTransaction | Method | (businessTransactionId: string) => Promise<ExecutionTrustRecord> | Executes a declared Business Transaction. See TransactionApi.execute. |
transactionStatus | Method | (businessTransactionId: string, options?: { history?: boolean; } | undefined) => Promise<TransactionStatusResult> | Reads a Business Transaction’s status. See TransactionApi.status. |
reconcileTransaction | Method | (businessTransactionId: string) => Promise<ReconcileResult> | Reconciles a Business Transaction whose outcome is pending. See TransactionApi.reconcile. |
transaction | Method | (businessTransactionId: string) => Promise<BusinessTransaction> | Retrieves a Business Transaction. |
transactions | Method | (page?: number, pageSize?: number) => Promise<BusinessTransaction[]> | Lists Business Transactions. |
latestReceipt | Method | (businessTransactionId: string) => Promise<Receipt> | Retrieves the most recent receipt without generating a new one. |
trustRecord | Method | (businessTransactionId: string) => Promise<ExecutionTrustRecord> | Retrieves an Execution Trust Record. |
trustRecords | Method | (page?: number, pageSize?: number, options?: { readonly since?: string; readonly until?: string; }) => Promise<ExecutionTrustRecord[]> | Lists Execution Trust Records of this caller’s transactions, newest first. See TrustRecordApi.list. |
caller | Method | () => Promise<CallerIdentity> | Who this API key belongs to and what it may do (GET /callers/me). |
publicKey | Method | (keyId?: string) => Promise<PublicKeyInfo> | A signing public key of the deployment (GET /keys/{keyId}), for the offline verifiers. Records are signed with default. |
policyInEffect | Method | (capability: string) => Promise<PolicyInEffect> | The policy a request for capability must declare right now, and what the request must carry (GET /policies/in-effect). Call it before every request and declare policy exactly as returned. |
validatePolicy | Method | (policyId: string, policyVersion: string) => Promise<PolicyValidationResult> | Confirms that a policy (name + version) is loadable by the Runtime. |
refusalRecord | Method | (businessTransactionId: string) => Promise<RefusalRecord> | Retrieves a Refusal Record by Business Transaction ID. |
verifyRefusalRecord | Method | (record: RefusalRecord) => Promise<boolean> | Verifies a Refusal Record’s signature. |
executionIntent | Method | (businessTransactionId: string) => Promise<ExecutionIntentView> | Retrieves an Execution Intent and its status by Business Transaction ID (ADR-0012). The intent is the signed statement, stored before an action is released, of what was about to be released. |
verifyExecutionIntent | Method | (intent: ExecutionIntent) => Promise<boolean> | Verifies an Execution Intent’s hash and signature. Needs no credential. true proves the intent is genuine and unaltered. It does not prove the action was released, or what its result was. |
unfinalizedExecutionIntents | Method | (limit?: number | undefined) => Promise<UnfinalizedExecutionIntents> | Lists Execution Intents that never reached a signed Trust Record and were not closed by hand, oldest first. Needs a credential provisioned as a verified human. |
finalizeExecutionIntent | Method | (businessTransactionId: string) => Promise<FinalizeExecutionIntentResult> | Rebuilds the signed Trust Record for a released action whose record was never produced. Never calls a connector. Safe to run twice. Needs a credential provisioned as a verified human. |
resolveExecutionIntent | Method | (businessTransactionId: string, input: ResolveExecutionIntentInput) => Promise<ResolveExecutionIntentResult> | Closes a PREPARED or ERRORED intent that a verified human reconciled at the connector. The note is required. The resolution is an attributed operator statement in unsigned status, not a Trust Record. |
verifyAuditEvent | Method | (event: AuditEvent, signature: Signature) => Promise<boolean> | Verifies a signed caller-authentication audit event’s signature. |
proposePolicyChange | Method | (name: string, version: string, input: ProposePolicyChangeInput) => Promise<ProposedPolicyChange> | Proposes a policy change. See PolicyApi.proposeChange. |
policyChanges | Method | (status?: PendingPolicyChangeStatus | undefined) => Promise<PolicyChangeForReview[]> | Lists policy changes for review. See PolicyApi.listChanges. |
approvePolicyChange | Method | (pendingPolicyChangeId: string, stepUpAuthorization: PolicyChangeStepUpAuthorization) => Promise<PendingPolicyChange> | Approves a policy change with a signed step up authorization. See PolicyApi.approveChange and signPolicyChangeStepUp(). |
rejectPolicyChange | Method | (pendingPolicyChangeId: string, rejectionReason: string, stepUpAuthorization: PolicyChangeStepUpAuthorization) => Promise<PendingPolicyChange> | Rejects a policy change with a reason and a signed step up authorization. See PolicyApi.rejectChange. |
approvers | Method | () => Promise<ApprovalIssuer[]> | Every approver key the server trusts or trusted. See ApproverApi.list. |
proposeApproverChange | Method | (input: ProposeApproverChangeInput) => Promise<ApprovalIssuerChange> | Proposes adding or revoking an approver key. See ApproverApi.proposeChange. |
approverChanges | Method | (status?: PendingPolicyChangeStatus | undefined) => Promise<ApprovalIssuerChange[]> | Lists approver changes. See ApproverApi.listChanges. |
approveApproverChange | Method | (changeId: string, stepUpAuthorization: PolicyChangeStepUpAuthorization) => Promise<ApprovalIssuerChange> | Approves and applies an approver change. See ApproverApi.approveChange. |
rejectApproverChange | Method | (changeId: string, rejectionReason: string, stepUpAuthorization: PolicyChangeStepUpAuthorization) => Promise<ApprovalIssuerChange> | Rejects an approver change. See ApproverApi.rejectChange. |
externalConnectors | Method | () => Promise<ExternalConnector[]> | Every external connector registration, active and revoked. See ExternalConnectorApi.list. |
proposeExternalConnectorChange | Method | (input: ProposeExternalConnectorChangeInput) => Promise<ExternalConnectorChange> | Proposes registering or revoking an external connector. See ExternalConnectorApi.proposeChange. |
externalConnectorChanges | Method | (status?: PendingPolicyChangeStatus | undefined) => Promise<ExternalConnectorChange[]> | Lists external connector changes. See ExternalConnectorApi.listChanges. |
approveExternalConnectorChange | Method | (changeId: string, stepUpAuthorization: PolicyChangeStepUpAuthorization) => Promise<ExternalConnectorChange> | Approves and applies an external connector change. See ExternalConnectorApi.approveChange. |
rejectExternalConnectorChange | Method | (changeId: string, rejectionReason: string, stepUpAuthorization: PolicyChangeStepUpAuthorization) => Promise<ExternalConnectorChange> | Rejects an external connector change. See ExternalConnectorApi.rejectChange. |
businessSignalSources | Method | () => Promise<BusinessSignalSource[]> | Every business signal source registration, active and revoked. See BusinessSignalSourceApi.list. |
proposeBusinessSignalSourceChange | Method | (input: ProposeBusinessSignalSourceChangeInput) => Promise<BusinessSignalSourceChange> | Proposes registering or revoking a business signal source. See BusinessSignalSourceApi.proposeChange. |
businessSignalSourceChanges | Method | (status?: PendingPolicyChangeStatus | undefined) => Promise<BusinessSignalSourceChange[]> | Lists business signal source changes. See BusinessSignalSourceApi.listChanges. |
approveBusinessSignalSourceChange | Method | (changeId: string, stepUpAuthorization: PolicyChangeStepUpAuthorization) => Promise<BusinessSignalSourceChange> | Approves and applies a business signal source change. See BusinessSignalSourceApi.approveChange. |
rejectBusinessSignalSourceChange | Method | (changeId: string, rejectionReason: string, stepUpAuthorization: PolicyChangeStepUpAuthorization) => Promise<BusinessSignalSourceChange> | Rejects a business signal source change. See BusinessSignalSourceApi.rejectChange. |
authorityGrants | Method | () => Promise<AuthorityGrant[]> | Every authority grant, active and revoked. See AuthorityGrantApi.list. |
proposeAuthorityGrantChange | Method | (input: ProposeAuthorityGrantChangeInput) => Promise<AuthorityGrantChange> | Proposes granting or revoking an agent’s authority. See AuthorityGrantApi.proposeChange. |
authorityGrantChanges | Method | (status?: PendingPolicyChangeStatus | undefined) => Promise<AuthorityGrantChange[]> | Lists authority grant changes. See AuthorityGrantApi.listChanges. |
approveAuthorityGrantChange | Method | (changeId: string, stepUpAuthorization: PolicyChangeStepUpAuthorization) => Promise<AuthorityGrantChange> | Approves and applies an authority grant change. See AuthorityGrantApi.approveChange. |
rejectAuthorityGrantChange | Method | (changeId: string, rejectionReason: string, stepUpAuthorization: PolicyChangeStepUpAuthorization) => Promise<AuthorityGrantChange> | Rejects an authority grant change. See AuthorityGrantApi.rejectChange. |