From 6594cab94ec2ca3a88e9c6f2952f33d38dc1217a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20Javier=20Ribo=CC=81=20Labrador?= Date: Wed, 17 Apr 2024 22:09:42 +0200 Subject: [PATCH] fix: improve docs --- src/prism-agent/Agent.ts | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/prism-agent/Agent.ts b/src/prism-agent/Agent.ts index 6a353364e..080b334e9 100644 --- a/src/prism-agent/Agent.ts +++ b/src/prism-agent/Agent.ts @@ -526,6 +526,15 @@ export default class Agent * @param {Domain.DID} toDID * @param {ProofTypes[]} proofTypes[] * @returns + * + * Example usecase: Send a Presentation Request to a specific PeerDID for a Credential issued by a specific issuer + * ```ts + * agent.initiatePresentationRequest( + * Domain.CredentialType.JWT, + * toDID, + * { issuer: Domain.DID.fromString("did:peer:12345"), claims: {email: 'test@test.com'}} + * ); + * ``` */ async initiatePresentationRequest(type: Domain.CredentialType, toDID: Domain.DID, presentationClaims: Domain.PresentationClaims): Promise { const requestPresentation = await this.agentCredentials.initiatePresentationRequest(