chore(release): 🚀 api docs v6.0.0

uport-project · Apr 2, 2024 · faa8ad3 · faa8ad3
1 parent 204afea
commit faa8ad3
Show file tree

Hide file tree

Showing 756 changed files with 8,847 additions and 921 deletions.
diff --git a/docs/api/core-types.authorizeddidcontext.authorizeddid.md b/docs/api/core-types.authorizeddidcontext.authorizeddid.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## AuthorizedDIDContext.authorizedDID property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 **Signature:**
 

diff --git a/docs/api/core-types.authorizeddidcontext.md b/docs/api/core-types.authorizeddidcontext.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## AuthorizedDIDContext interface
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 This context can be used for Veramo Agents that are created behind an authorization mechanism, that attaches a DID as the authorized executor of certain actions. This authorized DID is used to further filter the data that is available for querying.
 

diff --git a/docs/api/core-types.compactjwt.md b/docs/api/core-types.compactjwt.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## CompactJWT type
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 Represents a Json Web Token in compact form. "header.payload.signature"
 

diff --git a/docs/api/core-types.contexttype.md b/docs/api/core-types.contexttype.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## ContextType type
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 The data type for `@context` properties of credentials, presentations, etc.
 

diff --git a/docs/api/core-types.credentialpayload.__context_.md b/docs/api/core-types.credentialpayload.__context_.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## CredentialPayload."@context" property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 **Signature:**
 

diff --git a/docs/api/core-types.credentialpayload.credentialstatus.md b/docs/api/core-types.credentialpayload.credentialstatus.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## CredentialPayload.credentialStatus property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 **Signature:**
 

diff --git a/docs/api/core-types.credentialpayload.credentialsubject.md b/docs/api/core-types.credentialpayload.credentialsubject.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## CredentialPayload.credentialSubject property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 **Signature:**
 

diff --git a/docs/api/core-types.credentialpayload.expirationdate.md b/docs/api/core-types.credentialpayload.expirationdate.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## CredentialPayload.expirationDate property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 **Signature:**
 

diff --git a/docs/api/core-types.credentialpayload.id.md b/docs/api/core-types.credentialpayload.id.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## CredentialPayload.id property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 **Signature:**
 

diff --git a/docs/api/core-types.credentialpayload.issuancedate.md b/docs/api/core-types.credentialpayload.issuancedate.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## CredentialPayload.issuanceDate property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 **Signature:**
 

diff --git a/docs/api/core-types.credentialpayload.issuer.md b/docs/api/core-types.credentialpayload.issuer.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## CredentialPayload.issuer property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 **Signature:**
 

diff --git a/docs/api/core-types.credentialpayload.md b/docs/api/core-types.credentialpayload.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## CredentialPayload interface
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 Used as input when creating Verifiable Credentials
 

diff --git a/docs/api/core-types.credentialpayload.type.md b/docs/api/core-types.credentialpayload.type.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## CredentialPayload.type property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 **Signature:**
 

diff --git a/docs/api/core-types.credentialstatus.md b/docs/api/core-types.credentialstatus.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## CredentialStatus type
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 Represents the result of a status check.
 

diff --git a/docs/api/core-types.credentialstatusgenerateargs.md b/docs/api/core-types.credentialstatusgenerateargs.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## CredentialStatusGenerateArgs interface
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 Arguments for generating a `credentialStatus` property for a [VerifiableCredential](./core-types.verifiablecredential.md).
 

diff --git a/docs/api/core-types.credentialstatusgenerateargs.type.md b/docs/api/core-types.credentialstatusgenerateargs.type.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## CredentialStatusGenerateArgs.type property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 The credential status type (aka credential status method) to be used in the `credentialStatus` generation.
 

diff --git a/docs/api/core-types.credentialstatusreference.md b/docs/api/core-types.credentialstatusreference.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## CredentialStatusReference type
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 Used for the discovery of information about the current status of a verifiable credential, such as whether it is suspended or revoked. The precise contents of the credential status information is determined by the specific `credentialStatus` type definition, and varies depending on factors such as whether it is simple to implement or if it is privacy-enhancing.
 

diff --git a/docs/api/core-types.credentialstatusupdateargs.md b/docs/api/core-types.credentialstatusupdateargs.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## CredentialStatusUpdateArgs interface
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 Input arguments for [credentialStatusUpdate](./core-types.icredentialstatusmanager.credentialstatusupdate.md)
 

diff --git a/docs/api/core-types.credentialstatusupdateargs.options.md b/docs/api/core-types.credentialstatusupdateargs.options.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## CredentialStatusUpdateArgs.options property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 Options that will be forwarded to the credentialStatus method specific manager.
 

diff --git a/docs/api/core-types.credentialstatusupdateargs.vc.md b/docs/api/core-types.credentialstatusupdateargs.vc.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## CredentialStatusUpdateArgs.vc property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 The verifiable credential whose status will be updated.
 

diff --git a/docs/api/core-types.credentialsubject.md b/docs/api/core-types.credentialsubject.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## CredentialSubject type
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 The value of the credentialSubject property is defined as a set of objects that contain one or more properties that are each related to a subject of the verifiable credential. Each object MAY contain an id.
 

diff --git a/docs/api/core-types.datetype.md b/docs/api/core-types.datetype.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## DateType type
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 Represents an issuance or expiration date for Credentials / Presentations. This is used as input when creating them.
 

diff --git a/docs/api/core-types.diddoccomponent.md b/docs/api/core-types.diddoccomponent.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## DIDDocComponent type
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 Return type of [getDIDComponentById](./core-types.iresolver.getdidcomponentbyid.md) represents a `VerificationMethod` or a `ServiceEndpoint` entry from a This API may change without a BREAKING CHANGE notice.
 

diff --git a/docs/api/core-types.findargs.md b/docs/api/core-types.findargs.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## FindArgs interface
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 Represents an [IDataStoreORM](./core-types.idatastoreorm.md) Query.
 

diff --git a/docs/api/core-types.findargs.order.md b/docs/api/core-types.findargs.order.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## FindArgs.order property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 Sorts the results according to the given array of column priorities.
 

diff --git a/docs/api/core-types.findargs.skip.md b/docs/api/core-types.findargs.skip.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## FindArgs.skip property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 Ignores the first number of entries in a [IDataStoreORM](./core-types.idatastoreorm.md) query result.
 

diff --git a/docs/api/core-types.findargs.take.md b/docs/api/core-types.findargs.take.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## FindArgs.take property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 Returns at most this number of results from a [IDataStoreORM](./core-types.idatastoreorm.md) query.
 

diff --git a/docs/api/core-types.findargs.where.md b/docs/api/core-types.findargs.where.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## FindArgs.where property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 Imposes constraints on the values of the given columns. WHERE clauses are combined using AND.
 

diff --git a/docs/api/core-types.findclaimsargs.md b/docs/api/core-types.findclaimsargs.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## FindClaimsArgs type
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 The filter that can be used to find [VerifiableCredential](./core-types.verifiablecredential.md)s in the data store, based on the types and values of their claims.
 

diff --git a/docs/api/core-types.findcredentialsargs.md b/docs/api/core-types.findcredentialsargs.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## FindCredentialsArgs type
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 The filter that can be used to find [VerifiableCredential](./core-types.verifiablecredential.md)s in the data store. See [IDataStoreORM.dataStoreORMGetVerifiableCredentials()](./core-types.idatastoreorm.datastoreormgetverifiablecredentials.md)
 

diff --git a/docs/api/core-types.findidentifiersargs.md b/docs/api/core-types.findidentifiersargs.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## FindIdentifiersArgs type
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 The filter that can be used to find [IIdentifier](./core-types.iidentifier.md)s in the data store.
 

diff --git a/docs/api/core-types.findmessagesargs.md b/docs/api/core-types.findmessagesargs.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## FindMessagesArgs type
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 The filter that can be used to find [IMessage](./core-types.imessage.md)s in the data store. See [IDataStoreORM.dataStoreORMGetMessages()](./core-types.idatastoreorm.datastoreormgetmessages.md)
 

diff --git a/docs/api/core-types.findpresentationsargs.md b/docs/api/core-types.findpresentationsargs.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## FindPresentationsArgs type
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 The filter that can be used to find [VerifiablePresentation](./core-types.verifiablepresentation.md)s in the data store. See [IDataStoreORM.dataStoreORMGetVerifiablePresentations()](./core-types.idatastoreorm.datastoreormgetverifiablepresentations.md)
 

diff --git a/docs/api/core-types.getdidcomponentargs.diddocument.md b/docs/api/core-types.getdidcomponentargs.diddocument.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## GetDIDComponentArgs.didDocument property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 the DID document from which to extract the fragment. This MUST be the document resolved by [IResolver.resolveDid()](./core-types.iresolver.resolvedid.md)
 

diff --git a/docs/api/core-types.getdidcomponentargs.didurl.md b/docs/api/core-types.getdidcomponentargs.didurl.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## GetDIDComponentArgs.didUrl property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 The DID URI that needs to be dereferenced. This should refer to the subsection by \#fragment.
 

diff --git a/docs/api/core-types.getdidcomponentargs.md b/docs/api/core-types.getdidcomponentargs.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## GetDIDComponentArgs interface
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 Input arguments for [getDIDComponentById](./core-types.iresolver.getdidcomponentbyid.md) This API may change without a BREAKING CHANGE notice.
 

diff --git a/docs/api/core-types.getdidcomponentargs.section.md b/docs/api/core-types.getdidcomponentargs.section.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## GetDIDComponentArgs.section property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 Optional. The section of the DID document where to search for the fragment. Example 'keyAgreement', or 'assertionMethod', or 'authentication', etc
 

diff --git a/docs/api/core-types.icheckcredentialstatusargs.credential.md b/docs/api/core-types.icheckcredentialstatusargs.credential.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## ICheckCredentialStatusArgs.credential property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 The credential whose status needs to be checked
 

diff --git a/docs/api/core-types.icheckcredentialstatusargs.diddocumentoverride.md b/docs/api/core-types.icheckcredentialstatusargs.diddocumentoverride.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## ICheckCredentialStatusArgs.didDocumentOverride property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 The DID document of the issuer. This can be used in case the DID Document is already resolver, to avoid a potentially expensive DID resolution operation.
 

diff --git a/docs/api/core-types.icheckcredentialstatusargs.md b/docs/api/core-types.icheckcredentialstatusargs.md
@@ -8,7 +8,7 @@ hide_title: true
 
 ## ICheckCredentialStatusArgs interface
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 Arguments for calling [checkCredentialStatus](./core-types.icredentialstatusverifier.checkcredentialstatus.md).
 
@@ -21,9 +21,11 @@ This API may change without a BREAKING CHANGE notice.
 **Signature:**
 
 ```typescript
-export interface ICheckCredentialStatusArgs
+export interface ICheckCredentialStatusArgs extends UsingResolutionOptions
 ```
 
+**Extends:** [UsingResolutionOptions](./core-types.usingresolutionoptions.md)
+
 ## Properties
 
 | Property                                                                               | Modifiers | Type                                                         | Description                                                                                                                                                                         |