@triveria/wallet / Exports / Client

Class: Client

DefaultApi - object-oriented interface

Export

Hierarchy

• DefaultApi

  ↳ Client

Table of contents

Constructors

• constructor

Properties

• axios
• basePath
• baseURL
• configuration

Methods

• accreditAsTrustedIssuer
• credentialCreate
• credentialGet
• credentialImport
• credentialList
• credentialMetadataPatch
• credentialPatch
• credentialRequest
• deferredStatus
• getCurrentDid
• healthCheck
• holderCreateAuthOffer
• issuerCredentialTypesList
• oidcAcceptOffer
• oidcAddCredToIssuanceQueue
• oidcCreateIdTokenRequest
• oidcInitiateDeferred
• oidcInitiateIntime
• oidcInitiatePreauth
• oidcPresentCredentials
• oidcSendIdToken
• oidcVerifyInitUrl
• onboardLegalEntity
• walletGet
• walletList
• walletNotifications
• walletSave

Constructors

constructor

• new Client(clientId, clientSecret, baseURL?, axios?): Client

Parameters

Name	Type	Default value
clientId	string	undefined
clientSecret	string	undefined
baseURL	string	"https://wallet.dev.triveria.io/api/v1"
axios	AxiosInstance	globalAxios

Returns

Client

Overrides

DefaultApi.constructor

Defined in

client.ts:21

Properties

axios

• Protected axios: AxiosInstance = globalAxios

Inherited from

DefaultApi.axios

Defined in

client.ts:21

---

basePath

• Protected basePath: string = BASE_PATH

Inherited from

DefaultApi.basePath

Defined in

base.ts:53

---

baseURL

• Protected baseURL: string = "https://wallet.dev.triveria.io/api/v1"

Defined in

client.ts:21

---

configuration

• Protected configuration: undefined | Configuration

Inherited from

DefaultApi.configuration

Defined in

base.ts:51

Methods

accreditAsTrustedIssuer

▸ accreditAsTrustedIssuer(walletId, options?): Promise<AxiosResponse<void, any>>

TBD

Parameters

Name	Type	Description
walletId	string
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<void, any>>

Throws

Memberof

DefaultApi

Inherited from

DefaultApi.accreditAsTrustedIssuer

Defined in

api.ts:2944

---

credentialCreate

▸ credentialCreate(walletId, credentialPayload?, options?): Promise<AxiosResponse<CredentialIdObject, any>>

Creates a new credential, which is always created in a draft state.

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

DefaultApi.credentialCreate

Defined in

api.ts:2956

---

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

DefaultApi.credentialGet

Defined in

api.ts:2968

---

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

DefaultApi.credentialImport

Defined in

api.ts:2980

---

credentialList

▸ credentialList(walletId, options?): Promise<AxiosResponse<CredentialList, any>>

Retrieves a list of credentials.

Parameters

Name	Type	Description
walletId	string
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<CredentialList, any>>

Throws

Memberof

DefaultApi

Inherited from

DefaultApi.credentialList

Defined in

api.ts:2991

---

credentialMetadataPatch

▸ credentialMetadataPatch(credentialId, walletId, credentialMetadata?, 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
credentialMetadata?	CredentialMetadata	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

api.ts:3004

---

credentialPatch

▸ credentialPatch(credentialId, walletId, credentialPayload?, 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
credentialPayload?	CredentialPayload
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<CredentialIdObject, any>>

Throws

Memberof

DefaultApi

Inherited from

DefaultApi.credentialPatch

Defined in

api.ts:3017

---

credentialRequest

▸ credentialRequest(walletId, credentialRequest?, options?): Promise<AxiosResponse<string[], any>>

TBD

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.credentialRequest

Defined in

api.ts:3029

---

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

DefaultApi.deferredStatus

Defined in

api.ts:3041

---

getCurrentDid

▸ getCurrentDid(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

DefaultApi.getCurrentDid

Defined in

api.ts:3052

---

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

DefaultApi.healthCheck

Defined in

api.ts:3062

---

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

api.ts:3074

---

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

api.ts:3085

---

oidcAcceptOffer

▸ oidcAcceptOffer(walletId, vcOffer?, options?): Promise<AxiosResponse<string[], any>>

Issue 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<string[], any>>

Throws

Memberof

DefaultApi

Inherited from

DefaultApi.oidcAcceptOffer

Defined in

api.ts:3097

---

oidcAddCredToIssuanceQueue

▸ oidcAddCredToIssuanceQueue(credentialId, walletId, issuanceQueueCredentialAdd?, options?): Promise<AxiosResponse<void, any>>

Adds created Verifiable Credential draft to issuance queue for a specified client using authorized in-time or deferred flow.

Parameters

Name	Type	Description
credentialId	string
walletId	string
issuanceQueueCredentialAdd?	IssuanceQueueCredentialAdd
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<void, any>>

Throws

Memberof

DefaultApi

Inherited from

DefaultApi.oidcAddCredToIssuanceQueue

Defined in

api.ts:3110

---

oidcCreateIdTokenRequest

▸ oidcCreateIdTokenRequest(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.oidcCreateIdTokenRequest

Defined in

api.ts:3121

---

oidcInitiateDeferred

▸ oidcInitiateDeferred(walletId, initAuthOffer?, options?): Promise<AxiosResponse<AuthOffer, any>>

Initiates issuing of the credential using the authorized deferred flow, in which the holder will receive credential asynchronously.

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.oidcInitiateDeferred

Defined in

api.ts:3133

---

oidcInitiateIntime

▸ oidcInitiateIntime(walletId, initAuthOffer?, options?): Promise<AxiosResponse<AuthOffer, any>>

Initiates issuing of the verifiable credential 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.oidcInitiateIntime

Defined in

api.ts:3145

---

oidcInitiatePreauth

▸ oidcInitiatePreauth(walletId, initPreAuthOffer?, options?): Promise<AxiosResponse<PreAuthOffer, any>>

Initiates issuing of the verifiable credential 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.oidcInitiatePreauth

Defined in

api.ts:3157

---

oidcPresentCredentials

▸ oidcPresentCredentials(walletId, presentationRequest?, options?): Promise<AxiosResponse<void, 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<void, any>>

Throws

Memberof

DefaultApi

Inherited from

DefaultApi.oidcPresentCredentials

Defined in

api.ts:3169

---

oidcSendIdToken

▸ oidcSendIdToken(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

DefaultApi.oidcSendIdToken

Defined in

api.ts:3181

---

oidcVerifyInitUrl

▸ oidcVerifyInitUrl(walletId, verifyInitRequest?, options?): Promise<AxiosResponse<VerifyInitResponse, any>>

Returns an url where verifier accepts presentations.

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.oidcVerifyInitUrl

Defined in

api.ts:3193

---

onboardLegalEntity

▸ onboardLegalEntity(walletId, options?): Promise<AxiosResponse<string, any>>

TBD

Parameters

Name	Type	Description
walletId	string
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<string, any>>

Throws

Memberof

DefaultApi

Inherited from

DefaultApi.onboardLegalEntity

Defined in

api.ts:3204

---

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

DefaultApi.walletGet

Defined in

api.ts:3215

---

walletList

▸ walletList(options?): Promise<AxiosResponse<Wallet[], any>>

Provides list of wallets owned by the authenticated client.

Parameters

Name	Type	Description
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<Wallet[], any>>

Throws

Memberof

DefaultApi

Inherited from

DefaultApi.walletList

Defined in

api.ts:3225

---

walletNotifications

▸ walletNotifications(walletId, options?): Promise<AxiosResponse<WalletNotification[], any>>

Provides wallet notifications

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

api.ts:3236

---

walletSave

▸ walletSave(walletId?, wallet?, options?): Promise<AxiosResponse<Wallet, any>>

The first call will authenticate the client and create a new wallet that will be accessible only to the client. Any further calls are meant to update the wallet configuration. Be careful when changing the configuration as it may result in the wallet malfunction.

Parameters

Name	Type	Description
walletId?	string	Has to be provided for updates.
wallet?	Wallet
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<Wallet, any>>

Throws

Memberof

DefaultApi

Inherited from

DefaultApi.walletSave

Defined in

api.ts:3248