Skip to content
This repository has been archived by the owner on May 29, 2024. It is now read-only.

cleans up doc strings #16

Merged
merged 1 commit into from
Oct 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/credentials.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions src/le.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@ export class LE {
* @param {AID} issuee AID of QVI
* @param {credentials.EngagementContextRoleAuthorizationCredentialData} data
* @param {edges.EngagementContextRoleAuthorizationEdge} edge}
* @returns
* @returns {Promise<any>} A promise to the long-running operation
*/
public async createECRAuthCredential(
issuee: AID,
data: credentials.EngagementContextRoleAuthorizationCredentialData,
edge: edges.EngagementContextRoleAuthorizationEdge
) {
): Promise<any> {
return await this.client
.credentials()
.issue(
Expand All @@ -63,13 +63,13 @@ export class LE {
* @param {AID} issuee AID of QVI
* @param {credentials.OfficialOrganizationalRoleAuthorizationCredentialData} data
* @param {edges.OfficialOrganizationalRoleAuthorizationCredentialEdge} edge}
* @returns
* @returns {Promise<any>} A promise to the long-running operation
*/
public async createOORAuthCredential(
issuee: AID,
data: credentials.OfficialOrganizationalRoleAuthorizationCredentialData,
edge: edges.OfficialOrganizationalRoleAuthorizationEdge
) {
): Promise<any> {
return await this.client
.credentials()
.issue(
Expand Down
20 changes: 10 additions & 10 deletions src/qvi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,13 @@ export class QVI {
* @param {AID} issuee
* @param {credentials.LegalEntityCredentialData} data
* @param {edges.LegalEntityCredentialEdge} edge
* @returns
* @returns {Promise<any>} A promise to the long-running operation
*/
public async createLegalEntityCredential(
issuee: AID,
data: credentials.LegalEntityCredentialData,
edge: edges.LegalEntityCredentialEdge
) {
): Promise<any> {
return await this.client
.credentials()
.issue(
Expand All @@ -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<any>} A promise to the long-running operation
*/
public async createEngagementContextRoleCredential(
issuee: AID,
data: credentials.EngagementContextRoleCredentialData,
edge: edges.EngagementContextRoleCredentialEdge
) {
): Promise<any> {
return await this.client
.credentials()
.issue(
Expand All @@ -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<any>} A promise to the long-running operation
*/
public async createOfficialOrganizationRoleCredential(
issuee: AID,
data: credentials.OfficialOrganizationalRoleCredentialData,
edge: edges.OfficialOrganizationalRoleCredentialEdge
) {
): Promise<any> {
return await this.client
.credentials()
.issue(
Expand Down
Loading