@idunion/tl-sdk 0.0.28 → 0.0.30

package/api.d.ts

@@ -15,127 +15,60 @@ import type { RequestArgs } from './base';
 import { BaseAPI } from './base';
 /**
  * Defines accreditations which were given to specific holder
- * @export
- * @interface AccreditedFor
  */
 export interface AccreditedFor {
     /**
      * Jurisdiction limitation based on geographical region defined by https://publications.europa.eu/resource/authority/atu
-     * @type {string}
-     * @memberof AccreditedFor
      */
     'limitJurisdiction'?: string;
     /**
      * Link to a schema for which the accreditation is given
-     * @type {string}
-     * @memberof AccreditedFor
      */
     'schemaId'?: string;
     /**
      * Comma separated VC type for which the accreditation is given
-     * @type {string}
-     * @memberof AccreditedFor
      */
     'types'?: string;
 }
-/**
- *
- * @export
- * @interface DidDocument
- */
 export interface DidDocument {
     /**
      * The JSON-LD Context is either a string or a list containing any combination of strings and/or ordered maps. https://www.w3.org/TR/did-1.0/#dfn-context
-     * @type {Array<string>}
-     * @memberof DidDocument
      */
     '@context': Array<string>;
     /**
      * An entity that has the capability to make changes to a DID document. A DID might have more than one DID controller. The DID controller(s) can be denoted by the optional controller property at the top level of the DID document. Note that a DID controller might be the DID subject.  https://www.w3.org/TR/did-1.0/#dfn-did-controllers
-     * @type {Array<string>}
-     * @memberof DidDocument
      */
     'controller'?: Array<string>;
-    /**
-     *
-     * @type {string}
-     * @memberof DidDocument
-     */
     'id': string;
     /**
      * The verificationMethod property is OPTIONAL. If present, the value MUST be a set of verification methods, where each verification method is expressed using a map. The verification method map MUST include the id, type, controller, and specific verification material properties that are determined by the value of type and are defined in 5.2.1 Verification Material. A verification method MAY include additional properties. Verification methods SHOULD be registered in the DID Specification Registries [DID-SPEC-REGISTRIES]. https://www.w3.org/TR/did-1.0/#verification-methods
-     * @type {Array<VerificationMethod>}
-     * @memberof DidDocument
      */
     'verificationMethod'?: Array<VerificationMethod>;
     /**
      * The capabilityInvocation verification relationship is used to specify a verification method that might be used by the DID subject to invoke a cryptographic capability, such as the authorization to update the DID Document.   https://www.w3.org/TR/did-1.0/#capability-invocation
-     * @type {Array<string>}
-     * @memberof DidDocument
      */
     'capabilityInvocation'?: Array<string>;
     /**
      * The authentication verification relationship is used to specify how the DID subject is expected to be authenticated, for purposes such as logging into a website or engaging in any sort of challenge-response protocol.   https://www.w3.org/TR/did-1.0/#authentication
-     * @type {Array<string>}
-     * @memberof DidDocument
      */
     'authentication'?: Array<string>;
     /**
      * The assertionMethod verification relationship is used to specify how the DID subject is expected to express claims, such as for the purposes of issuing a Verifiable Credential [VC-DATA-MODEL].    https://www.w3.org/TR/did-1.0/#assertion
-     * @type {Array<string>}
-     * @memberof DidDocument
      */
     'assertionMethod'?: Array<string>;
-    /**
-     *
-     * @type {Array<ServiceItem>}
-     * @memberof DidDocument
-     */
     'service'?: Array<ServiceItem>;
 }
-/**
- *
- * @export
- * @interface DidDocumentCreatePayload
- */
 export interface DidDocumentCreatePayload {
-    /**
-     *
-     * @type {string}
-     * @memberof DidDocumentCreatePayload
-     */
     'didKey': string;
-    /**
-     *
-     * @type {string}
-     * @memberof DidDocumentCreatePayload
-     */
     'orgName': string;
 }
-/**
- *
- * @export
- * @interface DidDocumentList
- */
 export interface DidDocumentList {
-    /**
-     *
-     * @type {Array<string>}
-     * @memberof DidDocumentList
-     */
     'items'?: Array<string>;
 }
 /**
  * Health status of the system
- * @export
- * @interface HealthStatus
  */
 export interface HealthStatus {
-    /**
-     *
-     * @type {string}
-     * @memberof HealthStatus
-     */
     'status': HealthStatusStatusEnum;
 }
 export declare const HealthStatusStatusEnum: {
@@ -144,110 +77,59 @@ export declare const HealthStatusStatusEnum: {
     readonly Critical: "critical";
 };
 export type HealthStatusStatusEnum = typeof HealthStatusStatusEnum[keyof typeof HealthStatusStatusEnum];
+export interface IssuerDisplayItem {
+    'name'?: string;
+    'locale'?: string;
+    'logo'?: IssuerLogo;
+}
+export interface IssuerLogo {
+    'uri'?: string;
+    'alt_text'?: string;
+}
 /**
  * Common error message
- * @export
- * @interface ModelError
  */
 export interface ModelError {
-    /**
-     *
-     * @type {string}
-     * @memberof ModelError
-     */
     'error': string;
-    /**
-     *
-     * @type {string}
-     * @memberof ModelError
-     */
     'message': string;
 }
-/**
- *
- * @export
- * @interface OnboardingCredential
- */
 export interface OnboardingCredential {
-    /**
-     *
-     * @type {string}
-     * @memberof OnboardingCredential
-     */
     'link': string;
-    /**
-     * DID or x509
-     * @type {string}
-     * @memberof OnboardingCredential
-     */
-    'issuer': string;
+    'issuerDid': string;
+    'issuerDisplay'?: Array<IssuerDisplayItem>;
 }
-/**
- *
- * @export
- * @interface OnboardingPayload
- */
 export interface OnboardingPayload {
     /**
      * The Verifier ID that should be used to verify the onboarding credential.
-     * @type {string}
-     * @memberof OnboardingPayload
      */
     'verifierId': string;
 }
-/**
- *
- * @export
- * @interface OnboardingResponse
- */
 export interface OnboardingResponse {
     /**
      * Url of verifier authorization server that contains the requested verifier scope.
-     * @type {string}
-     * @memberof OnboardingResponse
      */
     'verifierUrl': string;
     /**
      * A code that can be used to match the verified credential for later use.
-     * @type {string}
-     * @memberof OnboardingResponse
      */
     'verifierState': string;
 }
-/**
- *
- * @export
- * @interface OnboardingStatus
- */
 export interface OnboardingStatus {
     /**
      * When the status is completed the DID will be provided.
-     * @type {string}
-     * @memberof OnboardingStatus
      */
     'did'?: string;
     /**
      * The status message providing additional info on specific status.
-     * @type {string}
-     * @memberof OnboardingStatus
      */
     'message'?: string;
     /**
      * The onboarding process status
-     * @type {string}
-     * @memberof OnboardingStatus
      */
     'status': OnboardingStatusStatusEnum;
-    /**
-     *
-     * @type {Tl}
-     * @memberof OnboardingStatus
-     */
     'tl'?: Tl;
     /**
      * After the onboarding is initiate this value will be provided
-     * @type {string}
-     * @memberof OnboardingStatus
      */
     'verifierUrl'?: string;
 }
@@ -259,175 +141,68 @@ export declare const OnboardingStatusStatusEnum: {
 export type OnboardingStatusStatusEnum = typeof OnboardingStatusStatusEnum[keyof typeof OnboardingStatusStatusEnum];
 /**
  * Services are used in DID documents to express ways of communicating with the DID subject or associated entities. A service can be any type of service the DID subject wants to advertise, including decentralized identity management services for further discovery, authentication, authorization, or interaction.  https://www.w3.org/TR/did-1.0/#services
- * @export
- * @interface ServiceItem
  */
 export interface ServiceItem {
-    /**
-     *
-     * @type {string}
-     * @memberof ServiceItem
-     */
     'id': string;
-    /**
-     *
-     * @type {string}
-     * @memberof ServiceItem
-     */
     'type': string;
     /**
      * The value of the serviceEndpoint property MUST be a string, a map, or a set composed of one or more strings and/or maps. All string values MUST be valid URIs conforming to [RFC3986] and normalized according to the Normalization and Comparison rules in RFC3986 and to any normalization rules in its applicable URI scheme specification.  https://www.w3.org/TR/did-1.0/#dfn-serviceendpoint
-     * @type {string}
-     * @memberof ServiceItem
      */
     'serviceEndpoint': string;
 }
 /**
  * Trust List meta info
- * @export
- * @interface Tl
  */
 export interface Tl {
-    /**
-     *
-     * @type {string}
-     * @memberof Tl
-     */
     'id': string;
     /**
      * Trust List human-readable name
-     * @type {string}
-     * @memberof Tl
      */
     'name': string;
     /**
      * Trust List description
-     * @type {string}
-     * @memberof Tl
      */
     'description': string;
-    /**
-     *
-     * @type {string}
-     * @memberof Tl
-     */
     'didBase': string;
-    /**
-     *
-     * @type {string}
-     * @memberof Tl
-     */
     'governanceWalletId': string;
-    /**
-     *
-     * @type {string}
-     * @memberof Tl
-     */
     'verifierId': string;
 }
-/**
- *
- * @export
- * @interface TlList
- */
 export interface TlList {
-    /**
-     *
-     * @type {Array<Tl>}
-     * @memberof TlList
-     */
     'items'?: Array<Tl>;
 }
 /**
  * Trust List create payload
- * @export
- * @interface TlPayload
  */
 export interface TlPayload {
     /**
      * Trust List human-readable name
-     * @type {string}
-     * @memberof TlPayload
      */
     'name': string;
     /**
      * Trust List description
-     * @type {string}
-     * @memberof TlPayload
      */
     'description': string;
-    /**
-     *
-     * @type {string}
-     * @memberof TlPayload
-     */
     'suggestedId'?: string;
     /**
      * The Wallet used by the Trust List for VC interactions
-     * @type {string}
-     * @memberof TlPayload
      */
     'governanceWalletId': string;
     /**
      * The Verifier used to verify onboarding credentials
-     * @type {string}
-     * @memberof TlPayload
      */
     'verifierId': string;
 }
-/**
- *
- * @export
- * @interface Tlr
- */
 export interface Tlr {
-    /**
-     *
-     * @type {string}
-     * @memberof Tlr
-     */
     'orgName': string;
-    /**
-     *
-     * @type {string}
-     * @memberof Tlr
-     */
     'id': string;
-    /**
-     *
-     * @type {string}
-     * @memberof Tlr
-     */
     'did': string;
-    /**
-     *
-     * @type {string}
-     * @memberof Tlr
-     */
     'tlId': string;
-    /**
-     *
-     * @type {string}
-     * @memberof Tlr
-     */
     'tlName': string;
     /**
      * Denotes the Trust List record trust status.    - Unverified record is created manually without presenting an onboarding VC   - Verified record is created upon onboarding VC presentation   - Trusted record is created upon onboarding VC presentation that was issued by an Issuer that is verified by IDunion SCE
-     * @type {string}
-     * @memberof Tlr
      */
     'status': TlrStatusEnum;
-    /**
-     *
-     * @type {Array<AccreditedFor>}
-     * @memberof Tlr
-     */
     'accreditedFor'?: Array<AccreditedFor>;
-    /**
-     *
-     * @type {Array<OnboardingCredential>}
-     * @memberof Tlr
-     */
     'onboardingCredentials'?: Array<OnboardingCredential>;
 }
 export declare const TlrStatusEnum: {
@@ -436,61 +211,26 @@ export declare const TlrStatusEnum: {
     readonly Trusted: "trusted";
 };
 export type TlrStatusEnum = typeof TlrStatusEnum[keyof typeof TlrStatusEnum];
-/**
- *
- * @export
- * @interface TlrList
- */
 export interface TlrList {
-    /**
-     *
-     * @type {Array<Tlr>}
-     * @memberof TlrList
-     */
     'items'?: Array<Tlr>;
 }
-/**
- *
- * @export
- * @interface VerificationMethod
- */
 export interface VerificationMethod {
     [key: string]: any;
-    /**
-     *
-     * @type {string}
-     * @memberof VerificationMethod
-     */
     'controller': string;
-    /**
-     *
-     * @type {string}
-     * @memberof VerificationMethod
-     */
     'id': string;
     /**
      * The value of the type property MUST be a string that references exactly one verification method type. In order to maximize global interoperability, the verification method type SHOULD be registered in the DID Specification Registries [DID-SPEC-REGISTRIES].
-     * @type {string}
-     * @memberof VerificationMethod
      */
     'type': string;
 }
-/**
- *
- * @export
- * @interface VpResponse
- */
 export interface VpResponse {
     /**
      * Verifiable Presentation in JWT format
-     * @type {string}
-     * @memberof VpResponse
      */
     'vp': string;
 }
 /**
  * DefaultApi - axios parameter creator
- * @export
  */
 export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -591,7 +331,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      */
     tlrSearch: (orgName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Retrieves a specific Trust List record
+     * Gets Trust List Records that make up a single Trust Chain
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
@@ -617,7 +357,6 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
 };
 /**
  * DefaultApi - functional programming interface
- * @export
  */
 export declare const DefaultApiFp: (configuration?: Configuration) => {
     /**
@@ -718,13 +457,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      */
     tlrSearch(orgName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TlrList>>;
     /**
-     * Retrieves a specific Trust List record
+     * Gets Trust List Records that make up a single Trust Chain
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    tlrTrustChainGet(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tlr>>;
+    tlrTrustChainGet(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Tlr>>>;
     /**
      * Retrieves a list of Trust List records.
      * @param {string} tlId
@@ -744,7 +483,6 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
 };
 /**
  * DefaultApi - factory interface
- * @export
  */
 export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -845,13 +583,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      */
     tlrSearch(orgName: string, options?: RawAxiosRequestConfig): AxiosPromise<TlrList>;
     /**
-     * Retrieves a specific Trust List record
+     * Gets Trust List Records that make up a single Trust Chain
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    tlrTrustChainGet(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): AxiosPromise<Tlr>;
+    tlrTrustChainGet(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Tlr>>;
     /**
      * Retrieves a list of Trust List records.
      * @param {string} tlId
@@ -871,9 +609,6 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
 };
 /**
  * DefaultApi - object-oriented interface
- * @export
- * @class DefaultApi
- * @extends {BaseAPI}
  */
 export declare class DefaultApi extends BaseAPI {
     /**
@@ -882,7 +617,6 @@ export declare class DefaultApi extends BaseAPI {
      * @param {DidDocumentCreatePayload} [didDocumentCreatePayload] DID Document Create Payload.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     didDocumentCreate(tlId: string, didDocumentCreatePayload?: DidDocumentCreatePayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
     /**
@@ -891,7 +625,6 @@ export declare class DefaultApi extends BaseAPI {
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     didGet(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DidDocument, any>>;
     /**
@@ -899,7 +632,6 @@ export declare class DefaultApi extends BaseAPI {
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     didSuggest(tlId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
     /**
@@ -909,14 +641,12 @@ export declare class DefaultApi extends BaseAPI {
      * @param {VerificationMethod} [verificationMethod] Verification method.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     didVerificationMethodAdd(tlId: string, did: string, verificationMethod?: VerificationMethod, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      *
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     healthCheck(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HealthStatus, any>>;
     /**
@@ -925,7 +655,6 @@ export declare class DefaultApi extends BaseAPI {
      * @param {OnboardingPayload} [onboardingPayload] DID onboarding init payload.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     onboardingInit(tlId: string, onboardingPayload?: OnboardingPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OnboardingResponse, any>>;
     /**
@@ -933,7 +662,6 @@ export declare class DefaultApi extends BaseAPI {
      * @param {string} verifierState Verifier state
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     onboardingStatus(verifierState: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OnboardingStatus, any>>;
     /**
@@ -941,7 +669,6 @@ export declare class DefaultApi extends BaseAPI {
      * @param {TlPayload} [tlPayload] Trust List create payload.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     tlCreate(tlPayload?: TlPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Tl, any>>;
     /**
@@ -949,7 +676,6 @@ export declare class DefaultApi extends BaseAPI {
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     tlGet(tlId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Tl, any>>;
     /**
@@ -957,7 +683,6 @@ export declare class DefaultApi extends BaseAPI {
      * @param {string} [ownerId]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     tlList(ownerId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TlList, any>>;
     /**
@@ -966,7 +691,6 @@ export declare class DefaultApi extends BaseAPI {
      * @param {TlPayload} [tlPayload] Trust List create payload.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     tlPatch(tlId: string, tlPayload?: TlPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Tl, any>>;
     /**
@@ -975,7 +699,6 @@ export declare class DefaultApi extends BaseAPI {
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     tlrGet(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Tlr, any>>;
     /**
@@ -983,24 +706,21 @@ export declare class DefaultApi extends BaseAPI {
      * @param {string} orgName
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     tlrSearch(orgName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TlrList, any>>;
     /**
-     * Retrieves a specific Trust List record
+     * Gets Trust List Records that make up a single Trust Chain
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
-    tlrTrustChainGet(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Tlr, any>>;
+    tlrTrustChainGet(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Tlr[], any>>;
     /**
      * Retrieves a list of Trust List records.
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     tlrsGet(tlId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TlrList, any>>;
     /**
@@ -1010,7 +730,6 @@ export declare class DefaultApi extends BaseAPI {
      * @param {string} id
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     vpGet(tlId: string, did: string, id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VpResponse, any>>;
 }

package/api.js

@@ -49,7 +49,6 @@ exports.TlrStatusEnum = {
 };
 /**
  * DefaultApi - axios parameter creator
- * @export
  */
 const DefaultApiAxiosParamCreator = function (configuration) {
     return {
@@ -458,7 +457,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Retrieves a specific Trust List record
+         * Gets Trust List Records that make up a single Trust Chain
          * @param {string} tlId Trust List Identifier
          * @param {string} tlrId Trust List Record Identifier
          * @param {*} [options] Override http request option.
@@ -564,7 +563,6 @@ const DefaultApiAxiosParamCreator = function (configuration) {
 exports.DefaultApiAxiosParamCreator = DefaultApiAxiosParamCreator;
 /**
  * DefaultApi - functional programming interface
- * @export
  */
 const DefaultApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.DefaultApiAxiosParamCreator)(configuration);
@@ -771,7 +769,7 @@ const DefaultApiFp = function (configuration) {
             });
         },
         /**
-         * Retrieves a specific Trust List record
+         * Gets Trust List Records that make up a single Trust Chain
          * @param {string} tlId Trust List Identifier
          * @param {string} tlrId Trust List Record Identifier
          * @param {*} [options] Override http request option.
@@ -823,7 +821,6 @@ const DefaultApiFp = function (configuration) {
 exports.DefaultApiFp = DefaultApiFp;
 /**
  * DefaultApi - factory interface
- * @export
  */
 const DefaultApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.DefaultApiFp)(configuration);
@@ -952,7 +949,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
             return localVarFp.tlrSearch(orgName, options).then((request) => request(axios, basePath));
         },
         /**
-         * Retrieves a specific Trust List record
+         * Gets Trust List Records that make up a single Trust Chain
          * @param {string} tlId Trust List Identifier
          * @param {string} tlrId Trust List Record Identifier
          * @param {*} [options] Override http request option.
@@ -986,9 +983,6 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
 exports.DefaultApiFactory = DefaultApiFactory;
 /**
  * DefaultApi - object-oriented interface
- * @export
- * @class DefaultApi
- * @extends {BaseAPI}
  */
 class DefaultApi extends base_1.BaseAPI {
     /**
@@ -997,7 +991,6 @@ class DefaultApi extends base_1.BaseAPI {
      * @param {DidDocumentCreatePayload} [didDocumentCreatePayload] DID Document Create Payload.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     didDocumentCreate(tlId, didDocumentCreatePayload, options) {
         return (0, exports.DefaultApiFp)(this.configuration).didDocumentCreate(tlId, didDocumentCreatePayload, options).then((request) => request(this.axios, this.basePath));
@@ -1008,7 +1001,6 @@ class DefaultApi extends base_1.BaseAPI {
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     didGet(tlId, tlrId, options) {
         return (0, exports.DefaultApiFp)(this.configuration).didGet(tlId, tlrId, options).then((request) => request(this.axios, this.basePath));
@@ -1018,7 +1010,6 @@ class DefaultApi extends base_1.BaseAPI {
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     didSuggest(tlId, options) {
         return (0, exports.DefaultApiFp)(this.configuration).didSuggest(tlId, options).then((request) => request(this.axios, this.basePath));
@@ -1030,7 +1021,6 @@ class DefaultApi extends base_1.BaseAPI {
      * @param {VerificationMethod} [verificationMethod] Verification method.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     didVerificationMethodAdd(tlId, did, verificationMethod, options) {
         return (0, exports.DefaultApiFp)(this.configuration).didVerificationMethodAdd(tlId, did, verificationMethod, options).then((request) => request(this.axios, this.basePath));
@@ -1039,7 +1029,6 @@ class DefaultApi extends base_1.BaseAPI {
      *
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     healthCheck(options) {
         return (0, exports.DefaultApiFp)(this.configuration).healthCheck(options).then((request) => request(this.axios, this.basePath));
@@ -1050,7 +1039,6 @@ class DefaultApi extends base_1.BaseAPI {
      * @param {OnboardingPayload} [onboardingPayload] DID onboarding init payload.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     onboardingInit(tlId, onboardingPayload, options) {
         return (0, exports.DefaultApiFp)(this.configuration).onboardingInit(tlId, onboardingPayload, options).then((request) => request(this.axios, this.basePath));
@@ -1060,7 +1048,6 @@ class DefaultApi extends base_1.BaseAPI {
      * @param {string} verifierState Verifier state
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     onboardingStatus(verifierState, options) {
         return (0, exports.DefaultApiFp)(this.configuration).onboardingStatus(verifierState, options).then((request) => request(this.axios, this.basePath));
@@ -1070,7 +1057,6 @@ class DefaultApi extends base_1.BaseAPI {
      * @param {TlPayload} [tlPayload] Trust List create payload.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     tlCreate(tlPayload, options) {
         return (0, exports.DefaultApiFp)(this.configuration).tlCreate(tlPayload, options).then((request) => request(this.axios, this.basePath));
@@ -1080,7 +1066,6 @@ class DefaultApi extends base_1.BaseAPI {
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     tlGet(tlId, options) {
         return (0, exports.DefaultApiFp)(this.configuration).tlGet(tlId, options).then((request) => request(this.axios, this.basePath));
@@ -1090,7 +1075,6 @@ class DefaultApi extends base_1.BaseAPI {
      * @param {string} [ownerId]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     tlList(ownerId, options) {
         return (0, exports.DefaultApiFp)(this.configuration).tlList(ownerId, options).then((request) => request(this.axios, this.basePath));
@@ -1101,7 +1085,6 @@ class DefaultApi extends base_1.BaseAPI {
      * @param {TlPayload} [tlPayload] Trust List create payload.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     tlPatch(tlId, tlPayload, options) {
         return (0, exports.DefaultApiFp)(this.configuration).tlPatch(tlId, tlPayload, options).then((request) => request(this.axios, this.basePath));
@@ -1112,7 +1095,6 @@ class DefaultApi extends base_1.BaseAPI {
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     tlrGet(tlId, tlrId, options) {
         return (0, exports.DefaultApiFp)(this.configuration).tlrGet(tlId, tlrId, options).then((request) => request(this.axios, this.basePath));
@@ -1122,18 +1104,16 @@ class DefaultApi extends base_1.BaseAPI {
      * @param {string} orgName
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     tlrSearch(orgName, options) {
         return (0, exports.DefaultApiFp)(this.configuration).tlrSearch(orgName, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Retrieves a specific Trust List record
+     * Gets Trust List Records that make up a single Trust Chain
      * @param {string} tlId Trust List Identifier
      * @param {string} tlrId Trust List Record Identifier
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     tlrTrustChainGet(tlId, tlrId, options) {
         return (0, exports.DefaultApiFp)(this.configuration).tlrTrustChainGet(tlId, tlrId, options).then((request) => request(this.axios, this.basePath));
@@ -1143,7 +1123,6 @@ class DefaultApi extends base_1.BaseAPI {
      * @param {string} tlId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     tlrsGet(tlId, options) {
         return (0, exports.DefaultApiFp)(this.configuration).tlrsGet(tlId, options).then((request) => request(this.axios, this.basePath));
@@ -1155,7 +1134,6 @@ class DefaultApi extends base_1.BaseAPI {
      * @param {string} id
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     vpGet(tlId, did, id, options) {
         return (0, exports.DefaultApiFp)(this.configuration).vpGet(tlId, did, id, options).then((request) => request(this.axios, this.basePath));

package/base.d.ts

@@ -12,42 +12,22 @@
 import type { Configuration } from './configuration';
 import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
 export declare const BASE_PATH: string;
-/**
- *
- * @export
- */
 export declare const COLLECTION_FORMATS: {
     csv: string;
     ssv: string;
     tsv: string;
     pipes: string;
 };
-/**
- *
- * @export
- * @interface RequestArgs
- */
 export interface RequestArgs {
     url: string;
     options: RawAxiosRequestConfig;
 }
-/**
- *
- * @export
- * @class BaseAPI
- */
 export declare class BaseAPI {
     protected basePath: string;
     protected axios: AxiosInstance;
     protected configuration: Configuration | undefined;
     constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
 }
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
 export declare class RequiredError extends Error {
     field: string;
     constructor(field: string, msg?: string);
@@ -58,9 +38,5 @@ interface ServerMap {
         description: string;
     }[];
 }
-/**
- *
- * @export
- */
 export declare const operationServerMap: ServerMap;
 export {};

package/base.js

@@ -19,21 +19,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
 const axios_1 = __importDefault(require("axios"));
 exports.BASE_PATH = "/api/v1".replace(/\/+$/, "");
-/**
- *
- * @export
- */
 exports.COLLECTION_FORMATS = {
     csv: ",",
     ssv: " ",
     tsv: "\t",
     pipes: "|",
 };
-/**
- *
- * @export
- * @class BaseAPI
- */
 class BaseAPI {
     constructor(configuration, basePath = exports.BASE_PATH, axios = axios_1.default) {
         var _a;
@@ -47,12 +38,6 @@ class BaseAPI {
 }
 exports.BaseAPI = BaseAPI;
 ;
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
 class RequiredError extends Error {
     constructor(field, msg) {
         super(msg);
@@ -61,8 +46,4 @@ class RequiredError extends Error {
     }
 }
 exports.RequiredError = RequiredError;
-/**
- *
- * @export
- */
 exports.operationServerMap = {};

package/common.d.ts

@@ -12,54 +12,17 @@
 import type { Configuration } from "./configuration";
 import type { RequestArgs } from "./base";
 import type { AxiosInstance, AxiosResponse } from 'axios';
-/**
- *
- * @export
- */
 export declare const DUMMY_BASE_URL = "https://example.com";
 /**
  *
  * @throws {RequiredError}
- * @export
  */
 export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
-/**
- *
- * @export
- */
 export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
-/**
- *
- * @export
- */
 export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
-/**
- *
- * @export
- */
 export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
-/**
- *
- * @export
- */
 export declare const toPathString: (url: URL) => string;
-/**
- *
- * @export
- */
 export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/common.js

@@ -24,15 +24,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
 const base_1 = require("./base");
-/**
- *
- * @export
- */
 exports.DUMMY_BASE_URL = 'https://example.com';
 /**
  *
  * @throws {RequiredError}
- * @export
  */
 const assertParamExists = function (functionName, paramName, paramValue) {
     if (paramValue === null || paramValue === undefined) {
@@ -40,10 +35,6 @@ const assertParamExists = function (functionName, paramName, paramValue) {
     }
 };
 exports.assertParamExists = assertParamExists;
-/**
- *
- * @export
- */
 const setApiKeyToObject = function (object, keyParamName, configuration) {
     return __awaiter(this, void 0, void 0, function* () {
         if (configuration && configuration.apiKey) {
@@ -55,20 +46,12 @@ const setApiKeyToObject = function (object, keyParamName, configuration) {
     });
 };
 exports.setApiKeyToObject = setApiKeyToObject;
-/**
- *
- * @export
- */
 const setBasicAuthToObject = function (object, configuration) {
     if (configuration && (configuration.username || configuration.password)) {
         object["auth"] = { username: configuration.username, password: configuration.password };
     }
 };
 exports.setBasicAuthToObject = setBasicAuthToObject;
-/**
- *
- * @export
- */
 const setBearerAuthToObject = function (object, configuration) {
     return __awaiter(this, void 0, void 0, function* () {
         if (configuration && configuration.accessToken) {
@@ -80,10 +63,6 @@ const setBearerAuthToObject = function (object, configuration) {
     });
 };
 exports.setBearerAuthToObject = setBearerAuthToObject;
-/**
- *
- * @export
- */
 const setOAuthToObject = function (object, name, scopes, configuration) {
     return __awaiter(this, void 0, void 0, function* () {
         if (configuration && configuration.accessToken) {
@@ -115,20 +94,12 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
         }
     }
 }
-/**
- *
- * @export
- */
 const setSearchParams = function (url, ...objects) {
     const searchParams = new URLSearchParams(url.search);
     setFlattenedQueryParams(searchParams, objects);
     url.search = searchParams.toString();
 };
 exports.setSearchParams = setSearchParams;
-/**
- *
- * @export
- */
 const serializeDataIfNeeded = function (value, requestOptions, configuration) {
     const nonString = typeof value !== 'string';
     const needsSerialization = nonString && configuration && configuration.isJsonMime
@@ -139,18 +110,10 @@ const serializeDataIfNeeded = function (value, requestOptions, configuration) {
         : (value || "");
 };
 exports.serializeDataIfNeeded = serializeDataIfNeeded;
-/**
- *
- * @export
- */
 const toPathString = function (url) {
     return url.pathname + url.search + url.hash;
 };
 exports.toPathString = toPathString;
-/**
- *
- * @export
- */
 const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
     return (axios = globalAxios, basePath = BASE_PATH) => {
         var _a;

package/configuration.d.ts

@@ -23,49 +23,32 @@ export declare class Configuration {
     /**
      * parameter for apiKey security
      * @param name security name
-     * @memberof Configuration
      */
     apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     username?: string;
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     password?: string;
     /**
      * parameter for oauth2 security
      * @param name security name
      * @param scopes oauth2 scope
-     * @memberof Configuration
      */
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
     /**
      * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     basePath?: string;
     /**
      * override server index
-     *
-     * @type {number}
-     * @memberof Configuration
      */
     serverIndex?: number;
     /**
      * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
      */
     baseOptions?: any;
     /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@idunion/tl-sdk",
   "private": false,
-  "version": "0.0.28",
+  "version": "0.0.30",
   "description": "",
   "main": "index.js",
   "scripts": {