@idunion/tl-sdk / Exports

@idunion/tl-sdk

Table of contents

Classes

• Client
• Configuration
• DefaultApi

Interfaces

• AccreditedFor
• ConfigurationParameters
• ContactInformation
• DidDocument
• DidDocumentList
• HealthStatus
• IssuerDisplayItem
• IssuerLogo
• ModelError
• OnboardingCredential
• OnboardingPayload
• OnboardingResponse
• OnboardingStatus
• OnboardingVcSubject
• OrgAddress
• ServiceItem
• Tl
• TlList
• TlPayload
• TlPublicInfo
• TlPublicInfoList
• Tlr
• TlrCreatePayload
• TlrCreatedResult
• TlrList
• VerificationMethod
• VerificationMethodCreatePayload
• VerificationMethodPatchPayload
• VpResponse

Type Aliases

• ClientConfiguration
• HealthStatusStatusEnum
• OnboardingStatusStatusEnum
• TlType
• TlrStatusEnum

Variables

• HealthStatusStatusEnum
• OnboardingStatusStatusEnum
• TlType
• TlrStatusEnum

Functions

• DefaultApiAxiosParamCreator
• DefaultApiFactory
• DefaultApiFp
• RequestToken

Type Aliases

ClientConfiguration

Ƭ ClientConfiguration: Object

Type declaration

Name	Type
clientId	string
clientSecret	string

Defined in

client.ts:9

---

HealthStatusStatusEnum

Ƭ HealthStatusStatusEnum: typeof HealthStatusStatusEnum[keyof typeof HealthStatusStatusEnum]

Defined in

api.ts:85

api.ts:91

---

OnboardingStatusStatusEnum

Ƭ OnboardingStatusStatusEnum: typeof OnboardingStatusStatusEnum[keyof typeof OnboardingStatusStatusEnum]

Defined in

api.ts:155

api.ts:161

---

TlType

Ƭ TlType: typeof TlType[keyof typeof TlType]

Defined in

api.ts:308

api.ts:319

---

TlrStatusEnum

Ƭ TlrStatusEnum: typeof TlrStatusEnum[keyof typeof TlrStatusEnum]

Defined in

api.ts:345

api.ts:352

Variables

HealthStatusStatusEnum

• Const HealthStatusStatusEnum: Object

Type declaration

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

Defined in

api.ts:85

api.ts:91

---

OnboardingStatusStatusEnum

• Const OnboardingStatusStatusEnum: Object

Type declaration

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

Defined in

api.ts:155

api.ts:161

---

TlType

• Const TlType: Object

Defines the role category of entities registered in the Trust List, aligned with ETSI TS 119-602 and the EU Digital Identity (EUDI) framework: - QEAA_Provider: Qualified Electronic Attestation of Attributes provider - PuBEAA_Provider: Public Body Electronic Attestation of Attributes provider - Wallet_Provider: EUDI-compliant identity wallet solution provider - PID_Provider: Person Identification Data provider (e.g. national eID issuer) - Access_Certificate_Authority: Issuer of access certificates for wallet interactions - Registration_Certificates_Provider: Issuer of registration certificates - EAA_Provider: Electronic Attestation of Attributes provider (non-qualified) - Registrar_Provider: Registrar of wallet-relying parties operating a register (ETSI TS 119-602 Annex I, "EBWOID provider" in the WP4 LoTL)

Type declaration

Name	Type
AccessCertificateAuthority	"Access_Certificate_Authority"
EaaProvider	"EAA_Provider"
PidProvider	"PID_Provider"
PuBeaaProvider	"PuBEAA_Provider"
QeaaProvider	"QEAA_Provider"
RegistrarProvider	"Registrar_Provider"
RegistrationCertificatesProvider	"Registration_Certificates_Provider"
WalletProvider	"Wallet_Provider"

Defined in

api.ts:308

api.ts:319

---

TlrStatusEnum

• Const TlrStatusEnum: Object

Type declaration

Name	Type
Expired	"expired"
Onboarded	"onboarded"
Revoked	"revoked"
Trusted	"trusted"

Defined in

api.ts:345

api.ts:352

Functions

DefaultApiAxiosParamCreator

▸ DefaultApiAxiosParamCreator(configuration?): Object

DefaultApi - axios parameter creator

Parameters

Name	Type
configuration?	Configuration

Returns

Object

Name	Type	Description
didGet	(tlId: string, tlrId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	-
didSuggest	(tlId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	-
didVerificationMethodAdd	(tlId: string, tlrId: string, verificationMethodCreatePayload?: VerificationMethodCreatePayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	-
didVerificationMethodPatch	(tlId: string, tlrId: string, verificationMethodPatchPayload?: VerificationMethodPatchPayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	-
etsiTlGet	(tlId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	-
etsiTlSign	(tlId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	-
healthCheck	(options?: RawAxiosRequestConfig) => Promise<RequestArgs>	-
onboardingInit	(tlId: string, onboardingPayload?: OnboardingPayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	-
onboardingStatus	(verifierState: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	-
tlCreate	(tlPayload?: TlPayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	-
tlDelete	(tlId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	-
tlGet	(tlId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	-
tlGetPublicInfo	(tlId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	-
tlList	(search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	-
tlListByOwner	(options?: RawAxiosRequestConfig) => Promise<RequestArgs>	-
tlPatch	(tlId: string, tlPayload?: TlPayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	-
tlrCreate	(tlId: string, tlrCreatePayload?: TlrCreatePayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	-
tlrDelete	(tlId: string, tlrId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	-
tlrGet	(tlId: string, tlrId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	-
tlrSearch	(orgName?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	-
tlrTrustChainGet	(tlId: string, tlrId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	-
tlrsGet	(tlId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	-
vpGet	(tlId: string, did: string, id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>	-

Defined in

api.ts:428

---

DefaultApiFactory

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

DefaultApi - factory interface

Parameters

Name	Type
configuration?	Configuration
basePath?	string
axios?	AxiosInstance

Returns

Object

Name	Type
didGet	(tlId: string, tlrId: string, options?: RawAxiosRequestConfig) => AxiosPromise<DidDocument>
didSuggest	(tlId: string, options?: RawAxiosRequestConfig) => AxiosPromise<string>
didVerificationMethodAdd	(tlId: string, tlrId: string, verificationMethodCreatePayload?: VerificationMethodCreatePayload, options?: RawAxiosRequestConfig) => AxiosPromise<void>
didVerificationMethodPatch	(tlId: string, tlrId: string, verificationMethodPatchPayload?: VerificationMethodPatchPayload, options?: RawAxiosRequestConfig) => AxiosPromise<void>
etsiTlGet	(tlId: string, options?: RawAxiosRequestConfig) => AxiosPromise<object>
etsiTlSign	(tlId: string, options?: RawAxiosRequestConfig) => AxiosPromise<object>
healthCheck	(options?: RawAxiosRequestConfig) => AxiosPromise<HealthStatus>
onboardingInit	(tlId: string, onboardingPayload?: OnboardingPayload, options?: RawAxiosRequestConfig) => AxiosPromise<OnboardingResponse>
onboardingStatus	(verifierState: string, options?: RawAxiosRequestConfig) => AxiosPromise<OnboardingStatus>
tlCreate	(tlPayload?: TlPayload, options?: RawAxiosRequestConfig) => AxiosPromise<Tl>
tlDelete	(tlId: string, options?: RawAxiosRequestConfig) => AxiosPromise<void>
tlGet	(tlId: string, options?: RawAxiosRequestConfig) => AxiosPromise<Tl>
tlGetPublicInfo	(tlId: string, options?: RawAxiosRequestConfig) => AxiosPromise<TlPublicInfo>
tlList	(search?: string, options?: RawAxiosRequestConfig) => AxiosPromise<TlPublicInfoList>
tlListByOwner	(options?: RawAxiosRequestConfig) => AxiosPromise<TlList>
tlPatch	(tlId: string, tlPayload?: TlPayload, options?: RawAxiosRequestConfig) => AxiosPromise<Tl>
tlrCreate	(tlId: string, tlrCreatePayload?: TlrCreatePayload, options?: RawAxiosRequestConfig) => AxiosPromise<TlrCreatedResult>
tlrDelete	(tlId: string, tlrId: string, options?: RawAxiosRequestConfig) => AxiosPromise<void>
tlrGet	(tlId: string, tlrId: string, options?: RawAxiosRequestConfig) => AxiosPromise<Tlr>
tlrSearch	(orgName?: string, options?: RawAxiosRequestConfig) => AxiosPromise<TlrList>
tlrTrustChainGet	(tlId: string, tlrId: string, options?: RawAxiosRequestConfig) => AxiosPromise<Tlr[]>
tlrsGet	(tlId: string, options?: RawAxiosRequestConfig) => AxiosPromise<TlrList>
vpGet	(tlId: string, did: string, id: string, options?: RawAxiosRequestConfig) => AxiosPromise<VpResponse>

Defined in

api.ts:1587

---

DefaultApiFp

▸ DefaultApiFp(configuration?): Object

DefaultApi - functional programming interface

Parameters

Name	Type
configuration?	Configuration

Returns

Object

Name	Type
didGet	(tlId: string, tlrId: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DidDocument>>
didSuggest	(tlId: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
didVerificationMethodAdd	(tlId: string, tlrId: string, verificationMethodCreatePayload?: VerificationMethodCreatePayload, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
didVerificationMethodPatch	(tlId: string, tlrId: string, verificationMethodPatchPayload?: VerificationMethodPatchPayload, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
etsiTlGet	(tlId: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>
etsiTlSign	(tlId: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>
healthCheck	(options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HealthStatus>>
onboardingInit	(tlId: string, onboardingPayload?: OnboardingPayload, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OnboardingResponse>>
onboardingStatus	(verifierState: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OnboardingStatus>>
tlCreate	(tlPayload?: TlPayload, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tl>>
tlDelete	(tlId: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
tlGet	(tlId: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tl>>
tlGetPublicInfo	(tlId: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TlPublicInfo>>
tlList	(search?: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TlPublicInfoList>>
tlListByOwner	(options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TlList>>
tlPatch	(tlId: string, tlPayload?: TlPayload, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tl>>
tlrCreate	(tlId: string, tlrCreatePayload?: TlrCreatePayload, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TlrCreatedResult>>
tlrDelete	(tlId: string, tlrId: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
tlrGet	(tlId: string, tlrId: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tlr>>
tlrSearch	(orgName?: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TlrList>>
tlrTrustChainGet	(tlId: string, tlrId: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tlr[]>>
tlrsGet	(tlId: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TlrList>>
vpGet	(tlId: string, did: string, id: string, options?: RawAxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VpResponse>>

Defined in

api.ts:1291

---

RequestToken

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

Parameters

Name	Type
tokenUrl	string
audience	string
clientId	string
clientSecret	string

Returns

Promise<string>

Defined in

auth.ts:3