diff --git a/src/credentials.ts b/src/credentials.ts index 7cff012..bf661ec 100644 --- a/src/credentials.ts +++ b/src/credentials.ts @@ -20,6 +20,8 @@ namespace credentials { /** * LegalEntityCredentialData * + * {@link https://raw.githubusercontent.com/WebOfTrust/vLEI/dev/schema/acdc/legal-entity-vLEI-credential.json} + * * @property {d string} digest of {@link LegalEntityCredentialData} block * @property {i AID} AID of credential issuee * @property {dt string} Date-time stamp @@ -68,6 +70,8 @@ namespace credentials { /** * EngagementContextRoleCredentialData * + * {@link https://raw.githubusercontent.com/WebOfTrust/vLEI/dev/schema/acdc/legal-entity-engagement-context-role-vLEI-credential.json} + * * @property {d string} QVI Issuee AID * @property {u string} Issuance date time * @property {i AID} Person Issuee AID @@ -135,6 +139,7 @@ namespace credentials { /** * EngagementContextRoleAuthorizationCredentialData * + * {@link https://raw.githubusercontent.com/WebOfTrust/vLEI/dev/schema/acdc/ecr-authorization-vlei-credential.json} * * @property {d string} SAID of EngagementContextRoleAuthorizationCredentialData * @property {i string} QVI Issuee AID @@ -203,6 +208,8 @@ namespace credentials { /** * OfficialOrganizationalRoleCredentialData * + * {@link https://raw.githubusercontent.com/WebOfTrust/vLEI/dev/schema/acdc/legal-entity-official-organizational-role-vLEI-credential.json} + * * @property {d string} QVI Issuee AID * @property {u string} Issuance date time * @property {i AID} Person Issuee AID @@ -270,6 +277,8 @@ namespace credentials { /** * OfficialOrganizationalRoleAuthorizationCredentialData * + * {@link https://raw.githubusercontent.com/WebOfTrust/vLEI/dev/schema/acdc/oor-authorization-vlei-credential.json} + * * @property {d string} SAID of EngagementContextRoleAuthorizationCredentialData * @property {i string} QVI Issuee AID * @property {dt string} Issuance date time diff --git a/src/le.ts b/src/le.ts index 66c9308..250f5bc 100644 --- a/src/le.ts +++ b/src/le.ts @@ -36,13 +36,13 @@ export class LE { * @param {AID} issuee AID of QVI * @param {credentials.EngagementContextRoleAuthorizationCredentialData} data * @param {edges.EngagementContextRoleAuthorizationEdge} edge} - * @returns + * @returns {Promise} A promise to the long-running operation */ public async createECRAuthCredential( issuee: AID, data: credentials.EngagementContextRoleAuthorizationCredentialData, edge: edges.EngagementContextRoleAuthorizationEdge - ) { + ): Promise { return await this.client .credentials() .issue( @@ -63,13 +63,13 @@ export class LE { * @param {AID} issuee AID of QVI * @param {credentials.OfficialOrganizationalRoleAuthorizationCredentialData} data * @param {edges.OfficialOrganizationalRoleAuthorizationCredentialEdge} edge} - * @returns + * @returns {Promise} A promise to the long-running operation */ public async createOORAuthCredential( issuee: AID, data: credentials.OfficialOrganizationalRoleAuthorizationCredentialData, edge: edges.OfficialOrganizationalRoleAuthorizationEdge - ) { + ): Promise { return await this.client .credentials() .issue( diff --git a/src/qvi.ts b/src/qvi.ts index 23a8844..78130c1 100644 --- a/src/qvi.ts +++ b/src/qvi.ts @@ -38,13 +38,13 @@ export class QVI { * @param {AID} issuee * @param {credentials.LegalEntityCredentialData} data * @param {edges.LegalEntityCredentialEdge} edge - * @returns + * @returns {Promise} A promise to the long-running operation */ public async createLegalEntityCredential( issuee: AID, data: credentials.LegalEntityCredentialData, edge: edges.LegalEntityCredentialEdge - ) { + ): Promise { return await this.client .credentials() .issue( @@ -63,15 +63,15 @@ export class QVI { * Create Engagement Context Role Credential * * @param {AID} issuee - * @param {ECRvLEICredentialData} data - * @param {ECRAuthEdge} edge - * @returns + * @param {credentials.EngagementContextRoleCredentialData} data + * @param {edges.EngagementContextRoleCredentialEdge} edge + * @returns {Promise} A promise to the long-running operation */ public async createEngagementContextRoleCredential( issuee: AID, data: credentials.EngagementContextRoleCredentialData, edge: edges.EngagementContextRoleCredentialEdge - ) { + ): Promise { return await this.client .credentials() .issue( @@ -90,15 +90,15 @@ export class QVI { * Create Official Organizational Role Credential * * @param {AID} issuee - * @param {OORvLEICredentialData} data - * @param {OORAuthvLEICredentialData} edge - * @returns + * @param {credentials.OfficialOrganizationalRoleCredentialData} data + * @param {edges.OfficialOrganizationalRoleCredentialEdge} edge + * @returns {Promise} A promise to the long-running operation */ public async createOfficialOrganizationRoleCredential( issuee: AID, data: credentials.OfficialOrganizationalRoleCredentialData, edge: edges.OfficialOrganizationalRoleCredentialEdge - ) { + ): Promise { return await this.client .credentials() .issue(