@triveria/wallet / Exports / Client
Class: Client
DefaultApi - object-oriented interface
Export
Hierarchy
-
↳
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 Client(tokenUrl
, audience
, clientId
, clientSecret
, baseURL
, axios?
): Client
Parameters
Name | Type | Default value |
---|---|---|
tokenUrl | string | undefined |
audience | string | undefined |
clientId | string | undefined |
clientSecret | string | undefined |
baseURL | string | undefined |
axios | AxiosInstance | globalAxios |
Returns
Overrides
Defined in
Properties
axios
• Protected
axios: AxiosInstance
= globalAxios
Inherited from
Defined in
basePath
• Protected
basePath: string
= BASE_PATH
Inherited from
Defined in
baseURL
• Protected
baseURL: string
Defined in
configuration
• Protected
configuration: undefined
| Configuration
Inherited from
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
Inherited from
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
Inherited from
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
Inherited from
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
Inherited from
DefaultApi.credentialIssuanceInit
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
Inherited from
Defined in
credentialMetadataPatch
▸ credentialMetadataPatch(credentialId
, walletId
, credentialMetadataPatchPayload?
, options?
): Promise
<AxiosResponse
<CredentialIdObject
, any
>>
Verifiable Credential metadata may be updated even after the credential was issued. It is available as a key value storage for a client to store any additional data for the credential.
Parameters
Name | Type | Description |
---|---|---|
credentialId | string | Verifiable Credential Identifier |
walletId | string | |
credentialMetadataPatchPayload? | CredentialMetadataPatchPayload | Verifiable Credential metadata in JSON |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<CredentialIdObject
, any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.credentialMetadataPatch
Defined in
credentialPatch
▸ credentialPatch(credentialId
, walletId
, credentialPatchPayload?
, options?
): Promise
<AxiosResponse
<CredentialIdObject
, any
>>
Endpoint used to update an existing Credential in draft state. Can be used for additional updates before the Credential is issued. After credential is issued it may not be changed in any way.
Parameters
Name | Type | Description |
---|---|---|
credentialId | string | Verifiable Credential Identifier |
walletId | string | |
credentialPatchPayload? | CredentialPatchPayload | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<CredentialIdObject
, any
>>
Throws
Memberof
DefaultApi
Inherited from
Defined in
credentialRequestInit
▸ credentialRequestInit(walletId
, credentialRequest?
, options?
): Promise
<AxiosResponse
<string
[], any
>>
Requests a credential issuance from the issuer and retrieves requirements for holder authorization.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
credentialRequest? | CredentialRequest | A Verifiable Credential request: types and URL of the issuer |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<string
[], any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.credentialRequestInit
Defined in
credentialRevoke
▸ credentialRevoke(credentialId
, walletId
, options?
): Promise
<AxiosResponse
<void
, any
>>
Revoke a specific Verifiable Credential
Parameters
Name | Type | Description |
---|---|---|
credentialId | string | Verifiable Credential Identifier |
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<void
, any
>>
Throws
Memberof
DefaultApi
Inherited from
Defined in
deferredStatus
▸ deferredStatus(deferredId
, walletId
, options?
): Promise
<AxiosResponse
<Deferred
, any
>>
Parameters
Name | Type | Description |
---|---|---|
deferredId | string | Deferred token |
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<Deferred
, any
>>
Throws
Memberof
DefaultApi
Inherited from
Defined in
didDocumentGet
▸ didDocumentGet(walletId
, options?
): Promise
<AxiosResponse
<object
, any
>>
Gets the DID Document of the wallet.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<object
, any
>>
Throws
Memberof
DefaultApi
Inherited from
Defined in
didGet
▸ didGet(walletId
, options?
): Promise
<AxiosResponse
<Did
, any
>>
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<Did
, any
>>
Throws
Memberof
DefaultApi
Inherited from
Defined in
healthCheck
▸ healthCheck(options?
): Promise
<AxiosResponse
<HealthStatus
, any
>>
Parameters
Name | Type | Description |
---|---|---|
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<HealthStatus
, any
>>
Throws
Memberof
DefaultApi
Inherited from
Defined in
holderCreateAuthOffer
▸ holderCreateAuthOffer(walletId
, holderAuthOfferCreationRequest?
, options?
): Promise
<AxiosResponse
<void
, any
>>
Creates an authorized credential offer (deferred or instant) for holder-initiated credential request using provided parameters. The offer is an URL that the creator should provide to the client via a redirect, link, or QR code.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
holderAuthOfferCreationRequest? | HolderAuthOfferCreationRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<void
, any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.holderCreateAuthOffer
Defined in
holderCredentialsPresentAfterConsent
▸ holderCredentialsPresentAfterConsent(walletId
, interactionId
, interactionAuthorizationConsent?
, options?
): Promise
<AxiosResponse
<void
, any
>>
Presenting Verifiable Credentials after holder's consent.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
interactionId | string | |
interactionAuthorizationConsent? | InteractionAuthorizationConsent | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<void
, any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.holderCredentialsPresentAfterConsent
Defined in
holderIdTokenSend
▸ holderIdTokenSend(walletId
, idTokenSendRequest?
, options?
): Promise
<AxiosResponse
<void
, any
>>
Responds to an ID token request
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
idTokenSendRequest? | IdTokenSendRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<void
, any
>>
Throws
Memberof
DefaultApi
Inherited from
Defined in
holderLinkedVpCreate
▸ holderLinkedVpCreate(walletId
, linkedVpCreateRequest?
, options?
): Promise
<AxiosResponse
<LinkedVpMetadata
, any
>>
Creates a new public Linked VP of specified credentials and adds it to the wallet's DID document
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
linkedVpCreateRequest? | LinkedVpCreateRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<LinkedVpMetadata
, any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.holderLinkedVpCreate
Defined in
holderLinkedVpDelete
▸ holderLinkedVpDelete(walletId
, linkedVpId
, options?
): Promise
<AxiosResponse
<void
, any
>>
Deletes a linked VP
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
linkedVpId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<void
, any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.holderLinkedVpDelete
Defined in
holderLinkedVpGetDetails
▸ holderLinkedVpGetDetails(walletId
, linkedVpId
, options?
): Promise
<AxiosResponse
<LinkedVpMetadata
, any
>>
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
linkedVpId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<LinkedVpMetadata
, any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.holderLinkedVpGetDetails
Defined in
holderLinkedVpList
▸ holderLinkedVpList(walletId
, options?
): Promise
<AxiosResponse
<LinkedVpMetadata
[], any
>>
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<LinkedVpMetadata
[], any
>>
Throws
Memberof
DefaultApi
Inherited from
Defined in
holderOfferPassAuthInfo
▸ holderOfferPassAuthInfo(walletId
, vcOffer?
, options?
): Promise
<AxiosResponse
<InteractionAuthorizationRequirements
, any
>>
Issue the Verifiable Credential using OIDC4VCI offer acceptance
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
vcOffer? | VcOffer | Offer URL and optional PIN for the request |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<InteractionAuthorizationRequirements
, any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.holderOfferPassAuthInfo
Defined in
holderOfferProcessAfterConsent
▸ holderOfferProcessAfterConsent(walletId
, interactionId
, interactionAuthorizationConsent?
, options?
): Promise
<AxiosResponse
<string
[], any
>>
Gives consent to process credential offer specified by interaction_id
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
interactionId | string | |
interactionAuthorizationConsent? | InteractionAuthorizationConsent | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<string
[], any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.holderOfferProcessAfterConsent
Defined in
holderPresentPassAuthInfo
▸ holderPresentPassAuthInfo(walletId
, presentationRequest?
, options?
): Promise
<AxiosResponse
<InteractionAuthorizationRequirements
, any
>>
Initiates a presentation of credentials to a verifier.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
presentationRequest? | PresentationRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<InteractionAuthorizationRequirements
, any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.holderPresentPassAuthInfo
Defined in
idTokenRequestCreate
▸ idTokenRequestCreate(walletId
, options?
): Promise
<AxiosResponse
<IdTokenRequest
, any
>>
Creates an ID token request.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<IdTokenRequest
, any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.idTokenRequestCreate
Defined in
issuerCredentialTypesList
▸ issuerCredentialTypesList(url
, options?
): Promise
<AxiosResponse
<CredentialType
[], any
>>
Returns verifiable credential format and types that are supported by the issuer. - format: the verifiable credential format (for example "jwt_vc") - type: a list of strings that define supported verifiable credential type(s)
Parameters
Name | Type | Description |
---|---|---|
url | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<CredentialType
[], any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.issuerCredentialTypesList
Defined in
issuerInitiateAuthOffer
▸ issuerInitiateAuthOffer(walletId
, initAuthOffer?
, options?
): Promise
<AxiosResponse
<AuthOffer
, any
>>
Initiates issuing of Verifiable Credentials using authorized flow.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
initAuthOffer? | InitAuthOffer | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<AuthOffer
, any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.issuerInitiateAuthOffer
Defined in
issuerInitiatePreauthOffer
▸ issuerInitiatePreauthOffer(walletId
, initPreAuthOffer?
, options?
): Promise
<AxiosResponse
<PreAuthOffer
, any
>>
Initiates issuing of Verifiable Credentials using pre-authorized flow.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
initPreAuthOffer? | InitPreAuthOffer | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<PreAuthOffer
, any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.issuerInitiatePreauthOffer
Defined in
tfAccreditAs
▸ tfAccreditAs(walletId
, accreditationRequest?
, options?
): Promise
<AxiosResponse
<void
, any
>>
Accredits a legal entity as RTAO or TAO.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
accreditationRequest? | AccreditationRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<void
, any
>>
Throws
Memberof
DefaultApi
Inherited from
Defined in
tfAccreditAsTrustedIssuer
▸ tfAccreditAsTrustedIssuer(walletId
, options?
): Promise
<AxiosResponse
<void
, any
>>
Accredits the wallet as a trusted issuer.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<void
, any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.tfAccreditAsTrustedIssuer
Defined in
tfInsertIssuerProxy
▸ tfInsertIssuerProxy(walletId
, options?
): Promise
<AxiosResponse
<void
, any
>>
Registers an issuer proxy used by EBSI for the credential status retrieval through EBSI network.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<void
, any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.tfInsertIssuerProxy
Defined in
tfOnboardLegalEntity
▸ tfOnboardLegalEntity(walletId
, options?
): Promise
<AxiosResponse
<OnboardResult
, any
>>
Onboards legal entity to the trust framework based on the wallet configuration.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<OnboardResult
, any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.tfOnboardLegalEntity
Defined in
tfPrepareToAccredit
▸ tfPrepareToAccredit(walletId
, prepareToAccreditRequest?
, options?
): Promise
<AxiosResponse
<void
, any
>>
Prepares another legal entity's wallet DID for accreditation.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
prepareToAccreditRequest? | PrepareToAccreditRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<void
, any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.tfPrepareToAccredit
Defined in
tfPrepareToOnboard
▸ tfPrepareToOnboard(walletId
, prepareToOnboardRequest?
, options?
): Promise
<AxiosResponse
<void
, any
>>
Prepares another legal entity's wallet DID for onboarding.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
prepareToOnboardRequest? | PrepareToOnboardRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<void
, any
>>
Throws
Memberof
DefaultApi
Inherited from
Defined in
tfRevokeAccreditation
▸ tfRevokeAccreditation(walletId
, revokeAccreditationRequest?
, options?
): Promise
<AxiosResponse
<void
, any
>>
Revokes another legal entity's wallet DID accreditation.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
revokeAccreditationRequest? | RevokeAccreditationRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<void
, any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.tfRevokeAccreditation
Defined in
verifierInitUrlCreate
▸ verifierInitUrlCreate(walletId
, verifyInitRequest?
, options?
): Promise
<AxiosResponse
<VerifyInitResponse
, any
>>
Returns an url where verifier accepts presentations from a holder.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
verifyInitRequest? | VerifyInitRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<VerifyInitResponse
, any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.verifierInitUrlCreate
Defined in
verifierLinkedVpVerify
▸ verifierLinkedVpVerify(walletId
, did
, options?
): Promise
<AxiosResponse
<VerifiedLinkedVp
[], any
>>
Fetches linked presentations from DID document and verifies them.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
did | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<VerifiedLinkedVp
[], any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.verifierLinkedVpVerify
Defined in
walletCreate
▸ walletCreate(wallet?
, options?
): Promise
<AxiosResponse
<WalletIdObject
, any
>>
Creates a new wallet for the authenticated client.
Parameters
Name | Type | Description |
---|---|---|
wallet? | Wallet | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<WalletIdObject
, any
>>
Throws
Memberof
DefaultApi
Inherited from
Defined in
walletDelete
▸ walletDelete(walletId
, options?
): Promise
<AxiosResponse
<void
, any
>>
Permanently deletes the wallet with all credentials and keys. Make sure you know what you are doing before hitting this endpoint.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<void
, any
>>
Throws
Memberof
DefaultApi
Inherited from
Defined in
walletGet
▸ walletGet(walletId
, options?
): Promise
<AxiosResponse
<Wallet
, any
>>
Provides wallet details
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<Wallet
, any
>>
Throws
Memberof
DefaultApi
Inherited from
Defined in
walletKeys
▸ walletKeys(walletId
, options?
): Promise
<AxiosResponse
<{ [key: string]
: any
; }, any
>>
Provides wallet keys used for signing.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | Wallet ID |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<{ [key: string]
: any
; }, any
>>
Throws
Memberof
DefaultApi
Inherited from
Defined in
walletList
▸ walletList(ownerId?
, options?
): Promise
<AxiosResponse
<WalletListItem
[], any
>>
Provides list of wallets owned by the authenticated client.
Parameters
Name | Type | Description |
---|---|---|
ownerId? | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<WalletListItem
[], any
>>
Throws
Memberof
DefaultApi
Inherited from
Defined in
walletNotificationGetByState
▸ walletNotificationGetByState(walletId
, state
, options?
): Promise
<AxiosResponse
<WalletNotification
, any
>>
Gets a specific notification by state
Parameters
Name | Type | Description |
---|---|---|
walletId | string | Wallet ID |
state | string | Verifier state |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<WalletNotification
, any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.walletNotificationGetByState
Defined in
walletNotificationHistory
▸ walletNotificationHistory(walletId
, limit?
, nextMarker?
, type?
, sort?
, options?
): Promise
<AxiosResponse
<WalletNotificationHistory
, any
>>
Provides wallet notifications that can be used to audit the wallet activity.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | Wallet ID |
limit? | number | The number of items |
nextMarker? | string | Marking the next set of items |
type? | WalletNotificationEventType [] | Notification types |
sort? | ListSort | Sort flag controls the sort direction by the time created |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<WalletNotificationHistory
, any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.walletNotificationHistory
Defined in
walletNotifications
▸ walletNotifications(walletId
, options?
): Promise
<AxiosResponse
<WalletNotification
[], any
>>
Provides first-in-first-out queue of notifications for a specific wallet.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | Wallet ID |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<WalletNotification
[], any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.walletNotifications
Defined in
walletPatch
▸ walletPatch(walletId
, wallet?
, options?
): Promise
<AxiosResponse
<WalletIdObject
, any
>>
Update wallet metadata and configuration.
Parameters
Name | Type | Description |
---|---|---|
walletId | string | |
wallet? | Wallet | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<WalletIdObject
, any
>>
Throws
Memberof
DefaultApi
Inherited from
Defined in
walletVerifiedCredentialsByState
▸ walletVerifiedCredentialsByState(walletId
, state
, options?
): Promise
<AxiosResponse
<VerifiedWrapper
, any
>>
Gets a specific verified credentials by state
Parameters
Name | Type | Description |
---|---|---|
walletId | string | Wallet ID |
state | string | Verifier state |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<VerifiedWrapper
, any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.walletVerifiedCredentialsByState
Defined in
walletVerifiedCredentialsDeleteByState
▸ walletVerifiedCredentialsDeleteByState(walletId
, state
, options?
): Promise
<AxiosResponse
<void
, any
>>
Deletes a specific verified credentials by state
Parameters
Name | Type | Description |
---|---|---|
walletId | string | Wallet ID |
state | string | Verifier state |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise
<AxiosResponse
<void
, any
>>
Throws
Memberof
DefaultApi
Inherited from
DefaultApi.walletVerifiedCredentialsDeleteByState