@triveria/wallet / Exports / DefaultApi
Class: DefaultApi
DefaultApi - object-oriented interface
Export
Hierarchy
-
BaseAPI
↳
DefaultApi
↳↳
Client
Table of contents
Constructors
Properties
Methods
- credentialCreate
- credentialGet
- credentialImport
- credentialIssuanceInit
- credentialList
- credentialMetadataPatch
- credentialPatch
- credentialRequestInit
- credentialRevoke
- deferredStatus
- didDocumentGet
- didGet
- healthCheck
- holderCreateAuthOffer
- holderCredentialsPresentAfterConsent
- holderIdTokenSend
- holderLinkedVpCreate
- holderLinkedVpDelete
- holderLinkedVpGetDetails
- holderLinkedVpList
- holderOfferPassAuthInfo
- holderOfferProcessAfterConsent
- holderPresentPassAuthInfo
- idTokenRequestCreate
- issuerCredentialTypesList
- issuerInitiateAuthOffer
- issuerInitiatePreauthOffer
- tfAccreditAs
- tfAccreditAsTrustedIssuer
- tfInsertIssuerProxy
- tfOnboardLegalEntity
- tfPrepareToAccredit
- tfPrepareToOnboard
- tfRevokeAccreditation
- verifierInitUrlCreate
- verifierLinkedVpVerify
- walletCreate
- walletDelete
- walletGet
- walletKeys
- walletList
- walletNotificationGetByState
- walletNotificationHistory
- walletNotifications
- walletPatch
- walletVerifiedCredentialsByState
- walletVerifiedCredentialsDeleteByState
Constructors
constructor
• new DefaultApi(configuration?
, basePath?
, axios?
): DefaultApi
Parameters
Name | Type | Default value |
---|---|---|
configuration? | Configuration | undefined |
basePath | string | BASE_PATH |
axios | AxiosInstance | globalAxios |
Returns
Inherited from
BaseAPI.constructor
Defined in
Properties
axios
• Protected
axios: AxiosInstance
= globalAxios
Inherited from
BaseAPI.axios
Defined in
basePath
• Protected
basePath: string
= BASE_PATH
Inherited from
BaseAPI.basePath
Defined in
configuration
• Protected
configuration: undefined
| Configuration
Inherited from
BaseAPI.configuration
Defined in
Methods
credentialCreate
▸ credentialCreate(walletId
, credentialPayload?
, options?
): Promise
<AxiosResponse
<CredentialIdObject
, any
>>
Creates a new draft credential.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
credentialPayload? | CredentialPayload | A Verifiable Credential payload in JSON format. |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<CredentialIdObject
, any
>>
Throws
Memberof
DefaultApi
Defined in
credentialGet
▸ credentialGet(credentialId
, walletId
, options?
): Promise
<AxiosResponse
<CredentialWrapper
, any
>>
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.
Parameters
Name | Type | Description |
---|---|---|
credentialId | string | Verifiable Credential Identifier |
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<CredentialWrapper
, any
>>
Throws
Memberof
DefaultApi
Defined in
credentialImport
▸ credentialImport(walletId
, credentialImport?
, options?
): Promise
<AxiosResponse
<Credential
, any
>>
Import pre-signed credential into wallet
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
credentialImport? | CredentialImport | A Verifiable Credential payload in JSON format. |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<Credential
, any
>>
Throws
Memberof
DefaultApi
Defined in
credentialIssuanceInit
▸ credentialIssuanceInit(credentialId
, walletId
, credentialIssuanceInit?
, options?
): Promise
<AxiosResponse
<CredentialIssuanceInitResult
, any
>>
Prepares created Verifiable Credential draft for its issuance for a specific client.
Parameters
Name | Type | Description |
---|---|---|
credentialId | string | |
walletId | string | |
credentialIssuanceInit? | CredentialIssuanceInit | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<CredentialIssuanceInitResult
, any
>>
Throws
Memberof
DefaultApi
Defined in
credentialList
▸ credentialList(walletId
, interaction?
, type?
, valid?
, limit?
, nextMarker?
, sort?
, searchPath?
, filter?
, options?
): Promise
<AxiosResponse
<CredentialList
, any
>>
Retrieves a list of credentials.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
interaction? | CredentialListInteractionEnum | The interaction that is the origin of the credential. This parameter is mutually exclusive with the "type" parameter. |
type? | string | The credential type as comma delimited list representing a single type. This parameter is mutually exclusive with the "interaction" parameter. I.e. VerifiableCredential,VerifiableAttestation,Europass. |
valid? | boolean | The credential validity flag. If not provided credentials with any validity will be returned. |
limit? | number | The number of items |
nextMarker? | string | Marking the next set of items |
sort? | ListSort | Sort flag controls the sort direction by the time updated or issued |
searchPath? | string | JSON path specification for the filter to apply |
filter? | string | JSON schema filter used to select the credentials (base64 encoded) |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<CredentialList
, any
>>
Throws
Memberof
DefaultApi