@idunion/tl-sdk 0.0.2

package/api.d.ts

@@ -0,0 +1,1375 @@
+/**
+ * IDunion Trust List API
+ * IDunion Trust List API
+ *
+ * The version of the OpenAPI document: 0.0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from './configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import type { RequestArgs } from './base';
+import { BaseAPI } from './base';
+/**
+ * @type CapabilityInvocationInner
+ * @export
+ */
+export type CapabilityInvocationInner = VerificationMethod | string;
+/**
+ *
+ * @export
+ * @interface Credential
+ */
+export interface Credential {
+    [key: string]: any;
+    /**
+     * The value of the @context property MUST be an ordered set where the first item is a URL with the value  https://www.w3.org/ns/credentials/v2. Subsequent items in the array MUST express context information and  be composed of any combination of URLs or objects. It is RECOMMENDED that each URL in the @context be  one which, if dereferenced, results in a document containing machine-readable information about the @context. https://www.w3.org/TR/vc-data-model-2.0/#contexts
+     * @type {Array<string>}
+     * @memberof Credential
+     */
+    '@context'?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof Credential
+     */
+    'id'?: string;
+    /**
+     * The value of the type property MUST be, or map to (through interpretation of the @context property),  one or more URLs. If more than one URL is provided, the URLs MUST be interpreted as an unordered set.  Syntactic conveniences SHOULD be used to ease developer usage. Such conveniences might include JSON-LD terms.  It is RECOMMENDED that each URL in the type be one which, if dereferenced, results in a document containing  machine-readable information about the type.  https://www.w3.org/TR/vc-data-model-2.0/#types
+     * @type {Array<string>}
+     * @memberof Credential
+     */
+    'type'?: Array<string>;
+    /**
+     *
+     * @type {CredentialSchema}
+     * @memberof Credential
+     */
+    'credentialSchema'?: CredentialSchema;
+    /**
+     *
+     * @type {CredentialSubject}
+     * @memberof Credential
+     */
+    'credentialSubject'?: CredentialSubject;
+    /**
+     *
+     * @type {CredentialStatus}
+     * @memberof Credential
+     */
+    'credentialStatus'?: CredentialStatus;
+    /**
+     *
+     * @type {Array<EvidenceItem>}
+     * @memberof Credential
+     */
+    'evidence'?: Array<EvidenceItem>;
+    /**
+     * Date Time Stamp string value representing the date and time the credential becomes valid https://www.w3.org/TR/vc-data-model-2.0/#defn-validFrom
+     * @type {string}
+     * @memberof Credential
+     */
+    'validFrom'?: string;
+    /**
+     * Date Time Stamp string value representing the date and time the credential ceases to be valid https://www.w3.org/TR/vc-data-model-2.0/#defn-validUntil
+     * @type {string}
+     * @memberof Credential
+     */
+    'validUntil'?: string;
+    /**
+     * EBSI specific field defining the date of issuance.
+     * @type {string}
+     * @memberof Credential
+     */
+    'issued'?: string;
+    /**
+     * EBSI specific field defining the date of issuance.
+     * @type {string}
+     * @memberof Credential
+     */
+    'issuanceDate'?: string;
+    /**
+     * EBSI specific field defining the date of expiration.
+     * @type {string}
+     * @memberof Credential
+     */
+    'expirationDate'?: string;
+    /**
+     * Either a URL or an object containing an id property https://www.w3.org/TR/vc-data-model-2.0/#defn-holder
+     * @type {string}
+     * @memberof Credential
+     */
+    'holder'?: string;
+    /**
+     * Either a URL or an object containing an id property https://www.w3.org/TR/vc-data-model-2.0/#defn-issuer
+     * @type {string}
+     * @memberof Credential
+     */
+    'issuer'?: string;
+    /**
+     * Array of specific VC field disclosures
+     * @type {Array<string>}
+     * @memberof Credential
+     */
+    '_sd'?: Array<string>;
+    /**
+     * Algorithm used for hashing disclosure digests
+     * @type {string}
+     * @memberof Credential
+     */
+    '_sd_alg'?: string;
+    /**
+     *
+     * @type {RefreshService}
+     * @memberof Credential
+     */
+    'refreshService'?: RefreshService;
+    /**
+     *
+     * @type {TermsOfUse}
+     * @memberof Credential
+     */
+    'termsOfUse'?: TermsOfUse;
+    /**
+     *
+     * @type {Proof}
+     * @memberof Credential
+     */
+    'proof'?: Proof;
+}
+/**
+ *
+ * @export
+ * @interface CredentialIdObject
+ */
+export interface CredentialIdObject {
+    /**
+     *
+     * @type {string}
+     * @memberof CredentialIdObject
+     */
+    'id': string;
+}
+/**
+ * Any Credential related accompanying key, value pairs that are not part of the Issued Credential
+ * @export
+ * @interface CredentialMetadata
+ */
+export interface CredentialMetadata {
+    [key: string]: any;
+    /**
+     *
+     * @type {string}
+     * @memberof CredentialMetadata
+     */
+    'id': string;
+    /**
+     *
+     * @type {string}
+     * @memberof CredentialMetadata
+     */
+    'walletId': string;
+    /**
+     *
+     * @type {string}
+     * @memberof CredentialMetadata
+     */
+    'ownerId': string;
+    /**
+     *
+     * @type {string}
+     * @memberof CredentialMetadata
+     */
+    'name': string;
+    /**
+     *
+     * @type {string}
+     * @memberof CredentialMetadata
+     */
+    'interaction': CredentialMetadataInteractionEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof CredentialMetadata
+     */
+    'message'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CredentialMetadata
+     */
+    'type': string;
+    /**
+     * In case of issued credential this is the DID of the holder wallet
+     * @type {string}
+     * @memberof CredentialMetadata
+     */
+    'offeredToClientId'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CredentialMetadata
+     */
+    'created': string;
+    /**
+     *
+     * @type {string}
+     * @memberof CredentialMetadata
+     */
+    'updated': string;
+    /**
+     *
+     * @type {string}
+     * @memberof CredentialMetadata
+     */
+    'status': CredentialMetadataStatusEnum;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof CredentialMetadata
+     */
+    'disclosableFields'?: Array<string>;
+    /**
+     * Array of objects, where each object contains display properties of a Credential Issuer for a certain language.
+     * @type {Array<IssuerDisplayItem>}
+     * @memberof CredentialMetadata
+     */
+    'issuerDisplay'?: Array<IssuerDisplayItem>;
+}
+export declare const CredentialMetadataInteractionEnum: {
+    readonly Issuance: "issuance";
+    readonly Receive: "receive";
+    readonly StatusList: "statusList";
+    readonly TaoCredentials: "taoCredentials";
+};
+export type CredentialMetadataInteractionEnum = typeof CredentialMetadataInteractionEnum[keyof typeof CredentialMetadataInteractionEnum];
+export declare const CredentialMetadataStatusEnum: {
+    readonly Draft: "draft";
+    readonly Valid: "valid";
+    readonly Invalid: "invalid";
+};
+export type CredentialMetadataStatusEnum = typeof CredentialMetadataStatusEnum[keyof typeof CredentialMetadataStatusEnum];
+/**
+ * @type CredentialSchema
+ * One or more data schemas that provide verifiers with enough information to determine if the provided data conforms to the provided schema(s) https://www.w3.org/TR/vc-data-model-2.0/#defn-credentialSchema
+ * @export
+ */
+export type CredentialSchema = Array<CredentialSchemaItem> | CredentialSchemaItem;
+/**
+ *
+ * @export
+ * @interface CredentialSchemaItem
+ */
+export interface CredentialSchemaItem {
+    [key: string]: any;
+    /**
+     * A URL identifying the schema file
+     * @type {string}
+     * @memberof CredentialSchemaItem
+     */
+    'id': string;
+    /**
+     *
+     * @type {string}
+     * @memberof CredentialSchemaItem
+     */
+    'name'?: string;
+    /**
+     * Defines the schema type, for example, JsonSchema
+     * @type {string}
+     * @memberof CredentialSchemaItem
+     */
+    'type': string;
+}
+/**
+ * It is expected that the value will provide enough information to determine the current status of the credential and  that machine readable information will be retrievable from the URL https://www.w3.org/TR/vc-data-model-2.0/#defn-credentialStatus
+ * @export
+ * @interface CredentialStatus
+ */
+export interface CredentialStatus {
+    /**
+     *
+     * @type {string}
+     * @memberof CredentialStatus
+     */
+    'id': string;
+    /**
+     *
+     * @type {string}
+     * @memberof CredentialStatus
+     */
+    'type': string;
+    /**
+     *
+     * @type {string}
+     * @memberof CredentialStatus
+     */
+    'statusPurpose'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CredentialStatus
+     */
+    'statusListIndex'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CredentialStatus
+     */
+    'statusListCredential'?: string;
+}
+/**
+ * @type CredentialSubject
+ * Set of objects that MUST contain one or more claims that are each related to a subject of the verifiable credential https://www.w3.org/TR/vc-data-model-2.0/#defn-credentialSubject. Currently we support only one subject in the verifiable credential because there is no consensus about \"vc-jwt\" encoding of multi-subject verifiable credentials
+ * @export
+ */
+export type CredentialSubject = Array<CredentialSubjectItem> | CredentialSubjectItem;
+/**
+ *
+ * @export
+ * @interface CredentialSubjectItem
+ */
+export interface CredentialSubjectItem {
+    [key: string]: any;
+    /**
+     *
+     * @type {string}
+     * @memberof CredentialSubjectItem
+     */
+    'id'?: string;
+    /**
+     * Array of specific VC subject field disclosures
+     * @type {Array<string>}
+     * @memberof CredentialSubjectItem
+     */
+    '_sd'?: Array<string>;
+}
+/**
+ * The wrapper contains Verifiable Credential in both, the Credential and as Base64 signed format alongside with metadata.
+ * @export
+ * @interface CredentialWrapper
+ */
+export interface CredentialWrapper {
+    /**
+     *
+     * @type {CredentialMetadata}
+     * @memberof CredentialWrapper
+     */
+    'metadata': CredentialMetadata;
+    /**
+     *
+     * @type {Credential}
+     * @memberof CredentialWrapper
+     */
+    'vc': Credential;
+    /**
+     * The base64 encoded Verifiable Credential in its final signed form
+     * @type {string}
+     * @memberof CredentialWrapper
+     */
+    'signedVc'?: string;
+}
+/**
+ *
+ * @export
+ * @interface DidDocument
+ */
+export interface DidDocument {
+    /**
+     * The JSON-LD Context is either a string or a list containing any combination of strings and/or ordered maps. https://www.w3.org/TR/did-1.0/#dfn-context
+     * @type {Array<string>}
+     * @memberof DidDocument
+     */
+    '@context': Array<string>;
+    /**
+     * An entity that has the capability to make changes to a DID document. A DID might have more than one DID controller. The DID controller(s) can be denoted by the optional controller property at the top level of the DID document. Note that a DID controller might be the DID subject.  https://www.w3.org/TR/did-1.0/#dfn-did-controllers
+     * @type {Array<string>}
+     * @memberof DidDocument
+     */
+    'controller'?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof DidDocument
+     */
+    'id': string;
+    /**
+     * The verificationMethod property is OPTIONAL. If present, the value MUST be a set of verification methods, where each verification method is expressed using a map. The verification method map MUST include the id, type, controller, and specific verification material properties that are determined by the value of type and are defined in 5.2.1 Verification Material. A verification method MAY include additional properties. Verification methods SHOULD be registered in the DID Specification Registries [DID-SPEC-REGISTRIES]. https://www.w3.org/TR/did-1.0/#verification-methods
+     * @type {Array<VerificationMethod>}
+     * @memberof DidDocument
+     */
+    'verificationMethod'?: Array<VerificationMethod>;
+    /**
+     * The capabilityInvocation verification relationship is used to specify a verification method that might be used by the DID subject to invoke a cryptographic capability, such as the authorization to update the DID Document.   https://www.w3.org/TR/did-1.0/#capability-invocation
+     * @type {Array<CapabilityInvocationInner>}
+     * @memberof DidDocument
+     */
+    'capabilityInvocation'?: Array<CapabilityInvocationInner>;
+    /**
+     * The authentication verification relationship is used to specify how the DID subject is expected to be authenticated, for purposes such as logging into a website or engaging in any sort of challenge-response protocol.   https://www.w3.org/TR/did-1.0/#authentication
+     * @type {Array<CapabilityInvocationInner>}
+     * @memberof DidDocument
+     */
+    'authentication'?: Array<CapabilityInvocationInner>;
+    /**
+     * The assertionMethod verification relationship is used to specify how the DID subject is expected to express claims, such as for the purposes of issuing a Verifiable Credential [VC-DATA-MODEL].    https://www.w3.org/TR/did-1.0/#assertion
+     * @type {Array<CapabilityInvocationInner>}
+     * @memberof DidDocument
+     */
+    'assertionMethod'?: Array<CapabilityInvocationInner>;
+    /**
+     *
+     * @type {Services}
+     * @memberof DidDocument
+     */
+    'services'?: Services;
+}
+/**
+ *
+ * @export
+ * @interface DidDocumentCreatePayload
+ */
+export interface DidDocumentCreatePayload {
+    /**
+     * The JSON-LD Context is either a string or a list containing any combination of strings and/or ordered maps. https://www.w3.org/TR/did-1.0/#dfn-context
+     * @type {Array<string>}
+     * @memberof DidDocumentCreatePayload
+     */
+    '@context': Array<string>;
+    /**
+     * An entity that has the capability to make changes to a DID document. A DID might have more than one DID controller. The DID controller(s) can be denoted by the optional controller property at the top level of the DID document. Note that a DID controller might be the DID subject.  https://www.w3.org/TR/did-1.0/#dfn-did-controllers
+     * @type {Array<string>}
+     * @memberof DidDocumentCreatePayload
+     */
+    'controller': Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof DidDocumentCreatePayload
+     */
+    'id': string;
+}
+/**
+ *
+ * @export
+ * @interface DidDocumentList
+ */
+export interface DidDocumentList {
+    /**
+     *
+     * @type {string}
+     * @memberof DidDocumentList
+     */
+    'items'?: string;
+}
+/**
+ *
+ * @export
+ * @interface DidOnboardingPayload
+ */
+export interface DidOnboardingPayload {
+    /**
+     * The Verifier ID that should be used to verify the onboarding credential.
+     * @type {string}
+     * @memberof DidOnboardingPayload
+     */
+    'verifierId'?: string;
+}
+/**
+ *
+ * @export
+ * @interface DidOnboardingResponse
+ */
+export interface DidOnboardingResponse {
+    /**
+     * Url of verifier authorization server that contains the requested verifier scope.
+     * @type {string}
+     * @memberof DidOnboardingResponse
+     */
+    'verifierUrl': string;
+    /**
+     * A code that can be used to match the verified credential for later use.
+     * @type {string}
+     * @memberof DidOnboardingResponse
+     */
+    'verifierState': string;
+}
+/**
+ *
+ * @export
+ * @interface DidOnboardingStatus
+ */
+export interface DidOnboardingStatus {
+    /**
+     * When the status is completed the DID will be provided.
+     * @type {string}
+     * @memberof DidOnboardingStatus
+     */
+    'did'?: string;
+    /**
+     * The status message providing additional info on specific status.
+     * @type {string}
+     * @memberof DidOnboardingStatus
+     */
+    'message'?: string;
+    /**
+     * The onboarding process status
+     * @type {string}
+     * @memberof DidOnboardingStatus
+     */
+    'status': DidOnboardingStatusStatusEnum;
+}
+export declare const DidOnboardingStatusStatusEnum: {
+    readonly InProgress: "in_progress";
+    readonly Completed: "completed";
+    readonly Error: "error";
+};
+export type DidOnboardingStatusStatusEnum = typeof DidOnboardingStatusStatusEnum[keyof typeof DidOnboardingStatusStatusEnum];
+/**
+ * A scheme providing enough information for a verifier to determine whether the evidence gathered by the issuer  meets its confidence requirements for relying on the credential
+ * @export
+ * @interface EvidenceItem
+ */
+export interface EvidenceItem {
+    [key: string]: any;
+    /**
+     * URL that points to where more information about this instance of evidence can be found
+     * @type {string}
+     * @memberof EvidenceItem
+     */
+    'id'?: string;
+    /**
+     * The precise content of each evidence scheme is determined by the specific evidence type definition.
+     * @type {Array<string>}
+     * @memberof EvidenceItem
+     */
+    'type': Array<string>;
+}
+/**
+ * Health status of the system
+ * @export
+ * @interface HealthStatus
+ */
+export interface HealthStatus {
+    /**
+     *
+     * @type {string}
+     * @memberof HealthStatus
+     */
+    'status': HealthStatusStatusEnum;
+}
+export declare const HealthStatusStatusEnum: {
+    readonly Ok: "ok";
+    readonly Limited: "limited";
+    readonly Critical: "critical";
+};
+export type HealthStatusStatusEnum = typeof HealthStatusStatusEnum[keyof typeof HealthStatusStatusEnum];
+/**
+ *
+ * @export
+ * @interface IssuerDisplayItem
+ */
+export interface IssuerDisplayItem {
+    /**
+     *
+     * @type {string}
+     * @memberof IssuerDisplayItem
+     */
+    'name'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IssuerDisplayItem
+     */
+    'locale'?: string;
+    /**
+     *
+     * @type {IssuerLogo}
+     * @memberof IssuerDisplayItem
+     */
+    'logo'?: IssuerLogo;
+}
+/**
+ *
+ * @export
+ * @interface IssuerLogo
+ */
+export interface IssuerLogo {
+    /**
+     *
+     * @type {string}
+     * @memberof IssuerLogo
+     */
+    'uri'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IssuerLogo
+     */
+    'alt_text'?: string;
+}
+/**
+ * Common error message
+ * @export
+ * @interface ModelError
+ */
+export interface ModelError {
+    /**
+     *
+     * @type {string}
+     * @memberof ModelError
+     */
+    'error': string;
+    /**
+     *
+     * @type {string}
+     * @memberof ModelError
+     */
+    'message': string;
+}
+/**
+ * One or more cryptographic proofs that can be used to detect tampering and verify the authorship of a verifiable credential or verifiable presentation https://www.w3.org/TR/vc-data-model-2.0/#securing-verifiable-credentials
+ * @export
+ * @interface Proof
+ */
+export interface Proof {
+    /**
+     *
+     * @type {string}
+     * @memberof Proof
+     */
+    'type': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Proof
+     */
+    'created': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Proof
+     */
+    'verificationMethod': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Proof
+     */
+    'proofPurpose': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Proof
+     */
+    'proofValue'?: string;
+}
+/**
+ * @type RefreshService
+ * A refresh service is a mechanism that can be utilized by software agents to retrieve an updated copy of a Verifiable Credential https://www.w3.org/TR/vc-data-model-2.0/#defn-refreshService
+ * @export
+ */
+export type RefreshService = Array<RefreshServiceItem> | RefreshServiceItem;
+/**
+ *
+ * @export
+ * @interface RefreshServiceItem
+ */
+export interface RefreshServiceItem {
+    /**
+     * The URL of the service
+     * @type {string}
+     * @memberof RefreshServiceItem
+     */
+    'id': string;
+    /**
+     *
+     * @type {string}
+     * @memberof RefreshServiceItem
+     */
+    'type': string;
+}
+/**
+ * Services are used in DID documents to express ways of communicating with the DID subject or associated entities. A service can be any type of service the DID subject wants to advertise, including decentralized identity management services for further discovery, authentication, authorization, or interaction.  https://www.w3.org/TR/did-1.0/#services
+ * @export
+ * @interface Services
+ */
+export interface Services {
+    /**
+     *
+     * @type {string}
+     * @memberof Services
+     */
+    'id': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Services
+     */
+    'type': string;
+    /**
+     * The value of the serviceEndpoint property MUST be a string, a map, or a set composed of one or more strings and/or maps. All string values MUST be valid URIs conforming to [RFC3986] and normalized according to the Normalization and Comparison rules in RFC3986 and to any normalization rules in its applicable URI scheme specification.  https://www.w3.org/TR/did-1.0/#dfn-serviceendpoint
+     * @type {Array<string>}
+     * @memberof Services
+     */
+    'serviceEndpoint': Array<string>;
+}
+/**
+ * Policy under which the creator issued the credential or presentation https://www.w3.org/TR/vc-data-model-2.0/#defn-termsOfUse
+ * @export
+ * @interface TermsOfUse
+ */
+export interface TermsOfUse {
+    [key: string]: any;
+    /**
+     *
+     * @type {string}
+     * @memberof TermsOfUse
+     */
+    'id'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TermsOfUse
+     */
+    'type': string;
+}
+/**
+ * Trust List meta info
+ * @export
+ * @interface Tl
+ */
+export interface Tl {
+    /**
+     *
+     * @type {string}
+     * @memberof Tl
+     */
+    'id'?: string;
+    /**
+     * Trust List human-readable name
+     * @type {string}
+     * @memberof Tl
+     */
+    'name'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Tl
+     */
+    'owner'?: string;
+    /**
+     *
+     * @type {TlrSchema}
+     * @memberof Tl
+     */
+    'tlrSchema'?: TlrSchema;
+}
+/**
+ * Trust List create payload
+ * @export
+ * @interface TlPayload
+ */
+export interface TlPayload {
+    /**
+     * Trust List human-readable name
+     * @type {string}
+     * @memberof TlPayload
+     */
+    'name'?: string;
+    /**
+     *
+     * @type {TlrSchema}
+     * @memberof TlPayload
+     */
+    'tlrSchema'?: TlrSchema;
+}
+/**
+ * Record defined by a schema
+ * @export
+ * @interface Tlr
+ */
+export interface Tlr {
+    [key: string]: any;
+    /**
+     * The JSON-LD Context is either a string or a list containing any combination of strings and/or ordered maps. https://www.w3.org/TR/did-1.0/#dfn-context
+     * @type {Array<string>}
+     * @memberof Tlr
+     */
+    '@context': Array<string>;
+    /**
+     *
+     * @type {TlrSchema}
+     * @memberof Tlr
+     */
+    'tlrSchema': TlrSchema;
+}
+/**
+ *
+ * @export
+ * @interface TlrSchema
+ */
+export interface TlrSchema {
+    [key: string]: any;
+    /**
+     * A URL identifying the schema file
+     * @type {string}
+     * @memberof TlrSchema
+     */
+    'id': string;
+    /**
+     *
+     * @type {string}
+     * @memberof TlrSchema
+     */
+    'name'?: string;
+    /**
+     * Defines the schema type, for example, JsonSchema
+     * @type {string}
+     * @memberof TlrSchema
+     */
+    'type': string;
+}
+/**
+ *
+ * @export
+ * @interface VerificationMethod
+ */
+export interface VerificationMethod {
+    [key: string]: any;
+    /**
+     *
+     * @type {string}
+     * @memberof VerificationMethod
+     */
+    'controller': string;
+    /**
+     *
+     * @type {string}
+     * @memberof VerificationMethod
+     */
+    'id': string;
+    /**
+     * The value of the type property MUST be a string that references exactly one verification method type. In order to maximize global interoperability, the verification method type SHOULD be registered in the DID Specification Registries [DID-SPEC-REGISTRIES].
+     * @type {string}
+     * @memberof VerificationMethod
+     */
+    'type': string;
+}
+/**
+ *
+ * @export
+ * @interface VpResponse
+ */
+export interface VpResponse {
+    /**
+     * Verifiable Presentation in JWT format
+     * @type {string}
+     * @memberof VpResponse
+     */
+    'vp': string;
+}
+/**
+ * DefaultApi - axios parameter creator
+ * @export
+ */
+export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Retrieves a specific verifiable credential based on the provided identifier.  Upon retrieval the status of the credential is checked on the fly and therefore guaranteed.
+     * @param {string} credentialId Verifiable Credential Identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    credentialGet: (credentialId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Creates a new DID Document.
+     * @param {string} tlId
+     * @param {DidDocumentCreatePayload} [didDocumentCreatePayload] DID Document Create Payload.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    didDocumentCreate: (tlId: string, didDocumentCreatePayload?: DidDocumentCreatePayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves a specific DID Document
+     * @param {string} tlId Trust List Identifier
+     * @param {string} did DID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    didGet: (tlId: string, did: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Initiates the onboarding process to the DID registry.
+     * @param {string} tlId
+     * @param {DidOnboardingPayload} [didOnboardingPayload] DID onboarding init payload.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    didOnboardingInit: (tlId: string, didOnboardingPayload?: DidOnboardingPayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} tlId
+     * @param {string} verifierState The verifier state provided by the onboarding endpoint
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    didOnboardingStatus: (tlId: string, verifierState: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Adds DID Verification method.
+     * @param {string} tlId Trust List Identifier
+     * @param {string} did DID
+     * @param {VerificationMethod} [verificationMethod] Verification method.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    didVerificationMethodAdd: (tlId: string, did: string, verificationMethod?: VerificationMethod, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves a list of DID Documents.
+     * @param {string} tlId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    didsGet: (tlId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    healthCheck: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Creates a Trust List based on the specified payload.
+     * @param {TlPayload} [tlPayload] Trust List create payload.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    tlCreate: (tlPayload?: TlPayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Gets the specified Trust List
+     * @param {string} tlId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    tlGet: (tlId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates a Trust List based on the specified payload.
+     * @param {string} tlId
+     * @param {TlPayload} [tlPayload] Trust List create payload.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    tlPatch: (tlId: string, tlPayload?: TlPayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Creates a new Trust List Record.
+     * @param {string} tlId
+     * @param {DidDocumentCreatePayload} [didDocumentCreatePayload] Trust List Record create payload.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    tlrCreate: (tlId: string, didDocumentCreatePayload?: DidDocumentCreatePayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves a list of Trust List Records.
+     * @param {string} tlId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    tlrsGet: (tlId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves a specific Trust List Record
+     * @param {string} tlId Trust List Identifier
+     * @param {string} tlrId Trust List Record Identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    trustListRecordGet: (tlId: string, tlrId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Gets a Verifiable Presentation.
+     * @param {string} tlId
+     * @param {string} did
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    vpGet: (tlId: string, did: string, id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * DefaultApi - functional programming interface
+ * @export
+ */
+export declare const DefaultApiFp: (configuration?: Configuration) => {
+    /**
+     * Retrieves a specific verifiable credential based on the provided identifier.  Upon retrieval the status of the credential is checked on the fly and therefore guaranteed.
+     * @param {string} credentialId Verifiable Credential Identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    credentialGet(credentialId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CredentialWrapper>>;
+    /**
+     * Creates a new DID Document.
+     * @param {string} tlId
+     * @param {DidDocumentCreatePayload} [didDocumentCreatePayload] DID Document Create Payload.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    didDocumentCreate(tlId: string, didDocumentCreatePayload?: DidDocumentCreatePayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
+    /**
+     * Retrieves a specific DID Document
+     * @param {string} tlId Trust List Identifier
+     * @param {string} did DID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    didGet(tlId: string, did: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DidDocument>>;
+    /**
+     * Initiates the onboarding process to the DID registry.
+     * @param {string} tlId
+     * @param {DidOnboardingPayload} [didOnboardingPayload] DID onboarding init payload.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    didOnboardingInit(tlId: string, didOnboardingPayload?: DidOnboardingPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DidOnboardingResponse>>;
+    /**
+     *
+     * @param {string} tlId
+     * @param {string} verifierState The verifier state provided by the onboarding endpoint
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    didOnboardingStatus(tlId: string, verifierState: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DidOnboardingStatus>>;
+    /**
+     * Adds DID Verification method.
+     * @param {string} tlId Trust List Identifier
+     * @param {string} did DID
+     * @param {VerificationMethod} [verificationMethod] Verification method.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    didVerificationMethodAdd(tlId: string, did: string, verificationMethod?: VerificationMethod, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieves a list of DID Documents.
+     * @param {string} tlId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    didsGet(tlId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DidDocumentList>>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    healthCheck(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HealthStatus>>;
+    /**
+     * Creates a Trust List based on the specified payload.
+     * @param {TlPayload} [tlPayload] Trust List create payload.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    tlCreate(tlPayload?: TlPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tl>>;
+    /**
+     * Gets the specified Trust List
+     * @param {string} tlId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    tlGet(tlId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tl>>;
+    /**
+     * Updates a Trust List based on the specified payload.
+     * @param {string} tlId
+     * @param {TlPayload} [tlPayload] Trust List create payload.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    tlPatch(tlId: string, tlPayload?: TlPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tl>>;
+    /**
+     * Creates a new Trust List Record.
+     * @param {string} tlId
+     * @param {DidDocumentCreatePayload} [didDocumentCreatePayload] Trust List Record create payload.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    tlrCreate(tlId: string, didDocumentCreatePayload?: DidDocumentCreatePayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CredentialIdObject>>;
+    /**
+     * Retrieves a list of Trust List Records.
+     * @param {string} tlId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    tlrsGet(tlId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DidDocumentList>>;
+    /**
+     * Retrieves a specific Trust List Record
+     * @param {string} tlId Trust List Identifier
+     * @param {string} tlrId Trust List Record Identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    trustListRecordGet(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tlr>>;
+    /**
+     * Gets a Verifiable Presentation.
+     * @param {string} tlId
+     * @param {string} did
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    vpGet(tlId: string, did: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VpResponse>>;
+};
+/**
+ * DefaultApi - factory interface
+ * @export
+ */
+export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Retrieves a specific verifiable credential based on the provided identifier.  Upon retrieval the status of the credential is checked on the fly and therefore guaranteed.
+     * @param {string} credentialId Verifiable Credential Identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    credentialGet(credentialId: string, options?: RawAxiosRequestConfig): AxiosPromise<CredentialWrapper>;
+    /**
+     * Creates a new DID Document.
+     * @param {string} tlId
+     * @param {DidDocumentCreatePayload} [didDocumentCreatePayload] DID Document Create Payload.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    didDocumentCreate(tlId: string, didDocumentCreatePayload?: DidDocumentCreatePayload, options?: RawAxiosRequestConfig): AxiosPromise<string>;
+    /**
+     * Retrieves a specific DID Document
+     * @param {string} tlId Trust List Identifier
+     * @param {string} did DID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    didGet(tlId: string, did: string, options?: RawAxiosRequestConfig): AxiosPromise<DidDocument>;
+    /**
+     * Initiates the onboarding process to the DID registry.
+     * @param {string} tlId
+     * @param {DidOnboardingPayload} [didOnboardingPayload] DID onboarding init payload.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    didOnboardingInit(tlId: string, didOnboardingPayload?: DidOnboardingPayload, options?: RawAxiosRequestConfig): AxiosPromise<DidOnboardingResponse>;
+    /**
+     *
+     * @param {string} tlId
+     * @param {string} verifierState The verifier state provided by the onboarding endpoint
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    didOnboardingStatus(tlId: string, verifierState: string, options?: RawAxiosRequestConfig): AxiosPromise<DidOnboardingStatus>;
+    /**
+     * Adds DID Verification method.
+     * @param {string} tlId Trust List Identifier
+     * @param {string} did DID
+     * @param {VerificationMethod} [verificationMethod] Verification method.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    didVerificationMethodAdd(tlId: string, did: string, verificationMethod?: VerificationMethod, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Retrieves a list of DID Documents.
+     * @param {string} tlId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    didsGet(tlId: string, options?: RawAxiosRequestConfig): AxiosPromise<DidDocumentList>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    healthCheck(options?: RawAxiosRequestConfig): AxiosPromise<HealthStatus>;
+    /**
+     * Creates a Trust List based on the specified payload.
+     * @param {TlPayload} [tlPayload] Trust List create payload.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    tlCreate(tlPayload?: TlPayload, options?: RawAxiosRequestConfig): AxiosPromise<Tl>;
+    /**
+     * Gets the specified Trust List
+     * @param {string} tlId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    tlGet(tlId: string, options?: RawAxiosRequestConfig): AxiosPromise<Tl>;
+    /**
+     * Updates a Trust List based on the specified payload.
+     * @param {string} tlId
+     * @param {TlPayload} [tlPayload] Trust List create payload.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    tlPatch(tlId: string, tlPayload?: TlPayload, options?: RawAxiosRequestConfig): AxiosPromise<Tl>;
+    /**
+     * Creates a new Trust List Record.
+     * @param {string} tlId
+     * @param {DidDocumentCreatePayload} [didDocumentCreatePayload] Trust List Record create payload.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    tlrCreate(tlId: string, didDocumentCreatePayload?: DidDocumentCreatePayload, options?: RawAxiosRequestConfig): AxiosPromise<CredentialIdObject>;
+    /**
+     * Retrieves a list of Trust List Records.
+     * @param {string} tlId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    tlrsGet(tlId: string, options?: RawAxiosRequestConfig): AxiosPromise<DidDocumentList>;
+    /**
+     * Retrieves a specific Trust List Record
+     * @param {string} tlId Trust List Identifier
+     * @param {string} tlrId Trust List Record Identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    trustListRecordGet(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): AxiosPromise<Tlr>;
+    /**
+     * Gets a Verifiable Presentation.
+     * @param {string} tlId
+     * @param {string} did
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    vpGet(tlId: string, did: string, id: string, options?: RawAxiosRequestConfig): AxiosPromise<VpResponse>;
+};
+/**
+ * DefaultApi - object-oriented interface
+ * @export
+ * @class DefaultApi
+ * @extends {BaseAPI}
+ */
+export declare class DefaultApi extends BaseAPI {
+    /**
+     * Retrieves a specific verifiable credential based on the provided identifier.  Upon retrieval the status of the credential is checked on the fly and therefore guaranteed.
+     * @param {string} credentialId Verifiable Credential Identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    credentialGet(credentialId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CredentialWrapper, any>>;
+    /**
+     * Creates a new DID Document.
+     * @param {string} tlId
+     * @param {DidDocumentCreatePayload} [didDocumentCreatePayload] DID Document Create Payload.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    didDocumentCreate(tlId: string, didDocumentCreatePayload?: DidDocumentCreatePayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
+    /**
+     * Retrieves a specific DID Document
+     * @param {string} tlId Trust List Identifier
+     * @param {string} did DID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    didGet(tlId: string, did: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DidDocument, any>>;
+    /**
+     * Initiates the onboarding process to the DID registry.
+     * @param {string} tlId
+     * @param {DidOnboardingPayload} [didOnboardingPayload] DID onboarding init payload.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    didOnboardingInit(tlId: string, didOnboardingPayload?: DidOnboardingPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DidOnboardingResponse, any>>;
+    /**
+     *
+     * @param {string} tlId
+     * @param {string} verifierState The verifier state provided by the onboarding endpoint
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    didOnboardingStatus(tlId: string, verifierState: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DidOnboardingStatus, any>>;
+    /**
+     * Adds DID Verification method.
+     * @param {string} tlId Trust List Identifier
+     * @param {string} did DID
+     * @param {VerificationMethod} [verificationMethod] Verification method.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    didVerificationMethodAdd(tlId: string, did: string, verificationMethod?: VerificationMethod, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Retrieves a list of DID Documents.
+     * @param {string} tlId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    didsGet(tlId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DidDocumentList, any>>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    healthCheck(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HealthStatus, any>>;
+    /**
+     * Creates a Trust List based on the specified payload.
+     * @param {TlPayload} [tlPayload] Trust List create payload.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    tlCreate(tlPayload?: TlPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Tl, any>>;
+    /**
+     * Gets the specified Trust List
+     * @param {string} tlId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    tlGet(tlId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Tl, any>>;
+    /**
+     * Updates a Trust List based on the specified payload.
+     * @param {string} tlId
+     * @param {TlPayload} [tlPayload] Trust List create payload.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    tlPatch(tlId: string, tlPayload?: TlPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Tl, any>>;
+    /**
+     * Creates a new Trust List Record.
+     * @param {string} tlId
+     * @param {DidDocumentCreatePayload} [didDocumentCreatePayload] Trust List Record create payload.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    tlrCreate(tlId: string, didDocumentCreatePayload?: DidDocumentCreatePayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CredentialIdObject, any>>;
+    /**
+     * Retrieves a list of Trust List Records.
+     * @param {string} tlId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    tlrsGet(tlId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DidDocumentList, any>>;
+    /**
+     * Retrieves a specific Trust List Record
+     * @param {string} tlId Trust List Identifier
+     * @param {string} tlrId Trust List Record Identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    trustListRecordGet(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Tlr, any>>;
+    /**
+     * Gets a Verifiable Presentation.
+     * @param {string} tlId
+     * @param {string} did
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    vpGet(tlId: string, did: string, id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VpResponse, any>>;
+}