@idunion/tl-sdk 0.0.59 → 0.0.60

package/api.d.ts

@@ -1,6 +1,6 @@
 /**
  * IDUnion Trust List API
- * IDUnion Trust List API
+ * The IDUnion Trust List API provides a backend for managing decentralized trust infrastructure based on ETSI TS 119-602 and TS 119-612 standards. It enables creation and management of Trust Lists (TLs) and Trust List Records (TLRs), DID document management, credential-based onboarding of organizations, and export of standards-compliant trust list XML documents.  Trust Lists group organizations (Trust List Records) by their role in the ecosystem, such as Wallet Providers, PID Providers, or QEAA Providers. Each organization is represented by a W3C Decentralized Identifier (DID) with associated cryptographic verification methods.
  *
  * The version of the OpenAPI document: 0.0.1
  *
@@ -244,7 +244,7 @@ export interface TlPublicInfoList {
     'items'?: Array<TlPublicInfo>;
 }
 /**
- * Trust List type
+ * Defines the role category of entities registered in the Trust List, aligned with ETSI TS 119-602 and the EU Digital Identity (EUDI) framework:   - `QEAA_Provider`: Qualified Electronic Attestation of Attributes provider   - `PuBEAA_Provider`: Public Body Electronic Attestation of Attributes provider   - `Wallet_Provider`: EUDI-compliant identity wallet solution provider   - `PID_Provider`: Person Identification Data provider (e.g. national eID issuer)   - `Access_Certificate_Authority`: Issuer of access certificates for wallet interactions   - `Registration_Certificates_Provider`: Issuer of registration certificates   - `EAA_Provider`: Electronic Attestation of Attributes provider (non-qualified)
  */
 export declare const TlType: {
     readonly QeaaProvider: "QEAA_Provider";
@@ -349,7 +349,7 @@ export interface VpResponse {
  */
 export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * Retrieves a specific DID Document
+     * Returns the W3C DID Document for the specified Trust List Record. The document contains the entity\'s DID, cryptographic verification methods, and service endpoints. This endpoint follows the `did:web` resolution convention and is used by DID resolvers to look up the entity\'s public key material and service information.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
@@ -357,124 +357,124 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      */
     didGet: (tlId: string, tlrId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Suggests a DID
+     * Returns a suggested DID for a new Trust List Record within the specified Trust List. The suggested DID is derived from the Trust List\'s DID base and can be used to pre-fill the DID field when creating a new record.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     didSuggest: (tlId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Adds DID Verification method.
+     * Adds a new verification method to the DID Document of the specified Trust List Record. The verification method includes cryptographic key material (e.g. Ed25519, RSA, or ES256K) and is registered under the assertionMethod, authentication, and capabilityInvocation relationships in the DID Document.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
-     * @param {VerificationMethodCreatePayload} [verificationMethodCreatePayload] Verification method.
+     * @param {VerificationMethodCreatePayload} [verificationMethodCreatePayload] Verification method to add, including its type, controller DID, key ID, and key material.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     didVerificationMethodAdd: (tlId: string, tlrId: string, verificationMethodCreatePayload?: VerificationMethodCreatePayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Adds DID Verification method.
+     * Updates an existing verification method on the DID Document of a Trust List Record. Primarily used to revoke a verification method by setting the `revoked` timestamp, which marks the key as no longer valid and transitions the Trust List Record status to `revoked`. The Trust List Record\'s status in the ETSI trust list XML is updated accordingly.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
-     * @param {VerificationMethodPatchPayload} [verificationMethodPatchPayload] Verification method.
+     * @param {VerificationMethodPatchPayload} [verificationMethodPatchPayload] Partial verification method update payload. Provide the key ID and the fields to update, such as the &#x60;revoked&#x60; timestamp to revoke the key.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     didVerificationMethodPatch: (tlId: string, tlrId: string, verificationMethodPatchPayload?: VerificationMethodPatchPayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns an ETSI 119 602 Trusted list
+     * Returns the Trust List in ETSI TS 119-602 XML format, which defines the standard for trust frameworks of identity wallet ecosystems (e.g. EUDI Wallet). The XML document includes Trust List Records with their DID-based cryptographic material and accreditation information, suitable for consumption by wallet verifiers and trust framework participants.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     etsiTl602Get: (tlId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns an ETSI 119 612 Trusted list
+     * Returns the Trust List in ETSI TS 119-612 XML format, which defines the standard for Trusted Lists of Trust Service Providers (TSPs) in the context of electronic signatures and qualified trust services. The XML document includes all active, onboarded, and revoked Trust List Records with their x509 certificates and service status information, suitable for consumption by conformant trust service validators.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     etsiTl612Get: (tlId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * Returns the operational health status of the Trust List API service. Useful for monitoring, load balancer checks, and readiness probes.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     healthCheck: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Initiates the onboarding process to the DID registry.
+     * Initiates the credential-based onboarding process for an organization joining the specified Trust List. Returns a verifier URL to redirect the holder to, where they must present an onboarding Verifiable Credential (VC) proving their eligibility. After presenting the credential, the status can be polled via `GET /onboarding/{verifier_state}`. On successful verification, a Trust List Record is automatically created for the organization.
      * @param {string} tlId Trust List identifier
-     * @param {OnboardingPayload} [onboardingPayload] DID onboarding init payload.
+     * @param {OnboardingPayload} [onboardingPayload] Onboarding initiation payload specifying the verifier to use and optionally the holder\&#39;s entity identifier (did:key).
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     onboardingInit: (tlId: string, onboardingPayload?: OnboardingPayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * Polls the status of an ongoing onboarding process using the verifier state token returned by `POST /{tl_id}/onboarding`. Returns the current status (`in_progress`, `completed`, or `error`) along with the assigned DID once onboarding is complete. Clients should poll this endpoint periodically until a terminal status is reached.
      * @param {string} verifierState Verifier state
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     onboardingStatus: (verifierState: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Creates a Trust List based on the specified payload.
-     * @param {TlPayload} [tlPayload] Trust List create payload.
+     * Creates a new Trust List owned by the authenticated user. A Trust List groups organizations (Trust List Records) of a specific role type (e.g. Wallet Provider, PID Provider). It requires a governance wallet for VC interactions and a verifier to validate onboarding credentials presented by joining organizations.
+     * @param {TlPayload} [tlPayload] Trust List create payload including name, type, description, and references to the governance wallet and verifier services.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlCreate: (tlPayload?: TlPayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Destroys the Trust List.
+     * Permanently deletes the specified Trust List and all its associated records. Only the Trust List owner can perform this operation.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlDelete: (tlId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Gets the specified Trust List
+     * Returns the full representation of a specific Trust List for the authenticated owner, including the verifier ID not exposed in the public directory endpoints.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlGet: (tlId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Provides a public information about a specific Trusted List
+     * Returns publicly accessible metadata for a specific Trust List. No authentication is required. Returns the same fields as the directory listing but for a single Trust List, excluding sensitive fields such as the verifier ID.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlGetPublicInfo: (tlId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Provides a list of public Trusted Lists
+     * Returns a publicly accessible directory of all Trust Lists. No authentication is required. An optional `search` query parameter filters results by name or description. Used by clients to display a browseable catalog of available trust ecosystems.
      * @param {string} [search]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlList: (search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Provides a list of Trusted Lists for an authenticated owner
+     * Returns all Trust Lists owned by the authenticated user. Unlike the public directory, this response includes the full Trust List representation with the verifier ID. Used to populate the authenticated user\'s management dashboard.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlListByOwner: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Updates a Trust List based on the specified payload.
+     * Updates the metadata of an existing Trust List. Only the Trust List owner can perform this operation. Fields provided in the payload will overwrite current values.
      * @param {string} tlId
-     * @param {TlPayload} [tlPayload] Trust List create payload.
+     * @param {TlPayload} [tlPayload] Trust List update payload. Provide only the fields to update.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlPatch: (tlId: string, tlPayload?: TlPayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Directly creates a new Trusted List Record. When a Certificate Signing Request is provided, it will also issue an x509 certificate and update the ETSI TS 119 6**
+     * Directly creates a new Trust List Record in the specified Trust List, bypassing the credential-based onboarding flow. The public key material must be provided either as a `did:key` or a Certificate Signing Request (CSR) in PEM format. When a CSR is provided, the API issues an x509 certificate and registers it in the ETSI TS 119-612 trust list XML. Returns the generated DID and, if a CSR was provided, the issued certificate.
      * @param {string} tlId
-     * @param {TlrCreatePayload} [tlrCreatePayload] Trust List Record Create Payload.
+     * @param {TlrCreatePayload} [tlrCreatePayload] Trust List Record create payload. Includes organization details and either a did:key or a CSR for key material provisioning.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlrCreate: (tlId: string, tlrCreatePayload?: TlrCreatePayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Removes a specific Trust List Record
+     * Permanently removes a specific Trust List Record from the Trust List. Only the Trust List owner can perform this operation. The associated DID Document and all related data will be deleted.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
@@ -482,7 +482,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      */
     tlrDelete: (tlId: string, tlrId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Retrieves a specific Trust List record
+     * Returns a specific Trust List Record including organization details, DID, current status (onboarded, trusted, revoked, or expired), accreditations, and onboarding credentials. No authentication is required; used to display public entity detail pages.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
@@ -490,14 +490,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      */
     tlrGet: (tlId: string, tlrId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Retrieves a list of Trust List Records.
+     * Searches for Trust List Records across all Trust Lists by organization name. No authentication is required. Used by public-facing directory or search features to find entities registered under a given organization name.
      * @param {string} orgName
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlrSearch: (orgName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Gets Trust List Records that make up a single Trust Chain
+     * Returns the full chain of Trust List Records from the root trust anchor down to the specified record. Each element in the array represents one step in the chain of trust, showing which entities issued or accredited the next. Used to visualize and verify the complete trust path for a given organization.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
@@ -505,14 +505,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      */
     tlrTrustChainGet: (tlId: string, tlrId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Retrieves a list of Trust List records.
+     * Returns all Trust List Records belonging to a specific Trust List. Each record represents an organization with its DID, status (onboarded, trusted, revoked, or expired), accreditations, and onboarding credentials. Used to display the list of entities participating in a trust ecosystem.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlrsGet: (tlId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Gets a Verifiable Presentation.
+     * Retrieves the Verifiable Presentation (VP) stored for a specific Trust List Record. The VP is encoded as a JWT and represents the credential presented during the onboarding process, proving the entity\'s eligibility to join the Trust List. Used to audit or display the onboarding evidence for a given record.
      * @param {string} tlId
      * @param {string} did
      * @param {string} id
@@ -526,7 +526,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
  */
 export declare const DefaultApiFp: (configuration?: Configuration) => {
     /**
-     * Retrieves a specific DID Document
+     * Returns the W3C DID Document for the specified Trust List Record. The document contains the entity\'s DID, cryptographic verification methods, and service endpoints. This endpoint follows the `did:web` resolution convention and is used by DID resolvers to look up the entity\'s public key material and service information.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
@@ -534,124 +534,124 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      */
     didGet(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DidDocument>>;
     /**
-     * Suggests a DID
+     * Returns a suggested DID for a new Trust List Record within the specified Trust List. The suggested DID is derived from the Trust List\'s DID base and can be used to pre-fill the DID field when creating a new record.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     didSuggest(tlId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
     /**
-     * Adds DID Verification method.
+     * Adds a new verification method to the DID Document of the specified Trust List Record. The verification method includes cryptographic key material (e.g. Ed25519, RSA, or ES256K) and is registered under the assertionMethod, authentication, and capabilityInvocation relationships in the DID Document.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
-     * @param {VerificationMethodCreatePayload} [verificationMethodCreatePayload] Verification method.
+     * @param {VerificationMethodCreatePayload} [verificationMethodCreatePayload] Verification method to add, including its type, controller DID, key ID, and key material.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     didVerificationMethodAdd(tlId: string, tlrId: string, verificationMethodCreatePayload?: VerificationMethodCreatePayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     * Adds DID Verification method.
+     * Updates an existing verification method on the DID Document of a Trust List Record. Primarily used to revoke a verification method by setting the `revoked` timestamp, which marks the key as no longer valid and transitions the Trust List Record status to `revoked`. The Trust List Record\'s status in the ETSI trust list XML is updated accordingly.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
-     * @param {VerificationMethodPatchPayload} [verificationMethodPatchPayload] Verification method.
+     * @param {VerificationMethodPatchPayload} [verificationMethodPatchPayload] Partial verification method update payload. Provide the key ID and the fields to update, such as the &#x60;revoked&#x60; timestamp to revoke the key.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     didVerificationMethodPatch(tlId: string, tlrId: string, verificationMethodPatchPayload?: VerificationMethodPatchPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     * Returns an ETSI 119 602 Trusted list
+     * Returns the Trust List in ETSI TS 119-602 XML format, which defines the standard for trust frameworks of identity wallet ecosystems (e.g. EUDI Wallet). The XML document includes Trust List Records with their DID-based cryptographic material and accreditation information, suitable for consumption by wallet verifiers and trust framework participants.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     etsiTl602Get(tlId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
     /**
-     * Returns an ETSI 119 612 Trusted list
+     * Returns the Trust List in ETSI TS 119-612 XML format, which defines the standard for Trusted Lists of Trust Service Providers (TSPs) in the context of electronic signatures and qualified trust services. The XML document includes all active, onboarded, and revoked Trust List Records with their x509 certificates and service status information, suitable for consumption by conformant trust service validators.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     etsiTl612Get(tlId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
     /**
-     *
+     * Returns the operational health status of the Trust List API service. Useful for monitoring, load balancer checks, and readiness probes.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     healthCheck(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HealthStatus>>;
     /**
-     * Initiates the onboarding process to the DID registry.
+     * Initiates the credential-based onboarding process for an organization joining the specified Trust List. Returns a verifier URL to redirect the holder to, where they must present an onboarding Verifiable Credential (VC) proving their eligibility. After presenting the credential, the status can be polled via `GET /onboarding/{verifier_state}`. On successful verification, a Trust List Record is automatically created for the organization.
      * @param {string} tlId Trust List identifier
-     * @param {OnboardingPayload} [onboardingPayload] DID onboarding init payload.
+     * @param {OnboardingPayload} [onboardingPayload] Onboarding initiation payload specifying the verifier to use and optionally the holder\&#39;s entity identifier (did:key).
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     onboardingInit(tlId: string, onboardingPayload?: OnboardingPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OnboardingResponse>>;
     /**
-     *
+     * Polls the status of an ongoing onboarding process using the verifier state token returned by `POST /{tl_id}/onboarding`. Returns the current status (`in_progress`, `completed`, or `error`) along with the assigned DID once onboarding is complete. Clients should poll this endpoint periodically until a terminal status is reached.
      * @param {string} verifierState Verifier state
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     onboardingStatus(verifierState: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OnboardingStatus>>;
     /**
-     * Creates a Trust List based on the specified payload.
-     * @param {TlPayload} [tlPayload] Trust List create payload.
+     * Creates a new Trust List owned by the authenticated user. A Trust List groups organizations (Trust List Records) of a specific role type (e.g. Wallet Provider, PID Provider). It requires a governance wallet for VC interactions and a verifier to validate onboarding credentials presented by joining organizations.
+     * @param {TlPayload} [tlPayload] Trust List create payload including name, type, description, and references to the governance wallet and verifier services.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlCreate(tlPayload?: TlPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tl>>;
     /**
-     * Destroys the Trust List.
+     * Permanently deletes the specified Trust List and all its associated records. Only the Trust List owner can perform this operation.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlDelete(tlId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     * Gets the specified Trust List
+     * Returns the full representation of a specific Trust List for the authenticated owner, including the verifier ID not exposed in the public directory endpoints.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlGet(tlId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tl>>;
     /**
-     * Provides a public information about a specific Trusted List
+     * Returns publicly accessible metadata for a specific Trust List. No authentication is required. Returns the same fields as the directory listing but for a single Trust List, excluding sensitive fields such as the verifier ID.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlGetPublicInfo(tlId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TlPublicInfo>>;
     /**
-     * Provides a list of public Trusted Lists
+     * Returns a publicly accessible directory of all Trust Lists. No authentication is required. An optional `search` query parameter filters results by name or description. Used by clients to display a browseable catalog of available trust ecosystems.
      * @param {string} [search]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlList(search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TlPublicInfoList>>;
     /**
-     * Provides a list of Trusted Lists for an authenticated owner
+     * Returns all Trust Lists owned by the authenticated user. Unlike the public directory, this response includes the full Trust List representation with the verifier ID. Used to populate the authenticated user\'s management dashboard.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlListByOwner(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TlList>>;
     /**
-     * Updates a Trust List based on the specified payload.
+     * Updates the metadata of an existing Trust List. Only the Trust List owner can perform this operation. Fields provided in the payload will overwrite current values.
      * @param {string} tlId
-     * @param {TlPayload} [tlPayload] Trust List create payload.
+     * @param {TlPayload} [tlPayload] Trust List update payload. Provide only the fields to update.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlPatch(tlId: string, tlPayload?: TlPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tl>>;
     /**
-     * Directly creates a new Trusted List Record. When a Certificate Signing Request is provided, it will also issue an x509 certificate and update the ETSI TS 119 6**
+     * Directly creates a new Trust List Record in the specified Trust List, bypassing the credential-based onboarding flow. The public key material must be provided either as a `did:key` or a Certificate Signing Request (CSR) in PEM format. When a CSR is provided, the API issues an x509 certificate and registers it in the ETSI TS 119-612 trust list XML. Returns the generated DID and, if a CSR was provided, the issued certificate.
      * @param {string} tlId
-     * @param {TlrCreatePayload} [tlrCreatePayload] Trust List Record Create Payload.
+     * @param {TlrCreatePayload} [tlrCreatePayload] Trust List Record create payload. Includes organization details and either a did:key or a CSR for key material provisioning.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlrCreate(tlId: string, tlrCreatePayload?: TlrCreatePayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TlrCreatedResult>>;
     /**
-     * Removes a specific Trust List Record
+     * Permanently removes a specific Trust List Record from the Trust List. Only the Trust List owner can perform this operation. The associated DID Document and all related data will be deleted.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
@@ -659,7 +659,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      */
     tlrDelete(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     * Retrieves a specific Trust List record
+     * Returns a specific Trust List Record including organization details, DID, current status (onboarded, trusted, revoked, or expired), accreditations, and onboarding credentials. No authentication is required; used to display public entity detail pages.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
@@ -667,14 +667,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      */
     tlrGet(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tlr>>;
     /**
-     * Retrieves a list of Trust List Records.
+     * Searches for Trust List Records across all Trust Lists by organization name. No authentication is required. Used by public-facing directory or search features to find entities registered under a given organization name.
      * @param {string} orgName
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlrSearch(orgName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TlrList>>;
     /**
-     * Gets Trust List Records that make up a single Trust Chain
+     * Returns the full chain of Trust List Records from the root trust anchor down to the specified record. Each element in the array represents one step in the chain of trust, showing which entities issued or accredited the next. Used to visualize and verify the complete trust path for a given organization.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
@@ -682,14 +682,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      */
     tlrTrustChainGet(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Tlr>>>;
     /**
-     * Retrieves a list of Trust List records.
+     * Returns all Trust List Records belonging to a specific Trust List. Each record represents an organization with its DID, status (onboarded, trusted, revoked, or expired), accreditations, and onboarding credentials. Used to display the list of entities participating in a trust ecosystem.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlrsGet(tlId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TlrList>>;
     /**
-     * Gets a Verifiable Presentation.
+     * Retrieves the Verifiable Presentation (VP) stored for a specific Trust List Record. The VP is encoded as a JWT and represents the credential presented during the onboarding process, proving the entity\'s eligibility to join the Trust List. Used to audit or display the onboarding evidence for a given record.
      * @param {string} tlId
      * @param {string} did
      * @param {string} id
@@ -703,7 +703,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
  */
 export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * Retrieves a specific DID Document
+     * Returns the W3C DID Document for the specified Trust List Record. The document contains the entity\'s DID, cryptographic verification methods, and service endpoints. This endpoint follows the `did:web` resolution convention and is used by DID resolvers to look up the entity\'s public key material and service information.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
@@ -711,124 +711,124 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      */
     didGet(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): AxiosPromise<DidDocument>;
     /**
-     * Suggests a DID
+     * Returns a suggested DID for a new Trust List Record within the specified Trust List. The suggested DID is derived from the Trust List\'s DID base and can be used to pre-fill the DID field when creating a new record.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     didSuggest(tlId: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
     /**
-     * Adds DID Verification method.
+     * Adds a new verification method to the DID Document of the specified Trust List Record. The verification method includes cryptographic key material (e.g. Ed25519, RSA, or ES256K) and is registered under the assertionMethod, authentication, and capabilityInvocation relationships in the DID Document.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
-     * @param {VerificationMethodCreatePayload} [verificationMethodCreatePayload] Verification method.
+     * @param {VerificationMethodCreatePayload} [verificationMethodCreatePayload] Verification method to add, including its type, controller DID, key ID, and key material.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     didVerificationMethodAdd(tlId: string, tlrId: string, verificationMethodCreatePayload?: VerificationMethodCreatePayload, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
-     * Adds DID Verification method.
+     * Updates an existing verification method on the DID Document of a Trust List Record. Primarily used to revoke a verification method by setting the `revoked` timestamp, which marks the key as no longer valid and transitions the Trust List Record status to `revoked`. The Trust List Record\'s status in the ETSI trust list XML is updated accordingly.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
-     * @param {VerificationMethodPatchPayload} [verificationMethodPatchPayload] Verification method.
+     * @param {VerificationMethodPatchPayload} [verificationMethodPatchPayload] Partial verification method update payload. Provide the key ID and the fields to update, such as the &#x60;revoked&#x60; timestamp to revoke the key.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     didVerificationMethodPatch(tlId: string, tlrId: string, verificationMethodPatchPayload?: VerificationMethodPatchPayload, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
-     * Returns an ETSI 119 602 Trusted list
+     * Returns the Trust List in ETSI TS 119-602 XML format, which defines the standard for trust frameworks of identity wallet ecosystems (e.g. EUDI Wallet). The XML document includes Trust List Records with their DID-based cryptographic material and accreditation information, suitable for consumption by wallet verifiers and trust framework participants.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     etsiTl602Get(tlId: string, options?: RawAxiosRequestConfig): AxiosPromise<object>;
     /**
-     * Returns an ETSI 119 612 Trusted list
+     * Returns the Trust List in ETSI TS 119-612 XML format, which defines the standard for Trusted Lists of Trust Service Providers (TSPs) in the context of electronic signatures and qualified trust services. The XML document includes all active, onboarded, and revoked Trust List Records with their x509 certificates and service status information, suitable for consumption by conformant trust service validators.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     etsiTl612Get(tlId: string, options?: RawAxiosRequestConfig): AxiosPromise<object>;
     /**
-     *
+     * Returns the operational health status of the Trust List API service. Useful for monitoring, load balancer checks, and readiness probes.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     healthCheck(options?: RawAxiosRequestConfig): AxiosPromise<HealthStatus>;
     /**
-     * Initiates the onboarding process to the DID registry.
+     * Initiates the credential-based onboarding process for an organization joining the specified Trust List. Returns a verifier URL to redirect the holder to, where they must present an onboarding Verifiable Credential (VC) proving their eligibility. After presenting the credential, the status can be polled via `GET /onboarding/{verifier_state}`. On successful verification, a Trust List Record is automatically created for the organization.
      * @param {string} tlId Trust List identifier
-     * @param {OnboardingPayload} [onboardingPayload] DID onboarding init payload.
+     * @param {OnboardingPayload} [onboardingPayload] Onboarding initiation payload specifying the verifier to use and optionally the holder\&#39;s entity identifier (did:key).
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     onboardingInit(tlId: string, onboardingPayload?: OnboardingPayload, options?: RawAxiosRequestConfig): AxiosPromise<OnboardingResponse>;
     /**
-     *
+     * Polls the status of an ongoing onboarding process using the verifier state token returned by `POST /{tl_id}/onboarding`. Returns the current status (`in_progress`, `completed`, or `error`) along with the assigned DID once onboarding is complete. Clients should poll this endpoint periodically until a terminal status is reached.
      * @param {string} verifierState Verifier state
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     onboardingStatus(verifierState: string, options?: RawAxiosRequestConfig): AxiosPromise<OnboardingStatus>;
     /**
-     * Creates a Trust List based on the specified payload.
-     * @param {TlPayload} [tlPayload] Trust List create payload.
+     * Creates a new Trust List owned by the authenticated user. A Trust List groups organizations (Trust List Records) of a specific role type (e.g. Wallet Provider, PID Provider). It requires a governance wallet for VC interactions and a verifier to validate onboarding credentials presented by joining organizations.
+     * @param {TlPayload} [tlPayload] Trust List create payload including name, type, description, and references to the governance wallet and verifier services.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlCreate(tlPayload?: TlPayload, options?: RawAxiosRequestConfig): AxiosPromise<Tl>;
     /**
-     * Destroys the Trust List.
+     * Permanently deletes the specified Trust List and all its associated records. Only the Trust List owner can perform this operation.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlDelete(tlId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
-     * Gets the specified Trust List
+     * Returns the full representation of a specific Trust List for the authenticated owner, including the verifier ID not exposed in the public directory endpoints.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlGet(tlId: string, options?: RawAxiosRequestConfig): AxiosPromise<Tl>;
     /**
-     * Provides a public information about a specific Trusted List
+     * Returns publicly accessible metadata for a specific Trust List. No authentication is required. Returns the same fields as the directory listing but for a single Trust List, excluding sensitive fields such as the verifier ID.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlGetPublicInfo(tlId: string, options?: RawAxiosRequestConfig): AxiosPromise<TlPublicInfo>;
     /**
-     * Provides a list of public Trusted Lists
+     * Returns a publicly accessible directory of all Trust Lists. No authentication is required. An optional `search` query parameter filters results by name or description. Used by clients to display a browseable catalog of available trust ecosystems.
      * @param {string} [search]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlList(search?: string, options?: RawAxiosRequestConfig): AxiosPromise<TlPublicInfoList>;
     /**
-     * Provides a list of Trusted Lists for an authenticated owner
+     * Returns all Trust Lists owned by the authenticated user. Unlike the public directory, this response includes the full Trust List representation with the verifier ID. Used to populate the authenticated user\'s management dashboard.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlListByOwner(options?: RawAxiosRequestConfig): AxiosPromise<TlList>;
     /**
-     * Updates a Trust List based on the specified payload.
+     * Updates the metadata of an existing Trust List. Only the Trust List owner can perform this operation. Fields provided in the payload will overwrite current values.
      * @param {string} tlId
-     * @param {TlPayload} [tlPayload] Trust List create payload.
+     * @param {TlPayload} [tlPayload] Trust List update payload. Provide only the fields to update.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlPatch(tlId: string, tlPayload?: TlPayload, options?: RawAxiosRequestConfig): AxiosPromise<Tl>;
     /**
-     * Directly creates a new Trusted List Record. When a Certificate Signing Request is provided, it will also issue an x509 certificate and update the ETSI TS 119 6**
+     * Directly creates a new Trust List Record in the specified Trust List, bypassing the credential-based onboarding flow. The public key material must be provided either as a `did:key` or a Certificate Signing Request (CSR) in PEM format. When a CSR is provided, the API issues an x509 certificate and registers it in the ETSI TS 119-612 trust list XML. Returns the generated DID and, if a CSR was provided, the issued certificate.
      * @param {string} tlId
-     * @param {TlrCreatePayload} [tlrCreatePayload] Trust List Record Create Payload.
+     * @param {TlrCreatePayload} [tlrCreatePayload] Trust List Record create payload. Includes organization details and either a did:key or a CSR for key material provisioning.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlrCreate(tlId: string, tlrCreatePayload?: TlrCreatePayload, options?: RawAxiosRequestConfig): AxiosPromise<TlrCreatedResult>;
     /**
-     * Removes a specific Trust List Record
+     * Permanently removes a specific Trust List Record from the Trust List. Only the Trust List owner can perform this operation. The associated DID Document and all related data will be deleted.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
@@ -836,7 +836,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      */
     tlrDelete(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
-     * Retrieves a specific Trust List record
+     * Returns a specific Trust List Record including organization details, DID, current status (onboarded, trusted, revoked, or expired), accreditations, and onboarding credentials. No authentication is required; used to display public entity detail pages.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
@@ -844,14 +844,14 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      */
     tlrGet(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): AxiosPromise<Tlr>;
     /**
-     * Retrieves a list of Trust List Records.
+     * Searches for Trust List Records across all Trust Lists by organization name. No authentication is required. Used by public-facing directory or search features to find entities registered under a given organization name.
      * @param {string} orgName
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlrSearch(orgName: string, options?: RawAxiosRequestConfig): AxiosPromise<TlrList>;
     /**
-     * Gets Trust List Records that make up a single Trust Chain
+     * Returns the full chain of Trust List Records from the root trust anchor down to the specified record. Each element in the array represents one step in the chain of trust, showing which entities issued or accredited the next. Used to visualize and verify the complete trust path for a given organization.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
@@ -859,14 +859,14 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      */
     tlrTrustChainGet(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Tlr>>;
     /**
-     * Retrieves a list of Trust List records.
+     * Returns all Trust List Records belonging to a specific Trust List. Each record represents an organization with its DID, status (onboarded, trusted, revoked, or expired), accreditations, and onboarding credentials. Used to display the list of entities participating in a trust ecosystem.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlrsGet(tlId: string, options?: RawAxiosRequestConfig): AxiosPromise<TlrList>;
     /**
-     * Gets a Verifiable Presentation.
+     * Retrieves the Verifiable Presentation (VP) stored for a specific Trust List Record. The VP is encoded as a JWT and represents the credential presented during the onboarding process, proving the entity\'s eligibility to join the Trust List. Used to audit or display the onboarding evidence for a given record.
      * @param {string} tlId
      * @param {string} did
      * @param {string} id
@@ -880,7 +880,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
  */
 export declare class DefaultApi extends BaseAPI {
     /**
-     * Retrieves a specific DID Document
+     * Returns the W3C DID Document for the specified Trust List Record. The document contains the entity\'s DID, cryptographic verification methods, and service endpoints. This endpoint follows the `did:web` resolution convention and is used by DID resolvers to look up the entity\'s public key material and service information.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
@@ -888,124 +888,124 @@ export declare class DefaultApi extends BaseAPI {
      */
     didGet(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DidDocument, any>>;
     /**
-     * Suggests a DID
+     * Returns a suggested DID for a new Trust List Record within the specified Trust List. The suggested DID is derived from the Trust List\'s DID base and can be used to pre-fill the DID field when creating a new record.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     didSuggest(tlId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
     /**
-     * Adds DID Verification method.
+     * Adds a new verification method to the DID Document of the specified Trust List Record. The verification method includes cryptographic key material (e.g. Ed25519, RSA, or ES256K) and is registered under the assertionMethod, authentication, and capabilityInvocation relationships in the DID Document.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
-     * @param {VerificationMethodCreatePayload} [verificationMethodCreatePayload] Verification method.
+     * @param {VerificationMethodCreatePayload} [verificationMethodCreatePayload] Verification method to add, including its type, controller DID, key ID, and key material.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     didVerificationMethodAdd(tlId: string, tlrId: string, verificationMethodCreatePayload?: VerificationMethodCreatePayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
-     * Adds DID Verification method.
+     * Updates an existing verification method on the DID Document of a Trust List Record. Primarily used to revoke a verification method by setting the `revoked` timestamp, which marks the key as no longer valid and transitions the Trust List Record status to `revoked`. The Trust List Record\'s status in the ETSI trust list XML is updated accordingly.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
-     * @param {VerificationMethodPatchPayload} [verificationMethodPatchPayload] Verification method.
+     * @param {VerificationMethodPatchPayload} [verificationMethodPatchPayload] Partial verification method update payload. Provide the key ID and the fields to update, such as the &#x60;revoked&#x60; timestamp to revoke the key.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     didVerificationMethodPatch(tlId: string, tlrId: string, verificationMethodPatchPayload?: VerificationMethodPatchPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
-     * Returns an ETSI 119 602 Trusted list
+     * Returns the Trust List in ETSI TS 119-602 XML format, which defines the standard for trust frameworks of identity wallet ecosystems (e.g. EUDI Wallet). The XML document includes Trust List Records with their DID-based cryptographic material and accreditation information, suitable for consumption by wallet verifiers and trust framework participants.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     etsiTl602Get(tlId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
     /**
-     * Returns an ETSI 119 612 Trusted list
+     * Returns the Trust List in ETSI TS 119-612 XML format, which defines the standard for Trusted Lists of Trust Service Providers (TSPs) in the context of electronic signatures and qualified trust services. The XML document includes all active, onboarded, and revoked Trust List Records with their x509 certificates and service status information, suitable for consumption by conformant trust service validators.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     etsiTl612Get(tlId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
     /**
-     *
+     * Returns the operational health status of the Trust List API service. Useful for monitoring, load balancer checks, and readiness probes.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     healthCheck(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HealthStatus, any>>;
     /**
-     * Initiates the onboarding process to the DID registry.
+     * Initiates the credential-based onboarding process for an organization joining the specified Trust List. Returns a verifier URL to redirect the holder to, where they must present an onboarding Verifiable Credential (VC) proving their eligibility. After presenting the credential, the status can be polled via `GET /onboarding/{verifier_state}`. On successful verification, a Trust List Record is automatically created for the organization.
      * @param {string} tlId Trust List identifier
-     * @param {OnboardingPayload} [onboardingPayload] DID onboarding init payload.
+     * @param {OnboardingPayload} [onboardingPayload] Onboarding initiation payload specifying the verifier to use and optionally the holder\&#39;s entity identifier (did:key).
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     onboardingInit(tlId: string, onboardingPayload?: OnboardingPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OnboardingResponse, any>>;
     /**
-     *
+     * Polls the status of an ongoing onboarding process using the verifier state token returned by `POST /{tl_id}/onboarding`. Returns the current status (`in_progress`, `completed`, or `error`) along with the assigned DID once onboarding is complete. Clients should poll this endpoint periodically until a terminal status is reached.
      * @param {string} verifierState Verifier state
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     onboardingStatus(verifierState: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OnboardingStatus, any>>;
     /**
-     * Creates a Trust List based on the specified payload.
-     * @param {TlPayload} [tlPayload] Trust List create payload.
+     * Creates a new Trust List owned by the authenticated user. A Trust List groups organizations (Trust List Records) of a specific role type (e.g. Wallet Provider, PID Provider). It requires a governance wallet for VC interactions and a verifier to validate onboarding credentials presented by joining organizations.
+     * @param {TlPayload} [tlPayload] Trust List create payload including name, type, description, and references to the governance wallet and verifier services.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlCreate(tlPayload?: TlPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Tl, any>>;
     /**
-     * Destroys the Trust List.
+     * Permanently deletes the specified Trust List and all its associated records. Only the Trust List owner can perform this operation.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlDelete(tlId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
-     * Gets the specified Trust List
+     * Returns the full representation of a specific Trust List for the authenticated owner, including the verifier ID not exposed in the public directory endpoints.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlGet(tlId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Tl, any>>;
     /**
-     * Provides a public information about a specific Trusted List
+     * Returns publicly accessible metadata for a specific Trust List. No authentication is required. Returns the same fields as the directory listing but for a single Trust List, excluding sensitive fields such as the verifier ID.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlGetPublicInfo(tlId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TlPublicInfo, any>>;
     /**
-     * Provides a list of public Trusted Lists
+     * Returns a publicly accessible directory of all Trust Lists. No authentication is required. An optional `search` query parameter filters results by name or description. Used by clients to display a browseable catalog of available trust ecosystems.
      * @param {string} [search]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlList(search?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TlPublicInfoList, any>>;
     /**
-     * Provides a list of Trusted Lists for an authenticated owner
+     * Returns all Trust Lists owned by the authenticated user. Unlike the public directory, this response includes the full Trust List representation with the verifier ID. Used to populate the authenticated user\'s management dashboard.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlListByOwner(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TlList, any>>;
     /**
-     * Updates a Trust List based on the specified payload.
+     * Updates the metadata of an existing Trust List. Only the Trust List owner can perform this operation. Fields provided in the payload will overwrite current values.
      * @param {string} tlId
-     * @param {TlPayload} [tlPayload] Trust List create payload.
+     * @param {TlPayload} [tlPayload] Trust List update payload. Provide only the fields to update.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlPatch(tlId: string, tlPayload?: TlPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Tl, any>>;
     /**
-     * Directly creates a new Trusted List Record. When a Certificate Signing Request is provided, it will also issue an x509 certificate and update the ETSI TS 119 6**
+     * Directly creates a new Trust List Record in the specified Trust List, bypassing the credential-based onboarding flow. The public key material must be provided either as a `did:key` or a Certificate Signing Request (CSR) in PEM format. When a CSR is provided, the API issues an x509 certificate and registers it in the ETSI TS 119-612 trust list XML. Returns the generated DID and, if a CSR was provided, the issued certificate.
      * @param {string} tlId
-     * @param {TlrCreatePayload} [tlrCreatePayload] Trust List Record Create Payload.
+     * @param {TlrCreatePayload} [tlrCreatePayload] Trust List Record create payload. Includes organization details and either a did:key or a CSR for key material provisioning.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlrCreate(tlId: string, tlrCreatePayload?: TlrCreatePayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TlrCreatedResult, any>>;
     /**
-     * Removes a specific Trust List Record
+     * Permanently removes a specific Trust List Record from the Trust List. Only the Trust List owner can perform this operation. The associated DID Document and all related data will be deleted.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
@@ -1013,7 +1013,7 @@ export declare class DefaultApi extends BaseAPI {
      */
     tlrDelete(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
-     * Retrieves a specific Trust List record
+     * Returns a specific Trust List Record including organization details, DID, current status (onboarded, trusted, revoked, or expired), accreditations, and onboarding credentials. No authentication is required; used to display public entity detail pages.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
@@ -1021,14 +1021,14 @@ export declare class DefaultApi extends BaseAPI {
      */
     tlrGet(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Tlr, any>>;
     /**
-     * Retrieves a list of Trust List Records.
+     * Searches for Trust List Records across all Trust Lists by organization name. No authentication is required. Used by public-facing directory or search features to find entities registered under a given organization name.
      * @param {string} orgName
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlrSearch(orgName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TlrList, any>>;
     /**
-     * Gets Trust List Records that make up a single Trust Chain
+     * Returns the full chain of Trust List Records from the root trust anchor down to the specified record. Each element in the array represents one step in the chain of trust, showing which entities issued or accredited the next. Used to visualize and verify the complete trust path for a given organization.
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
@@ -1036,14 +1036,14 @@ export declare class DefaultApi extends BaseAPI {
      */
     tlrTrustChainGet(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Tlr[], any>>;
     /**
-     * Retrieves a list of Trust List records.
+     * Returns all Trust List Records belonging to a specific Trust List. Each record represents an organization with its DID, status (onboarded, trusted, revoked, or expired), accreditations, and onboarding credentials. Used to display the list of entities participating in a trust ecosystem.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     tlrsGet(tlId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TlrList, any>>;
     /**
-     * Gets a Verifiable Presentation.
+     * Retrieves the Verifiable Presentation (VP) stored for a specific Trust List Record. The VP is encoded as a JWT and represents the credential presented during the onboarding process, proving the entity\'s eligibility to join the Trust List. Used to audit or display the onboarding evidence for a given record.
      * @param {string} tlId
      * @param {string} did
      * @param {string} id