@triveria/wallet / Exports

@triveria/wallet

Table of contents

Classes

• Client
• Configuration
• DefaultApi

Interfaces

• AuthOffer
• ConfigurationParameters
• Credential
• CredentialIdObject
• CredentialImport
• CredentialIssuerDefinition
• CredentialList
• CredentialMetadata
• CredentialPayload
• CredentialRequest
• CredentialSchemaItem
• CredentialStatus
• CredentialSubjectItem
• CredentialType
• CredentialVerifierDefinition
• CredentialWrapper
• Deferred
• Did
• EvidenceItem
• HealthStatus
• HolderAuthOfferCreationRequest
• IdTokenReceivedNotification
• IdTokenRequest
• IdTokenSendRequest
• InitAuthOffer
• InitPreAuthOffer
• IssuanceQueueCredentialAdd
• ModelError
• PreAuthOffer
• PresentationDefinition
• PresentationDefinitionFormat
• PresentationDefinitionFormatAlg
• PresentationDefinitionInputConstraint
• PresentationDefinitionInputConstraintField
• PresentationDefinitionInputDescriptor
• PresentationRequest
• Proof
• RefreshServiceItem
• SystemImpact
• TermsOfUse
• VcOffer
• VerifyInitRequest
• VerifyInitResponse
• VpVerifiedNotification
• Wallet
• WalletConfig
• WalletNotification

Type Aliases

• ClientConfiguration
• CredentialIssuerDefinitionCredentialFormatEnum
• CredentialIssuerDefinitionCredentialIssuerEnum
• CredentialMetadataStatusEnum
• CredentialSchema
• CredentialSubject
• DeferredStatusEnum
• HealthStatusStatusEnum
• RefreshService
• SystemImpactStatusEnum
• WalletNotificationEventDetails
• WalletNotificationEventTypeEnum

Variables

• CredentialIssuerDefinitionCredentialFormatEnum
• CredentialIssuerDefinitionCredentialIssuerEnum
• CredentialMetadataStatusEnum
• DeferredStatusEnum
• HealthStatusStatusEnum
• SystemImpactStatusEnum
• WalletNotificationEventTypeEnum

Functions

• DefaultApiAxiosParamCreator
• DefaultApiFactory
• DefaultApiFp
• RequestToken

Type Aliases

ClientConfiguration

Ƭ ClientConfiguration: Object

Type declaration

Name	Type
clientId	string
clientSecret	string

Defined in

client.ts:9

---

CredentialIssuerDefinitionCredentialFormatEnum

Ƭ CredentialIssuerDefinitionCredentialFormatEnum: typeof CredentialIssuerDefinitionCredentialFormatEnum[keyof typeof CredentialIssuerDefinitionCredentialFormatEnum]

Defined in

api.ts:218

api.ts:222

---

CredentialIssuerDefinitionCredentialIssuerEnum

Ƭ CredentialIssuerDefinitionCredentialIssuerEnum: typeof CredentialIssuerDefinitionCredentialIssuerEnum[keyof typeof CredentialIssuerDefinitionCredentialIssuerEnum]

Defined in

api.ts:223

api.ts:228

---

CredentialMetadataStatusEnum

Ƭ CredentialMetadataStatusEnum: typeof CredentialMetadataStatusEnum[keyof typeof CredentialMetadataStatusEnum]

Defined in

api.ts:271

api.ts:277

---

CredentialSchema

Ƭ CredentialSchema: CredentialSchemaItem[] | CredentialSchemaItem

Export

Defined in

api.ts:336

---

CredentialSubject

Ƭ CredentialSubject: CredentialSubjectItem[] | CredentialSubjectItem

Export

Defined in

api.ts:407

---

DeferredStatusEnum

Ƭ DeferredStatusEnum: typeof DeferredStatusEnum[keyof typeof DeferredStatusEnum]

Defined in

api.ts:507

api.ts:513

---

HealthStatusStatusEnum

Ƭ HealthStatusStatusEnum: typeof HealthStatusStatusEnum[keyof typeof HealthStatusStatusEnum]

Defined in

api.ts:569

api.ts:575

---

RefreshService

Ƭ RefreshService: RefreshServiceItem[] | RefreshServiceItem

Export

Defined in

api.ts:929

---

SystemImpactStatusEnum

Ƭ SystemImpactStatusEnum: typeof SystemImpactStatusEnum[keyof typeof SystemImpactStatusEnum]

Defined in

api.ts:976

api.ts:982

---

WalletNotificationEventDetails

Ƭ WalletNotificationEventDetails: IdTokenReceivedNotification | VpVerifiedNotification

Export

Defined in

api.ts:1174

---

WalletNotificationEventTypeEnum

Ƭ WalletNotificationEventTypeEnum: typeof WalletNotificationEventTypeEnum[keyof typeof WalletNotificationEventTypeEnum]

Defined in

api.ts:1163

api.ts:1168

Variables

CredentialIssuerDefinitionCredentialFormatEnum

• Const CredentialIssuerDefinitionCredentialFormatEnum: Object

Type declaration

Name	Type
JwtVc	"jwt_vc"

Defined in

api.ts:218

api.ts:222

---

CredentialIssuerDefinitionCredentialIssuerEnum

• Const CredentialIssuerDefinitionCredentialIssuerEnum: Object

Type declaration

Name	Type
CtWalletSame	"CtWalletSame"
IssuanceQueue	"IssuanceQueue"

Defined in

api.ts:223

api.ts:228

---

CredentialMetadataStatusEnum

• Const CredentialMetadataStatusEnum: Object

Type declaration

Name	Type
Draft	"draft"
Invalid	"invalid"
Valid	"valid"

Defined in

api.ts:271

api.ts:277

---

DeferredStatusEnum

• Const DeferredStatusEnum: Object

Type declaration

Name	Type
Completed	"completed"
Error	"error"
InProgress	"in_progress"

Defined in

api.ts:507

api.ts:513

---

HealthStatusStatusEnum

• Const HealthStatusStatusEnum: Object

Type declaration

Name	Type
Critical	"critical"
Limited	"limited"
Ok	"ok"

Defined in

api.ts:569

api.ts:575

---

SystemImpactStatusEnum

• Const SystemImpactStatusEnum: Object

Type declaration

Name	Type
Critical	"critical"
Limited	"limited"
Ok	"ok"

Defined in

api.ts:976

api.ts:982

---

WalletNotificationEventTypeEnum

• Const WalletNotificationEventTypeEnum: Object

Type declaration

Name	Type
IdTokenReceived	"idToken.received"
VpVerified	"vp.verified"

Defined in

api.ts:1163

api.ts:1168

Functions

DefaultApiAxiosParamCreator

▸ DefaultApiAxiosParamCreator(configuration?): Object

DefaultApi - axios parameter creator

Parameters

Name	Type
configuration?	Configuration

Returns

Object

Name	Type	Description
accreditAsTrustedIssuer	(walletId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	TBD Throws
credentialCreate	(walletId: string, credentialPayload?: CredentialPayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	Creates a new credential, which is always created in a draft state. Throws
credentialGet	(credentialId: string, walletId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	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. Throws
credentialImport	(walletId: string, credentialImport?: CredentialImport, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	Import pre-signed credential into wallet Throws
credentialList	(walletId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	Retrieves a list of credentials. Throws
credentialMetadataPatch	(credentialId: string, walletId: string, credentialMetadata?: CredentialMetadata, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	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. Throws
credentialPatch	(credentialId: string, walletId: string, credentialPayload?: CredentialPayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	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. Throws
credentialRequest	(walletId: string, credentialRequest?: CredentialRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	TBD Throws
deferredStatus	(deferredId: string, walletId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	Throws
getCurrentDid	(walletId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	Throws
healthCheck	(options?: RawAxiosRequestConfig) => Promise<RequestArgs>	Throws
holderCreateAuthOffer	(walletId: string, holderAuthOfferCreationRequest?: HolderAuthOfferCreationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	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. Throws
issuerCredentialTypesList	(url: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	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) Throws
oidcAcceptOffer	(walletId: string, vcOffer?: VcOffer, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	Issue verifiable credential using OIDC4VCI offer acceptance Throws
oidcAddCredToIssuanceQueue	(credentialId: string, walletId: string, issuanceQueueCredentialAdd?: IssuanceQueueCredentialAdd, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	Adds created Verifiable Credential draft to issuance queue for a specified client using authorized in-time or deferred flow. Throws
oidcCreateIdTokenRequest	(walletId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	Creates an ID token request. Throws
oidcInitiateDeferred	(walletId: string, initAuthOffer?: InitAuthOffer, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	Initiates issuing of the credential using the authorized deferred flow, in which the holder will receive credential asynchronously. Throws
oidcInitiateIntime	(walletId: string, initAuthOffer?: InitAuthOffer, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	Initiates issuing of the verifiable credential using authorized flow. Throws
oidcInitiatePreauth	(walletId: string, initPreAuthOffer?: InitPreAuthOffer, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	Initiates issuing of the verifiable credential using pre-authorized flow. Throws
oidcPresentCredentials	(walletId: string, presentationRequest?: PresentationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	Initiates a presentation of credentials to a verifier. Throws
oidcSendIdToken	(walletId: string, idTokenSendRequest?: IdTokenSendRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	Responds to an ID token request Throws
oidcVerifyInitUrl	(walletId: string, verifyInitRequest?: VerifyInitRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	Returns an url where verifier accepts presentations. Throws
onboardLegalEntity	(walletId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	TBD Throws
walletGet	(walletId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	Provides wallet details Throws
walletList	(options?: RawAxiosRequestConfig) => Promise<RequestArgs>	Provides list of wallets owned by the authenticated client. Throws
walletNotifications	(walletId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	Provides wallet notifications Throws
walletSave	(walletId?: string, wallet?: Wallet, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	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. Throws

Export

Defined in

api.ts:1181

---

DefaultApiFactory

▸ DefaultApiFactory(configuration?, basePath?, axios?): Object

DefaultApi - factory interface

Parameters

Name	Type
configuration?	Configuration
basePath?	string
axios?	AxiosInstance

Returns

Object

Name	Type
accreditAsTrustedIssuer	(walletId: string, options?: any) => AxiosPromise<void>
credentialCreate	(walletId: string, credentialPayload?: CredentialPayload, options?: any) => AxiosPromise<CredentialIdObject>
credentialGet	(credentialId: string, walletId: string, options?: any) => AxiosPromise<CredentialWrapper>
credentialImport	(walletId: string, credentialImport?: CredentialImport, options?: any) => AxiosPromise<Credential>
credentialList	(walletId: string, options?: any) => AxiosPromise<CredentialList>
credentialMetadataPatch	(credentialId: string, walletId: string, credentialMetadata?: CredentialMetadata, options?: any) => AxiosPromise<CredentialIdObject>
credentialPatch	(credentialId: string, walletId: string, credentialPayload?: CredentialPayload, options?: any) => AxiosPromise<CredentialIdObject>
credentialRequest	(walletId: string, credentialRequest?: CredentialRequest, options?: any) => AxiosPromise<string[]>
deferredStatus	(deferredId: string, walletId: string, options?: any) => AxiosPromise<Deferred>
getCurrentDid	(walletId: string, options?: any) => AxiosPromise<Did>
healthCheck	(options?: any) => AxiosPromise<HealthStatus>
holderCreateAuthOffer	(walletId: string, holderAuthOfferCreationRequest?: HolderAuthOfferCreationRequest, options?: any) => AxiosPromise<void>
issuerCredentialTypesList	(url: string, options?: any) => AxiosPromise<CredentialType[]>
oidcAcceptOffer	(walletId: string, vcOffer?: VcOffer, options?: any) => AxiosPromise<string[]>
oidcAddCredToIssuanceQueue	(credentialId: string, walletId: string, issuanceQueueCredentialAdd?: IssuanceQueueCredentialAdd, options?: any) => AxiosPromise<void>
oidcCreateIdTokenRequest	(walletId: string, options?: any) => AxiosPromise<IdTokenRequest>
oidcInitiateDeferred	(walletId: string, initAuthOffer?: InitAuthOffer, options?: any) => AxiosPromise<AuthOffer>
oidcInitiateIntime	(walletId: string, initAuthOffer?: InitAuthOffer, options?: any) => AxiosPromise<AuthOffer>
oidcInitiatePreauth	(walletId: string, initPreAuthOffer?: InitPreAuthOffer, options?: any) => AxiosPromise<PreAuthOffer>
oidcPresentCredentials	(walletId: string, presentationRequest?: PresentationRequest, options?: any) => AxiosPromise<void>
oidcSendIdToken	(walletId: string, idTokenSendRequest?: IdTokenSendRequest, options?: any) => AxiosPromise<void>
oidcVerifyInitUrl	(walletId: string, verifyInitRequest?: VerifyInitRequest, options?: any) => AxiosPromise<VerifyInitResponse>
onboardLegalEntity	(walletId: string, options?: any) => AxiosPromise<string>
walletGet	(walletId: string, options?: any) => AxiosPromise<Wallet>
walletList	(options?: any) => AxiosPromise<Wallet[]>
walletNotifications	(walletId: string, options?: any) => AxiosPromise<WalletNotification[]>
walletSave	(walletId?: string, wallet?: Wallet, options?: any) => AxiosPromise<Wallet>

Export

Defined in

api.ts:2663

---

DefaultApiFp

▸ DefaultApiFp(configuration?): Object

DefaultApi - functional programming interface

Parameters

Name	Type
configuration?	Configuration

Returns

Object

Name	Type
accreditAsTrustedIssuer	(walletId: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
credentialCreate	(walletId: string, credentialPayload?: CredentialPayload, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CredentialIdObject>>
credentialGet	(credentialId: string, walletId: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CredentialWrapper>>
credentialImport	(walletId: string, credentialImport?: CredentialImport, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Credential>>
credentialList	(walletId: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CredentialList>>
credentialMetadataPatch	(credentialId: string, walletId: string, credentialMetadata?: CredentialMetadata, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CredentialIdObject>>
credentialPatch	(credentialId: string, walletId: string, credentialPayload?: CredentialPayload, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CredentialIdObject>>
credentialRequest	(walletId: string, credentialRequest?: CredentialRequest, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>>
deferredStatus	(deferredId: string, walletId: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Deferred>>
getCurrentDid	(walletId: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Did>>
healthCheck	(options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HealthStatus>>
holderCreateAuthOffer	(walletId: string, holderAuthOfferCreationRequest?: HolderAuthOfferCreationRequest, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
issuerCredentialTypesList	(url: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CredentialType[]>>
oidcAcceptOffer	(walletId: string, vcOffer?: VcOffer, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>>
oidcAddCredToIssuanceQueue	(credentialId: string, walletId: string, issuanceQueueCredentialAdd?: IssuanceQueueCredentialAdd, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
oidcCreateIdTokenRequest	(walletId: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdTokenRequest>>
oidcInitiateDeferred	(walletId: string, initAuthOffer?: InitAuthOffer, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthOffer>>
oidcInitiateIntime	(walletId: string, initAuthOffer?: InitAuthOffer, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthOffer>>
oidcInitiatePreauth	(walletId: string, initPreAuthOffer?: InitPreAuthOffer, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreAuthOffer>>
oidcPresentCredentials	(walletId: string, presentationRequest?: PresentationRequest, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
oidcSendIdToken	(walletId: string, idTokenSendRequest?: IdTokenSendRequest, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
oidcVerifyInitUrl	(walletId: string, verifyInitRequest?: VerifyInitRequest, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VerifyInitResponse>>
onboardLegalEntity	(walletId: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
walletGet	(walletId: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Wallet>>
walletList	(options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Wallet[]>>
walletNotifications	(walletId: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WalletNotification[]>>
walletSave	(walletId?: string, wallet?: Wallet, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Wallet>>

Export

Defined in

api.ts:2311

---

RequestToken

▸ RequestToken(clientId, clientSecret): Promise<string>

Parameters

Name	Type
clientId	string
clientSecret	string

Returns

Promise<string>

Defined in

auth.ts:5