Skip to main content
Defined in: typescript/src/client/ExecutionIntentApi.ts:16

Constructors

Constructor

new ExecutionIntentApi(transport): ExecutionIntentApi
Defined in: typescript/src/client/ExecutionIntentApi.ts:17

Parameters

transport
Transport

Returns

ExecutionIntentApi

Methods

verify()

verify(intent): Promise<boolean>
Defined in: typescript/src/client/ExecutionIntentApi.ts:29 Verifies an Execution Intent’s hash and signature. Maps to POST /execution-intents/verify. Takes the intent itself, and needs no caller authentication: like RefusalApi.verify(), it is the capability that makes the record independently third party verifiable. A true result proves the intent was signed by the holder of the key and has not been altered. It does NOT prove the action was released, or what its result was.

Parameters

intent
ExecutionIntent

Returns

Promise<boolean>

get()

get(businessTransactionId): Promise<ExecutionIntentView>
Defined in: typescript/src/client/ExecutionIntentApi.ts:44 Retrieves an Execution Intent and its status. Maps to GET /execution-intents/:businessTransactionId. Behind caller authentication and ownership scoping, like TrustRecordApi.get().

Parameters

businessTransactionId
string

Returns

Promise<ExecutionIntentView>

listUnfinalized()

listUnfinalized(limit?): Promise<UnfinalizedExecutionIntents>
Defined in: typescript/src/client/ExecutionIntentApi.ts:63 Lists intents that never reached a signed Trust Record and were not closed by hand, oldest first. Maps to GET /execution-intents/unfinalized. Requires a credential provisioned as a verified human.

Parameters

limit?
number Maximum number to return. The server default is 50 and the maximum is 200.

Returns

Promise<UnfinalizedExecutionIntents>

finalize()

finalize(businessTransactionId): Promise<FinalizeExecutionIntentResult>
Defined in: typescript/src/client/ExecutionIntentApi.ts:84 Rebuilds the signed Execution Trust Record for a released action whose record was never produced. Maps to POST /execution-intents/:businessTransactionId/finalize. It never calls a connector and is safe to run twice. Requires a credential provisioned as a verified human.

Parameters

businessTransactionId
string

Returns

Promise<FinalizeExecutionIntentResult>

resolve()

resolve(businessTransactionId, input): Promise<ResolveExecutionIntentResult>
Defined in: typescript/src/client/ExecutionIntentApi.ts:103 Closes a PREPARED or ERRORED intent that a verified human reconciled at the connector. Maps to POST /execution-intents/:businessTransactionId/resolve. The note is required. It never calls a connector and is idempotent. The resolution is an attributed operator statement in unsigned status. It is NOT tamper evident and it is NOT a Trust Record.

Parameters

businessTransactionId
string
input
ResolveExecutionIntentInput

Returns

Promise<ResolveExecutionIntentResult>