@triveria/wallet 0.0.285 → 0.0.289

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/api.js CHANGED
@@ -3,7 +3,7 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Triveria Wallet API
6
- * Triveria Wallet API.
6
+ * Triveria Wallet is a cloud-based platform for managing digital credentials. The platform complies with open standards including the W3C Verifiable Credentials Data Model, IETF SD-JWT-VC, OpenID Connect (OIDC), and EBSI DID, providing a unified interface across both eIDAS/EUDI and DID/W3C ecosystems. **Key capabilities:** - Issue and manage Verifiable Credentials (W3C VC and SD-JWT-VC formats) - Credential signing using DIDs, X.509 certificates, and standard JWK keys - Trust framework integration: EBSI Trust Framework, EUDI Large Scale Pilot trust lists, and IDUnion - REST API and SDK access for seamless integration For access and support, contact info@triveria.com.
7
7
  *
8
8
  * The version of the OpenAPI document: 1.0.0
9
9
  *
@@ -35,45 +35,45 @@ const base_1 = require("./base");
35
35
  exports.AccreditationRequestTypeEnum = {
36
36
  TrustedIssuer: 'TrustedIssuer',
37
37
  TrustedAccreditationOrganisation: 'TrustedAccreditationOrganisation',
38
- RootTrustedAccreditationOrganisation: 'RootTrustedAccreditationOrganisation'
38
+ RootTrustedAccreditationOrganisation: 'RootTrustedAccreditationOrganisation',
39
39
  };
40
40
  /**
41
41
  * jwt_vc_vcdm - VC using W3C VC Data Model as jwt sd_jwt_vc - VC using sd_jwt_vc data model as jwt
42
42
  */
43
43
  exports.CredentialFormat = {
44
44
  SdJwtVc: 'sd_jwt_vc',
45
- JwtVcVcdm: 'jwt_vc_vcdm'
45
+ JwtVcVcdm: 'jwt_vc_vcdm',
46
46
  };
47
47
  exports.CredentialIssuerDefinitionCredentialIssuerEnum = {
48
48
  CtWalletSame: 'CtWalletSame',
49
49
  CtRevocable: 'CtRevocable',
50
50
  IssuanceQueue: 'IssuanceQueue',
51
51
  VpDriven: 'VPDriven',
52
- CredentialRequirements: 'CredentialRequirements'
52
+ CredentialRequirements: 'CredentialRequirements',
53
53
  };
54
54
  exports.CredentialIssuerDefinitionAuthorizationEnum = {
55
55
  None: 'none',
56
56
  OauthNoAuth: 'oauthNoAuth',
57
57
  OauthCustom: 'oauthCustom',
58
58
  Openid: 'openid',
59
- OpenidCustom: 'openidCustom'
59
+ OpenidCustom: 'openidCustom',
60
60
  };
61
61
  exports.CredentialMetadataInteractionEnum = {
62
62
  Issuance: 'issuance',
63
63
  Receive: 'receive',
64
64
  StatusList: 'statusList',
65
- TaoCredentials: 'taoCredentials'
65
+ TaoCredentials: 'taoCredentials',
66
66
  };
67
67
  exports.CredentialMetadataStatusEnum = {
68
68
  Draft: 'draft',
69
69
  Valid: 'valid',
70
- Invalid: 'invalid'
70
+ Invalid: 'invalid',
71
71
  };
72
72
  exports.CredentialNotificationEventTypeEnum = {
73
73
  CredentialCreated: 'credential.created',
74
74
  CredentialIssued: 'credential.issued',
75
75
  CredentialReceived: 'credential.received',
76
- CredentialRevoked: 'credential.revoked'
76
+ CredentialRevoked: 'credential.revoked',
77
77
  };
78
78
  /**
79
79
  * Credential property that will be verified. `verifySchema` is only applicable in W3C VCDM credentials. With other types, this field will be ignored.
@@ -81,78 +81,78 @@ exports.CredentialNotificationEventTypeEnum = {
81
81
  exports.CredentialPropertyToVerify = {
82
82
  VerifyExpiration: 'verifyExpiration',
83
83
  VerifyStatus: 'verifyStatus',
84
- VerifySchema: 'verifySchema'
84
+ VerifySchema: 'verifySchema',
85
85
  };
86
86
  exports.DeferredStatusEnum = {
87
87
  InProgress: 'in_progress',
88
88
  Completed: 'completed',
89
- Error: 'error'
89
+ Error: 'error',
90
90
  };
91
91
  exports.DocumentSignatureValidityVerificationResultEnum = {
92
92
  Valid: 'valid',
93
93
  InvalidSignature: 'invalid_signature',
94
94
  Revoked: 'revoked',
95
95
  Expired: 'expired',
96
- UntrustedCertificate: 'untrusted_certificate'
96
+ UntrustedCertificate: 'untrusted_certificate',
97
97
  };
98
98
  exports.EntityAccreditationRequestTypeEnum = {
99
99
  TrustedIssuer: 'TrustedIssuer',
100
- TrustedAccreditationOrganisation: 'TrustedAccreditationOrganisation'
100
+ TrustedAccreditationOrganisation: 'TrustedAccreditationOrganisation',
101
101
  };
102
102
  exports.HealthStatusStatusEnum = {
103
103
  Ok: 'ok',
104
104
  Limited: 'limited',
105
- Critical: 'critical'
105
+ Critical: 'critical',
106
106
  };
107
107
  exports.InteractionAuthorizationRequirementsRequirementTypeEnum = {
108
108
  None: 'none',
109
109
  IdToken: 'id_token',
110
110
  VpToken: 'vp_token',
111
111
  Pin: 'pin',
112
- Custom: 'custom'
112
+ Custom: 'custom',
113
113
  };
114
114
  /**
115
115
  * Sort flag controls the sort direction by the time created
116
116
  */
117
117
  exports.ListSort = {
118
118
  Asc: 'asc',
119
- Desc: 'desc'
119
+ Desc: 'desc',
120
120
  };
121
121
  exports.ObjectHorizontalAlignment = {
122
122
  Left: 'left',
123
123
  Center: 'center',
124
- Right: 'right'
124
+ Right: 'right',
125
125
  };
126
126
  exports.ObjectVerticalAlignment = {
127
127
  Top: 'top',
128
128
  Middle: 'middle',
129
- Bottom: 'bottom'
129
+ Bottom: 'bottom',
130
130
  };
131
131
  exports.OidcRevisionOidc4vciEnum = {
132
132
  Draft11: 'Draft11',
133
- Draft15: 'Draft15'
133
+ Draft15: 'Draft15',
134
134
  };
135
135
  exports.OidcRevisionOidc4vpEnum = {
136
136
  Draft16: 'Draft16',
137
- Draft23: 'Draft23'
137
+ Draft23: 'Draft23',
138
138
  };
139
139
  exports.PresentationDefinitionSubmissionRequirementsRuleEnum = {
140
140
  All: 'all',
141
- Pick: 'pick'
141
+ Pick: 'pick',
142
142
  };
143
143
  exports.RevokeAccreditationRequestTypeEnum = {
144
144
  TrustedIssuer: 'TrustedIssuer',
145
- TrustedAccreditationOrganisation: 'TrustedAccreditationOrganisation'
145
+ TrustedAccreditationOrganisation: 'TrustedAccreditationOrganisation',
146
146
  };
147
147
  exports.SigningKeyIdentifier = {
148
148
  Did: 'did',
149
149
  Jwk: 'jwk',
150
- X509: 'x509'
150
+ X509: 'x509',
151
151
  };
152
152
  exports.SystemImpactStatusEnum = {
153
153
  Ok: 'ok',
154
154
  Limited: 'limited',
155
- Critical: 'critical'
155
+ Critical: 'critical',
156
156
  };
157
157
  /**
158
158
  * What trust framework should we use with this wallet. This property COULD NOT change later. Supported frameworks: EBSI - the European Blockchain Services Infrastructure, IDTL - IDUnion Trust List, EUDI - European Digital Identity wallet, Noop - personal key based no-op trust framework (mainly for the personal use)
@@ -161,7 +161,7 @@ exports.TrustFrameworkType = {
161
161
  Ebsi: 'EBSI',
162
162
  Idtl: 'IDTL',
163
163
  Noop: 'NOOP',
164
- Eudi: 'EUDI'
164
+ Eudi: 'EUDI',
165
165
  };
166
166
  /**
167
167
  * Defines the capabilities which the wallet has. It may be any of \"holder\", \"issuer\" and \"verifier\".
@@ -169,7 +169,7 @@ exports.TrustFrameworkType = {
169
169
  exports.WalletCapability = {
170
170
  Holder: 'holder',
171
171
  Issuer: 'issuer',
172
- Verifier: 'verifier'
172
+ Verifier: 'verifier',
173
173
  };
174
174
  exports.WalletNotificationEventType = {
175
175
  VpVerified: 'vp.verified',
@@ -185,15 +185,15 @@ exports.WalletNotificationEventType = {
185
185
  WmpInvitationAccepted: 'wmp.invitation_accepted',
186
186
  WmpCredentialOffer: 'wmp.credential_offer',
187
187
  WmpCredentialVerificationRequest: 'wmp.credential_verification_request',
188
- WmpError: 'wmp.error'
188
+ WmpError: 'wmp.error',
189
189
  };
190
190
  exports.WmpRequestType = {
191
191
  CredentialOffer: 'credentialOffer',
192
- CredentialVerificationRequest: 'credentialVerificationRequest'
192
+ CredentialVerificationRequest: 'credentialVerificationRequest',
193
193
  };
194
194
  exports.XadesSignatureType = {
195
195
  Tsl: 'tsl',
196
- Xml: 'xml'
196
+ Xml: 'xml',
197
197
  };
198
198
  /**
199
199
  * DefaultApi - axios parameter creator
@@ -577,7 +577,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
577
577
  };
578
578
  }),
579
579
  /**
580
- *
580
+ * Polls the status of a deferred credential issuance. Returns `in_progress` while the operation is still pending, or `completed` with the resulting credential ID when done. Clients should poll this endpoint until a terminal status is reached.
581
581
  * @param {string} deferredId Deferred token
582
582
  * @param {string} walletId
583
583
  * @param {*} [options] Override http request option.
@@ -644,7 +644,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
644
644
  };
645
645
  }),
646
646
  /**
647
- *
647
+ * Checks the health status of the service and its subsystems (database, storage, etc.). Used by load balancers and monitoring systems.
648
648
  * @param {*} [options] Override http request option.
649
649
  * @throws {RequiredError}
650
650
  */
@@ -706,7 +706,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
706
706
  };
707
707
  }),
708
708
  /**
709
- * Presenting Verifiable Credentials after holder\'s consent.
709
+ * Completes a credential presentation flow: submits the selected credentials to the verifier after the holder\'s explicit consent. The `interaction_id` is obtained from `HolderPresentPassAuthInfo`.
710
710
  * @param {string} walletId
711
711
  * @param {string} interactionId
712
712
  * @param {InteractionAuthorizationConsent} [interactionAuthorizationConsent]
@@ -859,7 +859,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
859
859
  };
860
860
  }),
861
861
  /**
862
- *
862
+ * Returns metadata and content of a specific linked Verifiable Presentation, including the credentials it contains and its DID document service entry URL.
863
863
  * @param {string} walletId
864
864
  * @param {string} linkedVpId
865
865
  * @param {*} [options] Override http request option.
@@ -897,7 +897,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
897
897
  };
898
898
  }),
899
899
  /**
900
- *
900
+ * Returns all linked Verifiable Presentations published in the wallet\'s DID document,
901
901
  * @param {string} walletId
902
902
  * @param {*} [options] Override http request option.
903
903
  * @throws {RequiredError}
@@ -931,7 +931,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
931
931
  };
932
932
  }),
933
933
  /**
934
- * Retrieve authorization requirements for the credential offer.
934
+ * Processes a credential offer URL (received from an issuer via QR code, deep link, or WMP) and returns what authorization is required to accept it - pin, credential presentation or a redirect to custom authorization flow. holder needs to present to the issuer, along with matching candidates from the wallet. The returned `interactionId` is used in the subsequent `HolderOfferProcessAfterConsent` call.
935
935
  * @param {string} walletId
936
936
  * @param {VcOffer} [vcOffer] Verifiable Credential offer
937
937
  * @param {*} [options] Override http request option.
@@ -968,7 +968,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
968
968
  };
969
969
  }),
970
970
  /**
971
- * Gives consent to process credential offer specified by `interaction_id`
971
+ * Completes a credential offer flow after holder consent: submits data needed for the holder to authorize candidates to the issuer for holder authorization and retrieves the issued credential(s) into the wallet. The `interaction_id` is obtained from `HolderOfferPassAuthInfo`.
972
972
  * @param {string} walletId
973
973
  * @param {string} interactionId
974
974
  * @param {InteractionAuthorizationConsent} [interactionAuthorizationConsent]
@@ -1009,7 +1009,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
1009
1009
  };
1010
1010
  }),
1011
1011
  /**
1012
- * Initiates a presentation of credentials to a verifier.
1012
+ * Processes a verifier\'s presentation request URL and returns the presentation definition along with matching credential candidates from the wallet. The holder reviews which credentials will be disclosed before giving consent. The returned `interactionId` is used in the subsequent `HolderCredentialsPresentAfterConsent` call.
1013
1013
  * @param {string} walletId
1014
1014
  * @param {PresentationRequest} [presentationRequest]
1015
1015
  * @param {*} [options] Override http request option.
@@ -1046,7 +1046,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
1046
1046
  };
1047
1047
  }),
1048
1048
  /**
1049
- * Creates an ID token request.
1049
+ * Creates an ID token request that will be sent to the holder for DID-based authentication. Used during the authorized credential issuance flow when the issuer requires the holder to prove control of their DID before the credential is issued. The returned request ID is passed to `CredentialIssuanceInit` as `idTokenRequestId`.
1050
1050
  * @param {string} walletId
1051
1051
  * @param {*} [options] Override http request option.
1052
1052
  * @throws {RequiredError}
@@ -1114,7 +1114,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
1114
1114
  };
1115
1115
  }),
1116
1116
  /**
1117
- * Initiates issuing of Verifiable Credentials using authorized flow.
1117
+ * Generates an authorized credential offer URL for the holder to initiate the credential issuance flow. The resulting offer URL is typically presented as a QR code or deep link. If `wmpEntityId` is provided, the offer is delivered directly via WMP and 204 is returned.
1118
1118
  * @param {string} walletId
1119
1119
  * @param {InitAuthOffer} [initAuthOffer]
1120
1120
  * @param {*} [options] Override http request option.
@@ -1151,7 +1151,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
1151
1151
  };
1152
1152
  }),
1153
1153
  /**
1154
- * Initiates issuing of Verifiable Credentials using pre-authorized flow.
1154
+ * Generates a pre-authorized credential offer for the holder. Unlike the authorized flow, the holder does not need to authenticate with the issuer — instead a pre-authorized code (and optional PIN) is embedded in the offer URL. The resulting offer URL is returned and Generates a pre-authorized credential offer for the holder. The resulting offer URL is returned and can be shared as a QR code or deep link.
1155
1155
  * @param {string} walletId
1156
1156
  * @param {InitPreAuthOffer} [initPreAuthOffer]
1157
1157
  * @param {*} [options] Override http request option.
@@ -1400,7 +1400,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
1400
1400
  };
1401
1401
  }),
1402
1402
  /**
1403
- * Accredits a legal entity as RTAO, TAO or TI.
1403
+ * Accredits a legal entity as RTAO (Root Trust Anchor Organisation), TAO (Trust Anchor Organisation), or TI (Trusted Issuer) within the trust framework hierarchy by issuing the appropriate accreditation credential to their DID.
1404
1404
  * @param {string} walletId
1405
1405
  * @param {AccreditationRequest} [accreditationRequest]
1406
1406
  * @param {*} [options] Override http request option.
@@ -1437,7 +1437,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
1437
1437
  };
1438
1438
  }),
1439
1439
  /**
1440
- * Processes a request to accredit another legal entity.
1440
+ * Used by a TAO/RTAO wallet to process and approve an incoming accreditation request from another legal entity. Issues an accreditation credential authorizing the entity to issue credentials of the specified type within the trust framework.
1441
1441
  * @param {string} walletId
1442
1442
  * @param {EntityAccreditationRequest} [entityAccreditationRequest]
1443
1443
  * @param {*} [options] Override http request option.
@@ -1474,7 +1474,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
1474
1474
  };
1475
1475
  }),
1476
1476
  /**
1477
- * Onboards legal entity to the trust framework based on the wallet configuration.
1477
+ * Completes the trust framework onboarding of this wallet using the specified onboarding credential. After successful onboarding, the wallet\'s DID is registered in the trust framework\'s TAO/TI hierarchy, enabling it to issue or verify trust-framework credentials.
1478
1478
  * @param {string} walletId
1479
1479
  * @param {OnboardingRequest} [onboardingRequest]
1480
1480
  * @param {*} [options] Override http request option.
@@ -1511,7 +1511,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
1511
1511
  };
1512
1512
  }),
1513
1513
  /**
1514
- * Processes a request to onboard another legal entity.
1514
+ * Used by a TAO/RTAO wallet to process and approve an incoming onboarding request from another legal entity. Issues an onboarding credential (TIA) to the requesting entity, registering them in the trust framework.
1515
1515
  * @param {string} walletId
1516
1516
  * @param {EntityOnboardingRequest} [entityOnboardingRequest]
1517
1517
  * @param {*} [options] Override http request option.
@@ -1548,7 +1548,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
1548
1548
  };
1549
1549
  }),
1550
1550
  /**
1551
- * Revokes another legal entity\'s wallet DID accreditation.
1551
+ * Revokes another legal entity\'s accreditation or trust framework registration by invalidating their credential in the trust status list.
1552
1552
  * @param {string} walletId
1553
1553
  * @param {RevokeAccreditationRequest} [revokeAccreditationRequest]
1554
1554
  * @param {*} [options] Override http request option.
@@ -1585,7 +1585,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
1585
1585
  };
1586
1586
  }),
1587
1587
  /**
1588
- * Issues a certificate based on the provided certificate request
1588
+ * Issues a signed X509 certificate based on the provided CSR. Used by a CA-capable wallet to sign certificate requests from other wallets, enabling them to sign credentials with X509 certificate echains and/or perform XAdES/PDF signing.
1589
1589
  * @param {string} walletId
1590
1590
  * @param {CertificateIssueRequest} [certificateIssueRequest]
1591
1591
  * @param {*} [options] Override http request option.
@@ -1622,7 +1622,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
1622
1622
  };
1623
1623
  }),
1624
1624
  /**
1625
- * Returns an url where verifier accepts presentations from a holder.
1625
+ * Creates a verification session and returns a URL where the verifier accepts credential presentations from a holder. The URL is typically shared as a QR code or deep link. After the holder presents credentials, use `WalletVerifiedCredentialsByState` with the returned `state` to retrieve the verification result.
1626
1626
  * @param {string} walletId
1627
1627
  * @param {VerifyInitRequest} [verifyInitRequest]
1628
1628
  * @param {*} [options] Override http request option.
@@ -1853,7 +1853,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
1853
1853
  };
1854
1854
  }),
1855
1855
  /**
1856
- *
1856
+ * Returns the wallet\'s public identifier — e.g. a DID (Decentralized Identifier) or a wallet URL. Used by other parties to reference this wallet in trust framework interactions and credential exchanges.
1857
1857
  * @param {string} walletId
1858
1858
  * @param {*} [options] Override http request option.
1859
1859
  * @throws {RequiredError}
@@ -2114,7 +2114,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
2114
2114
  };
2115
2115
  }),
2116
2116
  /**
2117
- * Gets a specific verified credentials by state
2117
+ * Retrieves the result of a credential verification session identified by the verifier state. Called by the verifier after a holder has presented credentials in response to a `VerifierInitUrlCreate` request. Returns 204 if the holder has not yet presented.
2118
2118
  * @param {string} walletId Wallet ID
2119
2119
  * @param {string} state Verifier state
2120
2120
  * @param {*} [options] Override http request option.
@@ -2186,7 +2186,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
2186
2186
  };
2187
2187
  }),
2188
2188
  /**
2189
- * Creates a X509 certificate signing request for signing key.
2189
+ * Creates an X509 Certificate Signing Request (CSR) for the wallet\'s signing key. The resulting certificate is imported back via `WalletX509CertificateImport` to enable issuing credentials signed by X509 certificate chain it or XAdES/PDF signing.
2190
2190
  * @param {string} walletId Wallet ID
2191
2191
  * @param {CSRCreateRequest} [cSRCreateRequest]
2192
2192
  * @param {*} [options] Override http request option.
@@ -2221,7 +2221,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
2221
2221
  };
2222
2222
  }),
2223
2223
  /**
2224
- * Returns an X509 certificate in PEM format
2224
+ * Returns the wallet\'s currently active X509 certificate in PEM format, used for XAdES/PDF signing. certificate for signature verification.
2225
2225
  * @param {string} walletId Wallet ID
2226
2226
  * @param {*} [options] Override http request option.
2227
2227
  * @throws {RequiredError}
@@ -2285,7 +2285,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
2285
2285
  };
2286
2286
  }),
2287
2287
  /**
2288
- * Accepts a WMP invitation
2288
+ * Accepts a WMP invitation URL from another wallet (issuer or verifier) to establish a peer-to-peer WMP connection. After acceptance, the connected entity appears in the WMP entity list and can send credential offers or verification requests directly to this wallet.
2289
2289
  * @param {string} walletId
2290
2290
  * @param {WmpAcceptInvitationPayload} [wmpAcceptInvitationPayload]
2291
2291
  * @param {*} [options] Override http request option.
@@ -2356,7 +2356,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
2356
2356
  };
2357
2357
  }),
2358
2358
  /**
2359
- * Process WMP request
2359
+ * Processes a pending WMP request (credential offer or credential verification request) received from a connected WMP server entity. Returns the authorization requirements that must be satisfied — used as the entry point into the offer or presentation flow instead of passing a URL to `HolderOfferPassAuthInfo` or `HolderPresentPassAuthInfo`.
2360
2360
  * @param {string} walletId
2361
2361
  * @param {string} requestId
2362
2362
  * @param {*} [options] Override http request option.
@@ -2394,7 +2394,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
2394
2394
  };
2395
2395
  }),
2396
2396
  /**
2397
- * Creates a new WMP invitation
2397
+ * Creates a WMP (Wallet Messaging Protocol) invitation URL that can be shared with another wallet to establish a secure peer-to-peer communication channel. Issuers and verifiers use this to connect with holder wallets for direct credential delivery and verification without requiring QR codes or redirects on each interaction.
2398
2398
  * @param {string} walletId
2399
2399
  * @param {*} [options] Override http request option.
2400
2400
  * @throws {RequiredError}
@@ -2542,7 +2542,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
2542
2542
  };
2543
2543
  }),
2544
2544
  /**
2545
- * Get all clients that have established WMP connection.
2545
+ * Lists all wallets that have established a WMP connection with this wallet. Filter by `entityType=server` for entities that created the invitation (issuers/verifiers), or `entityType=client` for entities that accepted it (holders).
2546
2546
  * @param {string} walletId
2547
2547
  * @param {WmpEntityListEntityTypeEnum} entityType
2548
2548
  * @param {*} [options] Override http request option.
@@ -2582,7 +2582,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
2582
2582
  };
2583
2583
  }),
2584
2584
  /**
2585
- * Connect to a WMP server entity
2585
+ * Re-establishes or confirms the WebSocket connection to a WMP server entity. Used to reconnect after a dropped connection so the wallet can resume receiving pending requests.
2586
2586
  * @param {string} walletId
2587
2587
  * @param {string} entityId
2588
2588
  * @param {*} [options] Override http request option.
@@ -2783,7 +2783,7 @@ const DefaultApiFp = function (configuration) {
2783
2783
  });
2784
2784
  },
2785
2785
  /**
2786
- *
2786
+ * Polls the status of a deferred credential issuance. Returns `in_progress` while the operation is still pending, or `completed` with the resulting credential ID when done. Clients should poll this endpoint until a terminal status is reached.
2787
2787
  * @param {string} deferredId Deferred token
2788
2788
  * @param {string} walletId
2789
2789
  * @param {*} [options] Override http request option.
@@ -2814,7 +2814,7 @@ const DefaultApiFp = function (configuration) {
2814
2814
  });
2815
2815
  },
2816
2816
  /**
2817
- *
2817
+ * Checks the health status of the service and its subsystems (database, storage, etc.). Used by load balancers and monitoring systems.
2818
2818
  * @param {*} [options] Override http request option.
2819
2819
  * @throws {RequiredError}
2820
2820
  */
@@ -2844,7 +2844,7 @@ const DefaultApiFp = function (configuration) {
2844
2844
  });
2845
2845
  },
2846
2846
  /**
2847
- * Presenting Verifiable Credentials after holder\'s consent.
2847
+ * Completes a credential presentation flow: submits the selected credentials to the verifier after the holder\'s explicit consent. The `interaction_id` is obtained from `HolderPresentPassAuthInfo`.
2848
2848
  * @param {string} walletId
2849
2849
  * @param {string} interactionId
2850
2850
  * @param {InteractionAuthorizationConsent} [interactionAuthorizationConsent]
@@ -2909,7 +2909,7 @@ const DefaultApiFp = function (configuration) {
2909
2909
  });
2910
2910
  },
2911
2911
  /**
2912
- *
2912
+ * Returns metadata and content of a specific linked Verifiable Presentation, including the credentials it contains and its DID document service entry URL.
2913
2913
  * @param {string} walletId
2914
2914
  * @param {string} linkedVpId
2915
2915
  * @param {*} [options] Override http request option.
@@ -2925,7 +2925,7 @@ const DefaultApiFp = function (configuration) {
2925
2925
  });
2926
2926
  },
2927
2927
  /**
2928
- *
2928
+ * Returns all linked Verifiable Presentations published in the wallet\'s DID document,
2929
2929
  * @param {string} walletId
2930
2930
  * @param {*} [options] Override http request option.
2931
2931
  * @throws {RequiredError}
@@ -2940,7 +2940,7 @@ const DefaultApiFp = function (configuration) {
2940
2940
  });
2941
2941
  },
2942
2942
  /**
2943
- * Retrieve authorization requirements for the credential offer.
2943
+ * Processes a credential offer URL (received from an issuer via QR code, deep link, or WMP) and returns what authorization is required to accept it - pin, credential presentation or a redirect to custom authorization flow. holder needs to present to the issuer, along with matching candidates from the wallet. The returned `interactionId` is used in the subsequent `HolderOfferProcessAfterConsent` call.
2944
2944
  * @param {string} walletId
2945
2945
  * @param {VcOffer} [vcOffer] Verifiable Credential offer
2946
2946
  * @param {*} [options] Override http request option.
@@ -2956,7 +2956,7 @@ const DefaultApiFp = function (configuration) {
2956
2956
  });
2957
2957
  },
2958
2958
  /**
2959
- * Gives consent to process credential offer specified by `interaction_id`
2959
+ * Completes a credential offer flow after holder consent: submits data needed for the holder to authorize candidates to the issuer for holder authorization and retrieves the issued credential(s) into the wallet. The `interaction_id` is obtained from `HolderOfferPassAuthInfo`.
2960
2960
  * @param {string} walletId
2961
2961
  * @param {string} interactionId
2962
2962
  * @param {InteractionAuthorizationConsent} [interactionAuthorizationConsent]
@@ -2973,7 +2973,7 @@ const DefaultApiFp = function (configuration) {
2973
2973
  });
2974
2974
  },
2975
2975
  /**
2976
- * Initiates a presentation of credentials to a verifier.
2976
+ * Processes a verifier\'s presentation request URL and returns the presentation definition along with matching credential candidates from the wallet. The holder reviews which credentials will be disclosed before giving consent. The returned `interactionId` is used in the subsequent `HolderCredentialsPresentAfterConsent` call.
2977
2977
  * @param {string} walletId
2978
2978
  * @param {PresentationRequest} [presentationRequest]
2979
2979
  * @param {*} [options] Override http request option.
@@ -2989,7 +2989,7 @@ const DefaultApiFp = function (configuration) {
2989
2989
  });
2990
2990
  },
2991
2991
  /**
2992
- * Creates an ID token request.
2992
+ * Creates an ID token request that will be sent to the holder for DID-based authentication. Used during the authorized credential issuance flow when the issuer requires the holder to prove control of their DID before the credential is issued. The returned request ID is passed to `CredentialIssuanceInit` as `idTokenRequestId`.
2993
2993
  * @param {string} walletId
2994
2994
  * @param {*} [options] Override http request option.
2995
2995
  * @throws {RequiredError}
@@ -3019,7 +3019,7 @@ const DefaultApiFp = function (configuration) {
3019
3019
  });
3020
3020
  },
3021
3021
  /**
3022
- * Initiates issuing of Verifiable Credentials using authorized flow.
3022
+ * Generates an authorized credential offer URL for the holder to initiate the credential issuance flow. The resulting offer URL is typically presented as a QR code or deep link. If `wmpEntityId` is provided, the offer is delivered directly via WMP and 204 is returned.
3023
3023
  * @param {string} walletId
3024
3024
  * @param {InitAuthOffer} [initAuthOffer]
3025
3025
  * @param {*} [options] Override http request option.
@@ -3035,7 +3035,7 @@ const DefaultApiFp = function (configuration) {
3035
3035
  });
3036
3036
  },
3037
3037
  /**
3038
- * Initiates issuing of Verifiable Credentials using pre-authorized flow.
3038
+ * Generates a pre-authorized credential offer for the holder. Unlike the authorized flow, the holder does not need to authenticate with the issuer — instead a pre-authorized code (and optional PIN) is embedded in the offer URL. The resulting offer URL is returned and Generates a pre-authorized credential offer for the holder. The resulting offer URL is returned and can be shared as a QR code or deep link.
3039
3039
  * @param {string} walletId
3040
3040
  * @param {InitPreAuthOffer} [initPreAuthOffer]
3041
3041
  * @param {*} [options] Override http request option.
@@ -3134,7 +3134,7 @@ const DefaultApiFp = function (configuration) {
3134
3134
  });
3135
3135
  },
3136
3136
  /**
3137
- * Accredits a legal entity as RTAO, TAO or TI.
3137
+ * Accredits a legal entity as RTAO (Root Trust Anchor Organisation), TAO (Trust Anchor Organisation), or TI (Trusted Issuer) within the trust framework hierarchy by issuing the appropriate accreditation credential to their DID.
3138
3138
  * @param {string} walletId
3139
3139
  * @param {AccreditationRequest} [accreditationRequest]
3140
3140
  * @param {*} [options] Override http request option.
@@ -3150,7 +3150,7 @@ const DefaultApiFp = function (configuration) {
3150
3150
  });
3151
3151
  },
3152
3152
  /**
3153
- * Processes a request to accredit another legal entity.
3153
+ * Used by a TAO/RTAO wallet to process and approve an incoming accreditation request from another legal entity. Issues an accreditation credential authorizing the entity to issue credentials of the specified type within the trust framework.
3154
3154
  * @param {string} walletId
3155
3155
  * @param {EntityAccreditationRequest} [entityAccreditationRequest]
3156
3156
  * @param {*} [options] Override http request option.
@@ -3166,7 +3166,7 @@ const DefaultApiFp = function (configuration) {
3166
3166
  });
3167
3167
  },
3168
3168
  /**
3169
- * Onboards legal entity to the trust framework based on the wallet configuration.
3169
+ * Completes the trust framework onboarding of this wallet using the specified onboarding credential. After successful onboarding, the wallet\'s DID is registered in the trust framework\'s TAO/TI hierarchy, enabling it to issue or verify trust-framework credentials.
3170
3170
  * @param {string} walletId
3171
3171
  * @param {OnboardingRequest} [onboardingRequest]
3172
3172
  * @param {*} [options] Override http request option.
@@ -3182,7 +3182,7 @@ const DefaultApiFp = function (configuration) {
3182
3182
  });
3183
3183
  },
3184
3184
  /**
3185
- * Processes a request to onboard another legal entity.
3185
+ * Used by a TAO/RTAO wallet to process and approve an incoming onboarding request from another legal entity. Issues an onboarding credential (TIA) to the requesting entity, registering them in the trust framework.
3186
3186
  * @param {string} walletId
3187
3187
  * @param {EntityOnboardingRequest} [entityOnboardingRequest]
3188
3188
  * @param {*} [options] Override http request option.
@@ -3198,7 +3198,7 @@ const DefaultApiFp = function (configuration) {
3198
3198
  });
3199
3199
  },
3200
3200
  /**
3201
- * Revokes another legal entity\'s wallet DID accreditation.
3201
+ * Revokes another legal entity\'s accreditation or trust framework registration by invalidating their credential in the trust status list.
3202
3202
  * @param {string} walletId
3203
3203
  * @param {RevokeAccreditationRequest} [revokeAccreditationRequest]
3204
3204
  * @param {*} [options] Override http request option.
@@ -3214,7 +3214,7 @@ const DefaultApiFp = function (configuration) {
3214
3214
  });
3215
3215
  },
3216
3216
  /**
3217
- * Issues a certificate based on the provided certificate request
3217
+ * Issues a signed X509 certificate based on the provided CSR. Used by a CA-capable wallet to sign certificate requests from other wallets, enabling them to sign credentials with X509 certificate echains and/or perform XAdES/PDF signing.
3218
3218
  * @param {string} walletId
3219
3219
  * @param {CertificateIssueRequest} [certificateIssueRequest]
3220
3220
  * @param {*} [options] Override http request option.
@@ -3230,7 +3230,7 @@ const DefaultApiFp = function (configuration) {
3230
3230
  });
3231
3231
  },
3232
3232
  /**
3233
- * Returns an url where verifier accepts presentations from a holder.
3233
+ * Creates a verification session and returns a URL where the verifier accepts credential presentations from a holder. The URL is typically shared as a QR code or deep link. After the holder presents credentials, use `WalletVerifiedCredentialsByState` with the returned `state` to retrieve the verification result.
3234
3234
  * @param {string} walletId
3235
3235
  * @param {VerifyInitRequest} [verifyInitRequest]
3236
3236
  * @param {*} [options] Override http request option.
@@ -3327,7 +3327,7 @@ const DefaultApiFp = function (configuration) {
3327
3327
  });
3328
3328
  },
3329
3329
  /**
3330
- *
3330
+ * Returns the wallet\'s public identifier — e.g. a DID (Decentralized Identifier) or a wallet URL. Used by other parties to reference this wallet in trust framework interactions and credential exchanges.
3331
3331
  * @param {string} walletId
3332
3332
  * @param {*} [options] Override http request option.
3333
3333
  * @throws {RequiredError}
@@ -3441,7 +3441,7 @@ const DefaultApiFp = function (configuration) {
3441
3441
  });
3442
3442
  },
3443
3443
  /**
3444
- * Gets a specific verified credentials by state
3444
+ * Retrieves the result of a credential verification session identified by the verifier state. Called by the verifier after a holder has presented credentials in response to a `VerifierInitUrlCreate` request. Returns 204 if the holder has not yet presented.
3445
3445
  * @param {string} walletId Wallet ID
3446
3446
  * @param {string} state Verifier state
3447
3447
  * @param {*} [options] Override http request option.
@@ -3473,7 +3473,7 @@ const DefaultApiFp = function (configuration) {
3473
3473
  });
3474
3474
  },
3475
3475
  /**
3476
- * Creates a X509 certificate signing request for signing key.
3476
+ * Creates an X509 Certificate Signing Request (CSR) for the wallet\'s signing key. The resulting certificate is imported back via `WalletX509CertificateImport` to enable issuing credentials signed by X509 certificate chain it or XAdES/PDF signing.
3477
3477
  * @param {string} walletId Wallet ID
3478
3478
  * @param {CSRCreateRequest} [cSRCreateRequest]
3479
3479
  * @param {*} [options] Override http request option.
@@ -3489,7 +3489,7 @@ const DefaultApiFp = function (configuration) {
3489
3489
  });
3490
3490
  },
3491
3491
  /**
3492
- * Returns an X509 certificate in PEM format
3492
+ * Returns the wallet\'s currently active X509 certificate in PEM format, used for XAdES/PDF signing. certificate for signature verification.
3493
3493
  * @param {string} walletId Wallet ID
3494
3494
  * @param {*} [options] Override http request option.
3495
3495
  * @throws {RequiredError}
@@ -3520,7 +3520,7 @@ const DefaultApiFp = function (configuration) {
3520
3520
  });
3521
3521
  },
3522
3522
  /**
3523
- * Accepts a WMP invitation
3523
+ * Accepts a WMP invitation URL from another wallet (issuer or verifier) to establish a peer-to-peer WMP connection. After acceptance, the connected entity appears in the WMP entity list and can send credential offers or verification requests directly to this wallet.
3524
3524
  * @param {string} walletId
3525
3525
  * @param {WmpAcceptInvitationPayload} [wmpAcceptInvitationPayload]
3526
3526
  * @param {*} [options] Override http request option.
@@ -3551,7 +3551,7 @@ const DefaultApiFp = function (configuration) {
3551
3551
  });
3552
3552
  },
3553
3553
  /**
3554
- * Process WMP request
3554
+ * Processes a pending WMP request (credential offer or credential verification request) received from a connected WMP server entity. Returns the authorization requirements that must be satisfied — used as the entry point into the offer or presentation flow instead of passing a URL to `HolderOfferPassAuthInfo` or `HolderPresentPassAuthInfo`.
3555
3555
  * @param {string} walletId
3556
3556
  * @param {string} requestId
3557
3557
  * @param {*} [options] Override http request option.
@@ -3567,7 +3567,7 @@ const DefaultApiFp = function (configuration) {
3567
3567
  });
3568
3568
  },
3569
3569
  /**
3570
- * Creates a new WMP invitation
3570
+ * Creates a WMP (Wallet Messaging Protocol) invitation URL that can be shared with another wallet to establish a secure peer-to-peer communication channel. Issuers and verifiers use this to connect with holder wallets for direct credential delivery and verification without requiring QR codes or redirects on each interaction.
3571
3571
  * @param {string} walletId
3572
3572
  * @param {*} [options] Override http request option.
3573
3573
  * @throws {RequiredError}
@@ -3630,7 +3630,7 @@ const DefaultApiFp = function (configuration) {
3630
3630
  });
3631
3631
  },
3632
3632
  /**
3633
- * Get all clients that have established WMP connection.
3633
+ * Lists all wallets that have established a WMP connection with this wallet. Filter by `entityType=server` for entities that created the invitation (issuers/verifiers), or `entityType=client` for entities that accepted it (holders).
3634
3634
  * @param {string} walletId
3635
3635
  * @param {WmpEntityListEntityTypeEnum} entityType
3636
3636
  * @param {*} [options] Override http request option.
@@ -3646,7 +3646,7 @@ const DefaultApiFp = function (configuration) {
3646
3646
  });
3647
3647
  },
3648
3648
  /**
3649
- * Connect to a WMP server entity
3649
+ * Re-establishes or confirms the WebSocket connection to a WMP server entity. Used to reconnect after a dropped connection so the wallet can resume receiving pending requests.
3650
3650
  * @param {string} walletId
3651
3651
  * @param {string} entityId
3652
3652
  * @param {*} [options] Override http request option.
@@ -3771,7 +3771,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
3771
3771
  return localVarFp.credentialRevoke(credentialId, walletId, options).then((request) => request(axios, basePath));
3772
3772
  },
3773
3773
  /**
3774
- *
3774
+ * Polls the status of a deferred credential issuance. Returns `in_progress` while the operation is still pending, or `completed` with the resulting credential ID when done. Clients should poll this endpoint until a terminal status is reached.
3775
3775
  * @param {string} deferredId Deferred token
3776
3776
  * @param {string} walletId
3777
3777
  * @param {*} [options] Override http request option.
@@ -3790,7 +3790,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
3790
3790
  return localVarFp.didDocumentGet(walletId, options).then((request) => request(axios, basePath));
3791
3791
  },
3792
3792
  /**
3793
- *
3793
+ * Checks the health status of the service and its subsystems (database, storage, etc.). Used by load balancers and monitoring systems.
3794
3794
  * @param {*} [options] Override http request option.
3795
3795
  * @throws {RequiredError}
3796
3796
  */
@@ -3808,7 +3808,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
3808
3808
  return localVarFp.holderCreateAuthOffer(walletId, holderAuthOfferCreationRequest, options).then((request) => request(axios, basePath));
3809
3809
  },
3810
3810
  /**
3811
- * Presenting Verifiable Credentials after holder\'s consent.
3811
+ * Completes a credential presentation flow: submits the selected credentials to the verifier after the holder\'s explicit consent. The `interaction_id` is obtained from `HolderPresentPassAuthInfo`.
3812
3812
  * @param {string} walletId
3813
3813
  * @param {string} interactionId
3814
3814
  * @param {InteractionAuthorizationConsent} [interactionAuthorizationConsent]
@@ -3849,7 +3849,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
3849
3849
  return localVarFp.holderLinkedVpDelete(walletId, linkedVpId, options).then((request) => request(axios, basePath));
3850
3850
  },
3851
3851
  /**
3852
- *
3852
+ * Returns metadata and content of a specific linked Verifiable Presentation, including the credentials it contains and its DID document service entry URL.
3853
3853
  * @param {string} walletId
3854
3854
  * @param {string} linkedVpId
3855
3855
  * @param {*} [options] Override http request option.
@@ -3859,7 +3859,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
3859
3859
  return localVarFp.holderLinkedVpGetDetails(walletId, linkedVpId, options).then((request) => request(axios, basePath));
3860
3860
  },
3861
3861
  /**
3862
- *
3862
+ * Returns all linked Verifiable Presentations published in the wallet\'s DID document,
3863
3863
  * @param {string} walletId
3864
3864
  * @param {*} [options] Override http request option.
3865
3865
  * @throws {RequiredError}
@@ -3868,7 +3868,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
3868
3868
  return localVarFp.holderLinkedVpList(walletId, options).then((request) => request(axios, basePath));
3869
3869
  },
3870
3870
  /**
3871
- * Retrieve authorization requirements for the credential offer.
3871
+ * Processes a credential offer URL (received from an issuer via QR code, deep link, or WMP) and returns what authorization is required to accept it - pin, credential presentation or a redirect to custom authorization flow. holder needs to present to the issuer, along with matching candidates from the wallet. The returned `interactionId` is used in the subsequent `HolderOfferProcessAfterConsent` call.
3872
3872
  * @param {string} walletId
3873
3873
  * @param {VcOffer} [vcOffer] Verifiable Credential offer
3874
3874
  * @param {*} [options] Override http request option.
@@ -3878,7 +3878,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
3878
3878
  return localVarFp.holderOfferPassAuthInfo(walletId, vcOffer, options).then((request) => request(axios, basePath));
3879
3879
  },
3880
3880
  /**
3881
- * Gives consent to process credential offer specified by `interaction_id`
3881
+ * Completes a credential offer flow after holder consent: submits data needed for the holder to authorize candidates to the issuer for holder authorization and retrieves the issued credential(s) into the wallet. The `interaction_id` is obtained from `HolderOfferPassAuthInfo`.
3882
3882
  * @param {string} walletId
3883
3883
  * @param {string} interactionId
3884
3884
  * @param {InteractionAuthorizationConsent} [interactionAuthorizationConsent]
@@ -3889,7 +3889,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
3889
3889
  return localVarFp.holderOfferProcessAfterConsent(walletId, interactionId, interactionAuthorizationConsent, options).then((request) => request(axios, basePath));
3890
3890
  },
3891
3891
  /**
3892
- * Initiates a presentation of credentials to a verifier.
3892
+ * Processes a verifier\'s presentation request URL and returns the presentation definition along with matching credential candidates from the wallet. The holder reviews which credentials will be disclosed before giving consent. The returned `interactionId` is used in the subsequent `HolderCredentialsPresentAfterConsent` call.
3893
3893
  * @param {string} walletId
3894
3894
  * @param {PresentationRequest} [presentationRequest]
3895
3895
  * @param {*} [options] Override http request option.
@@ -3899,7 +3899,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
3899
3899
  return localVarFp.holderPresentPassAuthInfo(walletId, presentationRequest, options).then((request) => request(axios, basePath));
3900
3900
  },
3901
3901
  /**
3902
- * Creates an ID token request.
3902
+ * Creates an ID token request that will be sent to the holder for DID-based authentication. Used during the authorized credential issuance flow when the issuer requires the holder to prove control of their DID before the credential is issued. The returned request ID is passed to `CredentialIssuanceInit` as `idTokenRequestId`.
3903
3903
  * @param {string} walletId
3904
3904
  * @param {*} [options] Override http request option.
3905
3905
  * @throws {RequiredError}
@@ -3917,7 +3917,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
3917
3917
  return localVarFp.issuerCredentialTypesList(url, options).then((request) => request(axios, basePath));
3918
3918
  },
3919
3919
  /**
3920
- * Initiates issuing of Verifiable Credentials using authorized flow.
3920
+ * Generates an authorized credential offer URL for the holder to initiate the credential issuance flow. The resulting offer URL is typically presented as a QR code or deep link. If `wmpEntityId` is provided, the offer is delivered directly via WMP and 204 is returned.
3921
3921
  * @param {string} walletId
3922
3922
  * @param {InitAuthOffer} [initAuthOffer]
3923
3923
  * @param {*} [options] Override http request option.
@@ -3927,7 +3927,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
3927
3927
  return localVarFp.issuerInitiateAuthOffer(walletId, initAuthOffer, options).then((request) => request(axios, basePath));
3928
3928
  },
3929
3929
  /**
3930
- * Initiates issuing of Verifiable Credentials using pre-authorized flow.
3930
+ * Generates a pre-authorized credential offer for the holder. Unlike the authorized flow, the holder does not need to authenticate with the issuer — instead a pre-authorized code (and optional PIN) is embedded in the offer URL. The resulting offer URL is returned and Generates a pre-authorized credential offer for the holder. The resulting offer URL is returned and can be shared as a QR code or deep link.
3931
3931
  * @param {string} walletId
3932
3932
  * @param {InitPreAuthOffer} [initPreAuthOffer]
3933
3933
  * @param {*} [options] Override http request option.
@@ -3990,7 +3990,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
3990
3990
  return localVarFp.pdfCredentialTwinUpload(credentialId, walletId, pdf, options).then((request) => request(axios, basePath));
3991
3991
  },
3992
3992
  /**
3993
- * Accredits a legal entity as RTAO, TAO or TI.
3993
+ * Accredits a legal entity as RTAO (Root Trust Anchor Organisation), TAO (Trust Anchor Organisation), or TI (Trusted Issuer) within the trust framework hierarchy by issuing the appropriate accreditation credential to their DID.
3994
3994
  * @param {string} walletId
3995
3995
  * @param {AccreditationRequest} [accreditationRequest]
3996
3996
  * @param {*} [options] Override http request option.
@@ -4000,7 +4000,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
4000
4000
  return localVarFp.tfAccreditAs(walletId, accreditationRequest, options).then((request) => request(axios, basePath));
4001
4001
  },
4002
4002
  /**
4003
- * Processes a request to accredit another legal entity.
4003
+ * Used by a TAO/RTAO wallet to process and approve an incoming accreditation request from another legal entity. Issues an accreditation credential authorizing the entity to issue credentials of the specified type within the trust framework.
4004
4004
  * @param {string} walletId
4005
4005
  * @param {EntityAccreditationRequest} [entityAccreditationRequest]
4006
4006
  * @param {*} [options] Override http request option.
@@ -4010,7 +4010,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
4010
4010
  return localVarFp.tfAccreditRequest(walletId, entityAccreditationRequest, options).then((request) => request(axios, basePath));
4011
4011
  },
4012
4012
  /**
4013
- * Onboards legal entity to the trust framework based on the wallet configuration.
4013
+ * Completes the trust framework onboarding of this wallet using the specified onboarding credential. After successful onboarding, the wallet\'s DID is registered in the trust framework\'s TAO/TI hierarchy, enabling it to issue or verify trust-framework credentials.
4014
4014
  * @param {string} walletId
4015
4015
  * @param {OnboardingRequest} [onboardingRequest]
4016
4016
  * @param {*} [options] Override http request option.
@@ -4020,7 +4020,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
4020
4020
  return localVarFp.tfOnboard(walletId, onboardingRequest, options).then((request) => request(axios, basePath));
4021
4021
  },
4022
4022
  /**
4023
- * Processes a request to onboard another legal entity.
4023
+ * Used by a TAO/RTAO wallet to process and approve an incoming onboarding request from another legal entity. Issues an onboarding credential (TIA) to the requesting entity, registering them in the trust framework.
4024
4024
  * @param {string} walletId
4025
4025
  * @param {EntityOnboardingRequest} [entityOnboardingRequest]
4026
4026
  * @param {*} [options] Override http request option.
@@ -4030,7 +4030,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
4030
4030
  return localVarFp.tfOnboardRequest(walletId, entityOnboardingRequest, options).then((request) => request(axios, basePath));
4031
4031
  },
4032
4032
  /**
4033
- * Revokes another legal entity\'s wallet DID accreditation.
4033
+ * Revokes another legal entity\'s accreditation or trust framework registration by invalidating their credential in the trust status list.
4034
4034
  * @param {string} walletId
4035
4035
  * @param {RevokeAccreditationRequest} [revokeAccreditationRequest]
4036
4036
  * @param {*} [options] Override http request option.
@@ -4040,7 +4040,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
4040
4040
  return localVarFp.tfRevokeAccreditation(walletId, revokeAccreditationRequest, options).then((request) => request(axios, basePath));
4041
4041
  },
4042
4042
  /**
4043
- * Issues a certificate based on the provided certificate request
4043
+ * Issues a signed X509 certificate based on the provided CSR. Used by a CA-capable wallet to sign certificate requests from other wallets, enabling them to sign credentials with X509 certificate echains and/or perform XAdES/PDF signing.
4044
4044
  * @param {string} walletId
4045
4045
  * @param {CertificateIssueRequest} [certificateIssueRequest]
4046
4046
  * @param {*} [options] Override http request option.
@@ -4050,7 +4050,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
4050
4050
  return localVarFp.tfX509CertificateIssue(walletId, certificateIssueRequest, options).then((request) => request(axios, basePath));
4051
4051
  },
4052
4052
  /**
4053
- * Returns an url where verifier accepts presentations from a holder.
4053
+ * Creates a verification session and returns a URL where the verifier accepts credential presentations from a holder. The URL is typically shared as a QR code or deep link. After the holder presents credentials, use `WalletVerifiedCredentialsByState` with the returned `state` to retrieve the verification result.
4054
4054
  * @param {string} walletId
4055
4055
  * @param {VerifyInitRequest} [verifyInitRequest]
4056
4056
  * @param {*} [options] Override http request option.
@@ -4111,7 +4111,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
4111
4111
  return localVarFp.walletGet(walletId, options).then((request) => request(axios, basePath));
4112
4112
  },
4113
4113
  /**
4114
- *
4114
+ * Returns the wallet\'s public identifier — e.g. a DID (Decentralized Identifier) or a wallet URL. Used by other parties to reference this wallet in trust framework interactions and credential exchanges.
4115
4115
  * @param {string} walletId
4116
4116
  * @param {*} [options] Override http request option.
4117
4117
  * @throws {RequiredError}
@@ -4183,7 +4183,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
4183
4183
  return localVarFp.walletPatch(walletId, walletPatchPayload, options).then((request) => request(axios, basePath));
4184
4184
  },
4185
4185
  /**
4186
- * Gets a specific verified credentials by state
4186
+ * Retrieves the result of a credential verification session identified by the verifier state. Called by the verifier after a holder has presented credentials in response to a `VerifierInitUrlCreate` request. Returns 204 if the holder has not yet presented.
4187
4187
  * @param {string} walletId Wallet ID
4188
4188
  * @param {string} state Verifier state
4189
4189
  * @param {*} [options] Override http request option.
@@ -4203,7 +4203,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
4203
4203
  return localVarFp.walletVerifiedCredentialsDeleteByState(walletId, state, options).then((request) => request(axios, basePath));
4204
4204
  },
4205
4205
  /**
4206
- * Creates a X509 certificate signing request for signing key.
4206
+ * Creates an X509 Certificate Signing Request (CSR) for the wallet\'s signing key. The resulting certificate is imported back via `WalletX509CertificateImport` to enable issuing credentials signed by X509 certificate chain it or XAdES/PDF signing.
4207
4207
  * @param {string} walletId Wallet ID
4208
4208
  * @param {CSRCreateRequest} [cSRCreateRequest]
4209
4209
  * @param {*} [options] Override http request option.
@@ -4213,7 +4213,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
4213
4213
  return localVarFp.walletX509CSRCreate(walletId, cSRCreateRequest, options).then((request) => request(axios, basePath));
4214
4214
  },
4215
4215
  /**
4216
- * Returns an X509 certificate in PEM format
4216
+ * Returns the wallet\'s currently active X509 certificate in PEM format, used for XAdES/PDF signing. certificate for signature verification.
4217
4217
  * @param {string} walletId Wallet ID
4218
4218
  * @param {*} [options] Override http request option.
4219
4219
  * @throws {RequiredError}
@@ -4232,7 +4232,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
4232
4232
  return localVarFp.walletX509CertificateImport(walletId, certificateImportRequest, options).then((request) => request(axios, basePath));
4233
4233
  },
4234
4234
  /**
4235
- * Accepts a WMP invitation
4235
+ * Accepts a WMP invitation URL from another wallet (issuer or verifier) to establish a peer-to-peer WMP connection. After acceptance, the connected entity appears in the WMP entity list and can send credential offers or verification requests directly to this wallet.
4236
4236
  * @param {string} walletId
4237
4237
  * @param {WmpAcceptInvitationPayload} [wmpAcceptInvitationPayload]
4238
4238
  * @param {*} [options] Override http request option.
@@ -4251,7 +4251,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
4251
4251
  return localVarFp.wmpClientGetPendingRequests(walletId, options).then((request) => request(axios, basePath));
4252
4252
  },
4253
4253
  /**
4254
- * Process WMP request
4254
+ * Processes a pending WMP request (credential offer or credential verification request) received from a connected WMP server entity. Returns the authorization requirements that must be satisfied — used as the entry point into the offer or presentation flow instead of passing a URL to `HolderOfferPassAuthInfo` or `HolderPresentPassAuthInfo`.
4255
4255
  * @param {string} walletId
4256
4256
  * @param {string} requestId
4257
4257
  * @param {*} [options] Override http request option.
@@ -4261,7 +4261,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
4261
4261
  return localVarFp.wmpClientProcessRequest(walletId, requestId, options).then((request) => request(axios, basePath));
4262
4262
  },
4263
4263
  /**
4264
- * Creates a new WMP invitation
4264
+ * Creates a WMP (Wallet Messaging Protocol) invitation URL that can be shared with another wallet to establish a secure peer-to-peer communication channel. Issuers and verifiers use this to connect with holder wallets for direct credential delivery and verification without requiring QR codes or redirects on each interaction.
4265
4265
  * @param {string} walletId
4266
4266
  * @param {*} [options] Override http request option.
4267
4267
  * @throws {RequiredError}
@@ -4300,7 +4300,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
4300
4300
  return localVarFp.wmpEntityGet(walletId, entityId, options).then((request) => request(axios, basePath));
4301
4301
  },
4302
4302
  /**
4303
- * Get all clients that have established WMP connection.
4303
+ * Lists all wallets that have established a WMP connection with this wallet. Filter by `entityType=server` for entities that created the invitation (issuers/verifiers), or `entityType=client` for entities that accepted it (holders).
4304
4304
  * @param {string} walletId
4305
4305
  * @param {WmpEntityListEntityTypeEnum} entityType
4306
4306
  * @param {*} [options] Override http request option.
@@ -4310,7 +4310,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
4310
4310
  return localVarFp.wmpEntityList(walletId, entityType, options).then((request) => request(axios, basePath));
4311
4311
  },
4312
4312
  /**
4313
- * Connect to a WMP server entity
4313
+ * Re-establishes or confirms the WebSocket connection to a WMP server entity. Used to reconnect after a dropped connection so the wallet can resume receiving pending requests.
4314
4314
  * @param {string} walletId
4315
4315
  * @param {string} entityId
4316
4316
  * @param {*} [options] Override http request option.
@@ -4427,7 +4427,7 @@ class DefaultApi extends base_1.BaseAPI {
4427
4427
  return (0, exports.DefaultApiFp)(this.configuration).credentialRevoke(credentialId, walletId, options).then((request) => request(this.axios, this.basePath));
4428
4428
  }
4429
4429
  /**
4430
- *
4430
+ * Polls the status of a deferred credential issuance. Returns `in_progress` while the operation is still pending, or `completed` with the resulting credential ID when done. Clients should poll this endpoint until a terminal status is reached.
4431
4431
  * @param {string} deferredId Deferred token
4432
4432
  * @param {string} walletId
4433
4433
  * @param {*} [options] Override http request option.
@@ -4446,7 +4446,7 @@ class DefaultApi extends base_1.BaseAPI {
4446
4446
  return (0, exports.DefaultApiFp)(this.configuration).didDocumentGet(walletId, options).then((request) => request(this.axios, this.basePath));
4447
4447
  }
4448
4448
  /**
4449
- *
4449
+ * Checks the health status of the service and its subsystems (database, storage, etc.). Used by load balancers and monitoring systems.
4450
4450
  * @param {*} [options] Override http request option.
4451
4451
  * @throws {RequiredError}
4452
4452
  */
@@ -4464,7 +4464,7 @@ class DefaultApi extends base_1.BaseAPI {
4464
4464
  return (0, exports.DefaultApiFp)(this.configuration).holderCreateAuthOffer(walletId, holderAuthOfferCreationRequest, options).then((request) => request(this.axios, this.basePath));
4465
4465
  }
4466
4466
  /**
4467
- * Presenting Verifiable Credentials after holder\'s consent.
4467
+ * Completes a credential presentation flow: submits the selected credentials to the verifier after the holder\'s explicit consent. The `interaction_id` is obtained from `HolderPresentPassAuthInfo`.
4468
4468
  * @param {string} walletId
4469
4469
  * @param {string} interactionId
4470
4470
  * @param {InteractionAuthorizationConsent} [interactionAuthorizationConsent]
@@ -4505,7 +4505,7 @@ class DefaultApi extends base_1.BaseAPI {
4505
4505
  return (0, exports.DefaultApiFp)(this.configuration).holderLinkedVpDelete(walletId, linkedVpId, options).then((request) => request(this.axios, this.basePath));
4506
4506
  }
4507
4507
  /**
4508
- *
4508
+ * Returns metadata and content of a specific linked Verifiable Presentation, including the credentials it contains and its DID document service entry URL.
4509
4509
  * @param {string} walletId
4510
4510
  * @param {string} linkedVpId
4511
4511
  * @param {*} [options] Override http request option.
@@ -4515,7 +4515,7 @@ class DefaultApi extends base_1.BaseAPI {
4515
4515
  return (0, exports.DefaultApiFp)(this.configuration).holderLinkedVpGetDetails(walletId, linkedVpId, options).then((request) => request(this.axios, this.basePath));
4516
4516
  }
4517
4517
  /**
4518
- *
4518
+ * Returns all linked Verifiable Presentations published in the wallet\'s DID document,
4519
4519
  * @param {string} walletId
4520
4520
  * @param {*} [options] Override http request option.
4521
4521
  * @throws {RequiredError}
@@ -4524,7 +4524,7 @@ class DefaultApi extends base_1.BaseAPI {
4524
4524
  return (0, exports.DefaultApiFp)(this.configuration).holderLinkedVpList(walletId, options).then((request) => request(this.axios, this.basePath));
4525
4525
  }
4526
4526
  /**
4527
- * Retrieve authorization requirements for the credential offer.
4527
+ * Processes a credential offer URL (received from an issuer via QR code, deep link, or WMP) and returns what authorization is required to accept it - pin, credential presentation or a redirect to custom authorization flow. holder needs to present to the issuer, along with matching candidates from the wallet. The returned `interactionId` is used in the subsequent `HolderOfferProcessAfterConsent` call.
4528
4528
  * @param {string} walletId
4529
4529
  * @param {VcOffer} [vcOffer] Verifiable Credential offer
4530
4530
  * @param {*} [options] Override http request option.
@@ -4534,7 +4534,7 @@ class DefaultApi extends base_1.BaseAPI {
4534
4534
  return (0, exports.DefaultApiFp)(this.configuration).holderOfferPassAuthInfo(walletId, vcOffer, options).then((request) => request(this.axios, this.basePath));
4535
4535
  }
4536
4536
  /**
4537
- * Gives consent to process credential offer specified by `interaction_id`
4537
+ * Completes a credential offer flow after holder consent: submits data needed for the holder to authorize candidates to the issuer for holder authorization and retrieves the issued credential(s) into the wallet. The `interaction_id` is obtained from `HolderOfferPassAuthInfo`.
4538
4538
  * @param {string} walletId
4539
4539
  * @param {string} interactionId
4540
4540
  * @param {InteractionAuthorizationConsent} [interactionAuthorizationConsent]
@@ -4545,7 +4545,7 @@ class DefaultApi extends base_1.BaseAPI {
4545
4545
  return (0, exports.DefaultApiFp)(this.configuration).holderOfferProcessAfterConsent(walletId, interactionId, interactionAuthorizationConsent, options).then((request) => request(this.axios, this.basePath));
4546
4546
  }
4547
4547
  /**
4548
- * Initiates a presentation of credentials to a verifier.
4548
+ * Processes a verifier\'s presentation request URL and returns the presentation definition along with matching credential candidates from the wallet. The holder reviews which credentials will be disclosed before giving consent. The returned `interactionId` is used in the subsequent `HolderCredentialsPresentAfterConsent` call.
4549
4549
  * @param {string} walletId
4550
4550
  * @param {PresentationRequest} [presentationRequest]
4551
4551
  * @param {*} [options] Override http request option.
@@ -4555,7 +4555,7 @@ class DefaultApi extends base_1.BaseAPI {
4555
4555
  return (0, exports.DefaultApiFp)(this.configuration).holderPresentPassAuthInfo(walletId, presentationRequest, options).then((request) => request(this.axios, this.basePath));
4556
4556
  }
4557
4557
  /**
4558
- * Creates an ID token request.
4558
+ * Creates an ID token request that will be sent to the holder for DID-based authentication. Used during the authorized credential issuance flow when the issuer requires the holder to prove control of their DID before the credential is issued. The returned request ID is passed to `CredentialIssuanceInit` as `idTokenRequestId`.
4559
4559
  * @param {string} walletId
4560
4560
  * @param {*} [options] Override http request option.
4561
4561
  * @throws {RequiredError}
@@ -4573,7 +4573,7 @@ class DefaultApi extends base_1.BaseAPI {
4573
4573
  return (0, exports.DefaultApiFp)(this.configuration).issuerCredentialTypesList(url, options).then((request) => request(this.axios, this.basePath));
4574
4574
  }
4575
4575
  /**
4576
- * Initiates issuing of Verifiable Credentials using authorized flow.
4576
+ * Generates an authorized credential offer URL for the holder to initiate the credential issuance flow. The resulting offer URL is typically presented as a QR code or deep link. If `wmpEntityId` is provided, the offer is delivered directly via WMP and 204 is returned.
4577
4577
  * @param {string} walletId
4578
4578
  * @param {InitAuthOffer} [initAuthOffer]
4579
4579
  * @param {*} [options] Override http request option.
@@ -4583,7 +4583,7 @@ class DefaultApi extends base_1.BaseAPI {
4583
4583
  return (0, exports.DefaultApiFp)(this.configuration).issuerInitiateAuthOffer(walletId, initAuthOffer, options).then((request) => request(this.axios, this.basePath));
4584
4584
  }
4585
4585
  /**
4586
- * Initiates issuing of Verifiable Credentials using pre-authorized flow.
4586
+ * Generates a pre-authorized credential offer for the holder. Unlike the authorized flow, the holder does not need to authenticate with the issuer — instead a pre-authorized code (and optional PIN) is embedded in the offer URL. The resulting offer URL is returned and Generates a pre-authorized credential offer for the holder. The resulting offer URL is returned and can be shared as a QR code or deep link.
4587
4587
  * @param {string} walletId
4588
4588
  * @param {InitPreAuthOffer} [initPreAuthOffer]
4589
4589
  * @param {*} [options] Override http request option.
@@ -4646,7 +4646,7 @@ class DefaultApi extends base_1.BaseAPI {
4646
4646
  return (0, exports.DefaultApiFp)(this.configuration).pdfCredentialTwinUpload(credentialId, walletId, pdf, options).then((request) => request(this.axios, this.basePath));
4647
4647
  }
4648
4648
  /**
4649
- * Accredits a legal entity as RTAO, TAO or TI.
4649
+ * Accredits a legal entity as RTAO (Root Trust Anchor Organisation), TAO (Trust Anchor Organisation), or TI (Trusted Issuer) within the trust framework hierarchy by issuing the appropriate accreditation credential to their DID.
4650
4650
  * @param {string} walletId
4651
4651
  * @param {AccreditationRequest} [accreditationRequest]
4652
4652
  * @param {*} [options] Override http request option.
@@ -4656,7 +4656,7 @@ class DefaultApi extends base_1.BaseAPI {
4656
4656
  return (0, exports.DefaultApiFp)(this.configuration).tfAccreditAs(walletId, accreditationRequest, options).then((request) => request(this.axios, this.basePath));
4657
4657
  }
4658
4658
  /**
4659
- * Processes a request to accredit another legal entity.
4659
+ * Used by a TAO/RTAO wallet to process and approve an incoming accreditation request from another legal entity. Issues an accreditation credential authorizing the entity to issue credentials of the specified type within the trust framework.
4660
4660
  * @param {string} walletId
4661
4661
  * @param {EntityAccreditationRequest} [entityAccreditationRequest]
4662
4662
  * @param {*} [options] Override http request option.
@@ -4666,7 +4666,7 @@ class DefaultApi extends base_1.BaseAPI {
4666
4666
  return (0, exports.DefaultApiFp)(this.configuration).tfAccreditRequest(walletId, entityAccreditationRequest, options).then((request) => request(this.axios, this.basePath));
4667
4667
  }
4668
4668
  /**
4669
- * Onboards legal entity to the trust framework based on the wallet configuration.
4669
+ * Completes the trust framework onboarding of this wallet using the specified onboarding credential. After successful onboarding, the wallet\'s DID is registered in the trust framework\'s TAO/TI hierarchy, enabling it to issue or verify trust-framework credentials.
4670
4670
  * @param {string} walletId
4671
4671
  * @param {OnboardingRequest} [onboardingRequest]
4672
4672
  * @param {*} [options] Override http request option.
@@ -4676,7 +4676,7 @@ class DefaultApi extends base_1.BaseAPI {
4676
4676
  return (0, exports.DefaultApiFp)(this.configuration).tfOnboard(walletId, onboardingRequest, options).then((request) => request(this.axios, this.basePath));
4677
4677
  }
4678
4678
  /**
4679
- * Processes a request to onboard another legal entity.
4679
+ * Used by a TAO/RTAO wallet to process and approve an incoming onboarding request from another legal entity. Issues an onboarding credential (TIA) to the requesting entity, registering them in the trust framework.
4680
4680
  * @param {string} walletId
4681
4681
  * @param {EntityOnboardingRequest} [entityOnboardingRequest]
4682
4682
  * @param {*} [options] Override http request option.
@@ -4686,7 +4686,7 @@ class DefaultApi extends base_1.BaseAPI {
4686
4686
  return (0, exports.DefaultApiFp)(this.configuration).tfOnboardRequest(walletId, entityOnboardingRequest, options).then((request) => request(this.axios, this.basePath));
4687
4687
  }
4688
4688
  /**
4689
- * Revokes another legal entity\'s wallet DID accreditation.
4689
+ * Revokes another legal entity\'s accreditation or trust framework registration by invalidating their credential in the trust status list.
4690
4690
  * @param {string} walletId
4691
4691
  * @param {RevokeAccreditationRequest} [revokeAccreditationRequest]
4692
4692
  * @param {*} [options] Override http request option.
@@ -4696,7 +4696,7 @@ class DefaultApi extends base_1.BaseAPI {
4696
4696
  return (0, exports.DefaultApiFp)(this.configuration).tfRevokeAccreditation(walletId, revokeAccreditationRequest, options).then((request) => request(this.axios, this.basePath));
4697
4697
  }
4698
4698
  /**
4699
- * Issues a certificate based on the provided certificate request
4699
+ * Issues a signed X509 certificate based on the provided CSR. Used by a CA-capable wallet to sign certificate requests from other wallets, enabling them to sign credentials with X509 certificate echains and/or perform XAdES/PDF signing.
4700
4700
  * @param {string} walletId
4701
4701
  * @param {CertificateIssueRequest} [certificateIssueRequest]
4702
4702
  * @param {*} [options] Override http request option.
@@ -4706,7 +4706,7 @@ class DefaultApi extends base_1.BaseAPI {
4706
4706
  return (0, exports.DefaultApiFp)(this.configuration).tfX509CertificateIssue(walletId, certificateIssueRequest, options).then((request) => request(this.axios, this.basePath));
4707
4707
  }
4708
4708
  /**
4709
- * Returns an url where verifier accepts presentations from a holder.
4709
+ * Creates a verification session and returns a URL where the verifier accepts credential presentations from a holder. The URL is typically shared as a QR code or deep link. After the holder presents credentials, use `WalletVerifiedCredentialsByState` with the returned `state` to retrieve the verification result.
4710
4710
  * @param {string} walletId
4711
4711
  * @param {VerifyInitRequest} [verifyInitRequest]
4712
4712
  * @param {*} [options] Override http request option.
@@ -4767,7 +4767,7 @@ class DefaultApi extends base_1.BaseAPI {
4767
4767
  return (0, exports.DefaultApiFp)(this.configuration).walletGet(walletId, options).then((request) => request(this.axios, this.basePath));
4768
4768
  }
4769
4769
  /**
4770
- *
4770
+ * Returns the wallet\'s public identifier — e.g. a DID (Decentralized Identifier) or a wallet URL. Used by other parties to reference this wallet in trust framework interactions and credential exchanges.
4771
4771
  * @param {string} walletId
4772
4772
  * @param {*} [options] Override http request option.
4773
4773
  * @throws {RequiredError}
@@ -4839,7 +4839,7 @@ class DefaultApi extends base_1.BaseAPI {
4839
4839
  return (0, exports.DefaultApiFp)(this.configuration).walletPatch(walletId, walletPatchPayload, options).then((request) => request(this.axios, this.basePath));
4840
4840
  }
4841
4841
  /**
4842
- * Gets a specific verified credentials by state
4842
+ * Retrieves the result of a credential verification session identified by the verifier state. Called by the verifier after a holder has presented credentials in response to a `VerifierInitUrlCreate` request. Returns 204 if the holder has not yet presented.
4843
4843
  * @param {string} walletId Wallet ID
4844
4844
  * @param {string} state Verifier state
4845
4845
  * @param {*} [options] Override http request option.
@@ -4859,7 +4859,7 @@ class DefaultApi extends base_1.BaseAPI {
4859
4859
  return (0, exports.DefaultApiFp)(this.configuration).walletVerifiedCredentialsDeleteByState(walletId, state, options).then((request) => request(this.axios, this.basePath));
4860
4860
  }
4861
4861
  /**
4862
- * Creates a X509 certificate signing request for signing key.
4862
+ * Creates an X509 Certificate Signing Request (CSR) for the wallet\'s signing key. The resulting certificate is imported back via `WalletX509CertificateImport` to enable issuing credentials signed by X509 certificate chain it or XAdES/PDF signing.
4863
4863
  * @param {string} walletId Wallet ID
4864
4864
  * @param {CSRCreateRequest} [cSRCreateRequest]
4865
4865
  * @param {*} [options] Override http request option.
@@ -4869,7 +4869,7 @@ class DefaultApi extends base_1.BaseAPI {
4869
4869
  return (0, exports.DefaultApiFp)(this.configuration).walletX509CSRCreate(walletId, cSRCreateRequest, options).then((request) => request(this.axios, this.basePath));
4870
4870
  }
4871
4871
  /**
4872
- * Returns an X509 certificate in PEM format
4872
+ * Returns the wallet\'s currently active X509 certificate in PEM format, used for XAdES/PDF signing. certificate for signature verification.
4873
4873
  * @param {string} walletId Wallet ID
4874
4874
  * @param {*} [options] Override http request option.
4875
4875
  * @throws {RequiredError}
@@ -4888,7 +4888,7 @@ class DefaultApi extends base_1.BaseAPI {
4888
4888
  return (0, exports.DefaultApiFp)(this.configuration).walletX509CertificateImport(walletId, certificateImportRequest, options).then((request) => request(this.axios, this.basePath));
4889
4889
  }
4890
4890
  /**
4891
- * Accepts a WMP invitation
4891
+ * Accepts a WMP invitation URL from another wallet (issuer or verifier) to establish a peer-to-peer WMP connection. After acceptance, the connected entity appears in the WMP entity list and can send credential offers or verification requests directly to this wallet.
4892
4892
  * @param {string} walletId
4893
4893
  * @param {WmpAcceptInvitationPayload} [wmpAcceptInvitationPayload]
4894
4894
  * @param {*} [options] Override http request option.
@@ -4907,7 +4907,7 @@ class DefaultApi extends base_1.BaseAPI {
4907
4907
  return (0, exports.DefaultApiFp)(this.configuration).wmpClientGetPendingRequests(walletId, options).then((request) => request(this.axios, this.basePath));
4908
4908
  }
4909
4909
  /**
4910
- * Process WMP request
4910
+ * Processes a pending WMP request (credential offer or credential verification request) received from a connected WMP server entity. Returns the authorization requirements that must be satisfied — used as the entry point into the offer or presentation flow instead of passing a URL to `HolderOfferPassAuthInfo` or `HolderPresentPassAuthInfo`.
4911
4911
  * @param {string} walletId
4912
4912
  * @param {string} requestId
4913
4913
  * @param {*} [options] Override http request option.
@@ -4917,7 +4917,7 @@ class DefaultApi extends base_1.BaseAPI {
4917
4917
  return (0, exports.DefaultApiFp)(this.configuration).wmpClientProcessRequest(walletId, requestId, options).then((request) => request(this.axios, this.basePath));
4918
4918
  }
4919
4919
  /**
4920
- * Creates a new WMP invitation
4920
+ * Creates a WMP (Wallet Messaging Protocol) invitation URL that can be shared with another wallet to establish a secure peer-to-peer communication channel. Issuers and verifiers use this to connect with holder wallets for direct credential delivery and verification without requiring QR codes or redirects on each interaction.
4921
4921
  * @param {string} walletId
4922
4922
  * @param {*} [options] Override http request option.
4923
4923
  * @throws {RequiredError}
@@ -4956,7 +4956,7 @@ class DefaultApi extends base_1.BaseAPI {
4956
4956
  return (0, exports.DefaultApiFp)(this.configuration).wmpEntityGet(walletId, entityId, options).then((request) => request(this.axios, this.basePath));
4957
4957
  }
4958
4958
  /**
4959
- * Get all clients that have established WMP connection.
4959
+ * Lists all wallets that have established a WMP connection with this wallet. Filter by `entityType=server` for entities that created the invitation (issuers/verifiers), or `entityType=client` for entities that accepted it (holders).
4960
4960
  * @param {string} walletId
4961
4961
  * @param {WmpEntityListEntityTypeEnum} entityType
4962
4962
  * @param {*} [options] Override http request option.
@@ -4966,7 +4966,7 @@ class DefaultApi extends base_1.BaseAPI {
4966
4966
  return (0, exports.DefaultApiFp)(this.configuration).wmpEntityList(walletId, entityType, options).then((request) => request(this.axios, this.basePath));
4967
4967
  }
4968
4968
  /**
4969
- * Connect to a WMP server entity
4969
+ * Re-establishes or confirms the WebSocket connection to a WMP server entity. Used to reconnect after a dropped connection so the wallet can resume receiving pending requests.
4970
4970
  * @param {string} walletId
4971
4971
  * @param {string} entityId
4972
4972
  * @param {*} [options] Override http request option.
@@ -4981,9 +4981,9 @@ exports.CredentialListInteractionEnum = {
4981
4981
  Issuance: 'issuance',
4982
4982
  Receive: 'receive',
4983
4983
  StatusList: 'statusList',
4984
- TaoCredentials: 'taoCredentials'
4984
+ TaoCredentials: 'taoCredentials',
4985
4985
  };
4986
4986
  exports.WmpEntityListEntityTypeEnum = {
4987
4987
  Server: 'server',
4988
- Client: 'client'
4988
+ Client: 'client',
4989
4989
  };