@idunion/tl-sdk / Exports / DefaultApi

Class: DefaultApi

DefaultApi - object-oriented interface

Hierarchy

• BaseAPI

  ↳ DefaultApi

  ↳↳ Client

Table of contents

Constructors

• constructor

Properties

• axios
• basePath
• configuration

Methods

• didGet
• didSuggest
• didVerificationMethodAdd
• didVerificationMethodPatch
• etsiTlGet
• healthCheck
• onboardingInit
• onboardingStatus
• tlCreate
• tlDelete
• tlGet
• tlGetPublicInfo
• tlList
• tlListByOwner
• tlPatch
• tlrCreate
• tlrDelete
• tlrGet
• tlrSearch
• tlrTrustChainGet
• tlrsGet
• vpGet

Constructors

constructor

• new DefaultApi(configuration?, basePath?, axios?): DefaultApi

Parameters

Name	Type	Default value
configuration?	Configuration	undefined
basePath	string	BASE_PATH
axios	AxiosInstance	globalAxios

Returns

DefaultApi

Inherited from

BaseAPI.constructor

Defined in

base.ts:39

Properties

axios

• Protected axios: AxiosInstance = globalAxios

Inherited from

BaseAPI.axios

Defined in

base.ts:39

---

basePath

• Protected basePath: string = BASE_PATH

Inherited from

BaseAPI.basePath

Defined in

base.ts:39

---

configuration

• Protected configuration: undefined | Configuration

Inherited from

BaseAPI.configuration

Defined in

base.ts:37

Methods

didGet

▸ didGet(tlId, tlrId, options?): Promise<AxiosResponse<DidDocument, any>>

Retrieves a specific DID Document

Parameters

Name	Type	Description
tlId	string	Trust List Identifier
tlrId	string	Trust List Record Identifier
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<DidDocument, any>>

Throws

Defined in

api.ts:1678

---

didSuggest

▸ didSuggest(tlId, options?): Promise<AxiosResponse<string, any>>

Suggests a DID

Parameters

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

Returns

Promise<AxiosResponse<string, any>>

Throws

Defined in

api.ts:1688

---

didVerificationMethodAdd

▸ didVerificationMethodAdd(tlId, tlrId, verificationMethodCreatePayload?, options?): Promise<AxiosResponse<void, any>>

Adds DID Verification method.

Parameters

Name	Type	Description
tlId	string	Trust List Identifier
tlrId	string	Trust List Record Identifier
verificationMethodCreatePayload?	VerificationMethodCreatePayload	Verification method.
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<void, any>>

Throws

Defined in

api.ts:1700

---

didVerificationMethodPatch

▸ didVerificationMethodPatch(tlId, tlrId, verificationMethodPatchPayload?, options?): Promise<AxiosResponse<void, any>>

Adds DID Verification method.

Parameters

Name	Type	Description
tlId	string	Trust List Identifier
tlrId	string	Trust List Record Identifier
verificationMethodPatchPayload?	VerificationMethodPatchPayload	Verification method.
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<void, any>>

Throws

Defined in

api.ts:1712

---

etsiTlGet

▸ etsiTlGet(tlId, options?): Promise<AxiosResponse<object, any>>

Returns an ETSI Trusted list

Parameters

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

Returns

Promise<AxiosResponse<object, any>>

Throws

Defined in

api.ts:1722

---

healthCheck

▸ healthCheck(options?): Promise<AxiosResponse<HealthStatus, any>>

Parameters

Name	Type	Description
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<HealthStatus, any>>

Throws

Defined in

api.ts:1731

---

onboardingInit

▸ onboardingInit(tlId, onboardingPayload?, options?): Promise<AxiosResponse<OnboardingResponse, any>>

Initiates the onboarding process to the DID registry.

Parameters

Name	Type	Description
tlId	string	Trust List identifier
onboardingPayload?	OnboardingPayload	DID onboarding init payload.
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<OnboardingResponse, any>>

Throws

Defined in

api.ts:1742

---

onboardingStatus

▸ onboardingStatus(verifierState, options?): Promise<AxiosResponse<OnboardingStatus, any>>

Parameters

Name	Type	Description
verifierState	string	Verifier state
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<OnboardingStatus, any>>

Throws

Defined in

api.ts:1752

---

tlCreate

▸ tlCreate(tlPayload?, options?): Promise<AxiosResponse<Tl, any>>

Creates a Trust List based on the specified payload.

Parameters

Name	Type	Description
tlPayload?	TlPayload	Trust List create payload.
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<Tl, any>>

Throws

Defined in

api.ts:1762

---

tlDelete

▸ tlDelete(tlId, options?): Promise<AxiosResponse<void, any>>

Destroys the Trust List.

Parameters

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

Returns

Promise<AxiosResponse<void, any>>

Throws

Defined in

api.ts:1772

---

tlGet

▸ tlGet(tlId, options?): Promise<AxiosResponse<Tl, any>>

Gets the specified Trust List

Parameters

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

Returns

Promise<AxiosResponse<Tl, any>>

Throws

Defined in

api.ts:1782

---

tlGetPublicInfo

▸ tlGetPublicInfo(tlId, options?): Promise<AxiosResponse<TlPublicInfo, any>>

Provides a public information about a specific Trusted List

Parameters

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

Returns

Promise<AxiosResponse<TlPublicInfo, any>>

Throws

Defined in

api.ts:1792

---

tlList

▸ tlList(search?, options?): Promise<AxiosResponse<TlPublicInfoList, any>>

Provides a list of public Trusted Lists

Parameters

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

Returns

Promise<AxiosResponse<TlPublicInfoList, any>>

Throws

Defined in

api.ts:1802

---

tlListByOwner

▸ tlListByOwner(options?): Promise<AxiosResponse<TlList, any>>

Provides a list of Trusted Lists for an authenticated owner

Parameters

Name	Type	Description
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<TlList, any>>

Throws

Defined in

api.ts:1811

---

tlPatch

▸ tlPatch(tlId, tlPayload?, options?): Promise<AxiosResponse<Tl, any>>

Updates a Trust List based on the specified payload.

Parameters

Name	Type	Description
tlId	string
tlPayload?	TlPayload	Trust List create payload.
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<Tl, any>>

Throws

Defined in

api.ts:1822

---

tlrCreate

▸ tlrCreate(tlId, tlrCreatePayload?, options?): Promise<AxiosResponse<TlrCreatedResult, any>>

Directly creates a new Trusted List Record. When a Certificate Signing Request is provided, it will also issue an x509 certificate and update the ETSI TS 119 6**

Parameters

Name	Type	Description
tlId	string
tlrCreatePayload?	TlrCreatePayload	Trust List Record Create Payload.
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<TlrCreatedResult, any>>

Throws

Defined in

api.ts:1833

---

tlrDelete

▸ tlrDelete(tlId, tlrId, options?): Promise<AxiosResponse<void, any>>

Removes a specific Trust List Record

Parameters

Name	Type	Description
tlId	string	Trust List Identifier
tlrId	string	Trust List Record Identifier
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<void, any>>

Throws

Defined in

api.ts:1844

---

tlrGet

▸ tlrGet(tlId, tlrId, options?): Promise<AxiosResponse<Tlr, any>>

Retrieves a specific Trust List record

Parameters

Name	Type	Description
tlId	string	Trust List Identifier
tlrId	string	Trust List Record Identifier
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<Tlr, any>>

Throws

Defined in

api.ts:1855

---

tlrSearch

▸ tlrSearch(orgName, options?): Promise<AxiosResponse<TlrList, any>>

Retrieves a list of Trust List Records.

Parameters

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

Returns

Promise<AxiosResponse<TlrList, any>>

Throws

Defined in

api.ts:1865

---

tlrTrustChainGet

▸ tlrTrustChainGet(tlId, tlrId, options?): Promise<AxiosResponse<Tlr[], any>>

Gets Trust List Records that make up a single Trust Chain

Parameters

Name	Type	Description
tlId	string	Trust List Identifier
tlrId	string	Trust List Record Identifier
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<Tlr[], any>>

Throws

Defined in

api.ts:1876

---

tlrsGet

▸ tlrsGet(tlId, options?): Promise<AxiosResponse<TlrList, any>>

Retrieves a list of Trust List records.

Parameters

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

Returns

Promise<AxiosResponse<TlrList, any>>

Throws

Defined in

api.ts:1886

---

vpGet

▸ vpGet(tlId, did, id, options?): Promise<AxiosResponse<VpResponse, any>>

Gets a Verifiable Presentation.

Parameters

Name	Type	Description
tlId	string
did	string
id	string
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<VpResponse, any>>

Throws

Defined in

api.ts:1898