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

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Oct 5, 2023
1 parent 3f6204a commit b2994d4
Show file tree
Hide file tree
Showing 36 changed files with 153 additions and 152 deletions.
14 changes: 7 additions & 7 deletions docs/classes/LE.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">LE</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/le.ts#L10">le.ts:10</a></li></ul></aside>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/le.ts#L10">le.ts:10</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -70,24 +70,24 @@ <h5><span class="tsd-kind-parameter">registryAID</span>: <span class="tsd-signat
<h4 class="tsd-returns-title">Returns <a href="LE.html" class="tsd-signature-type tsd-kind-class">LE</a></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/le.ts#L27">le.ts:27</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/le.ts#L27">le.ts:27</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-is-private"><a id="client" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>client</span><a href="#client" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">client</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">SignifyClient</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/le.ts#L11">le.ts:11</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/le.ts#L11">le.ts:11</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="name" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/le.ts#L12">le.ts:12</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/le.ts#L12">le.ts:12</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="registryAID" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>registryAID</span><a href="#registryAID" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">registryAID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/le.ts#L13">le.ts:13</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/le.ts#L13">le.ts:13</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member"><a id="createECRAuthCredential" class="tsd-anchor"></a>
Expand All @@ -114,7 +114,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise<

<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/le.ts#L41">le.ts:41</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/le.ts#L41">le.ts:41</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="createOORAuthCredential" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>createOORAuth<wbr/>Credential</span><a href="#createOORAuthCredential" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -139,7 +139,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise<

<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/le.ts#L68">le.ts:68</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/le.ts#L68">le.ts:68</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
16 changes: 8 additions & 8 deletions docs/classes/QVI.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">QVI</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/qvi.ts#L10">qvi.ts:10</a></li></ul></aside>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/qvi.ts#L10">qvi.ts:10</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -73,24 +73,24 @@ <h5><span class="tsd-kind-parameter">registry</span>: <span class="tsd-signature
<h4 class="tsd-returns-title">Returns <a href="QVI.html" class="tsd-signature-type tsd-kind-class">QVI</a></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/qvi.ts#L29">qvi.ts:29</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/qvi.ts#L29">qvi.ts:29</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-is-private"><a id="client" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>client</span><a href="#client" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">client</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">SignifyClient</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/qvi.ts#L11">qvi.ts:11</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/qvi.ts#L11">qvi.ts:11</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="name" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/qvi.ts#L12">qvi.ts:12</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/qvi.ts#L12">qvi.ts:12</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="registry" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>registry</span><a href="#registry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">registry</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/qvi.ts#L13">qvi.ts:13</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/qvi.ts#L13">qvi.ts:13</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member"><a id="createEngagementContextRoleCredential" class="tsd-anchor"></a>
Expand All @@ -116,7 +116,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise<

<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/qvi.ts#L70">qvi.ts:70</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/qvi.ts#L70">qvi.ts:70</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="createLegalEntityCredential" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>create<wbr/>Legal<wbr/>Entity<wbr/>Credential</span><a href="#createLegalEntityCredential" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -140,7 +140,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise<

<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/qvi.ts#L43">qvi.ts:43</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/qvi.ts#L43">qvi.ts:43</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="createOfficialOrganizationRoleCredential" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>create<wbr/>Official<wbr/>Organization<wbr/>Role<wbr/>Credential</span><a href="#createOfficialOrganizationRoleCredential" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -164,7 +164,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise<

<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/qvi.ts#L97">qvi.ts:97</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/qvi.ts#L97">qvi.ts:97</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
18 changes: 9 additions & 9 deletions docs/classes/credentials.EngagementContextRoleAuthorizationCredentialData.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">EngagementContextRoleAuthorizationCredentialData</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/credentials.ts#L152">credentials.ts:152</a></li></ul></aside>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/credentials.ts#L152">credentials.ts:152</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -60,7 +60,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5><span class="tsd-kind-parameter">__namedParameters</span>: <a href="../interfaces/credentials.EngagementContextRoleAuthorizationCredentialDataArgs.html" class="tsd-signature-type tsd-kind-interface">EngagementContextRoleAuthorizationCredentialDataArgs</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="credentials.EngagementContextRoleAuthorizationCredentialData.html" class="tsd-signature-type tsd-kind-class">EngagementContextRoleAuthorizationCredentialData</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/credentials.ts#L161">credentials.ts:161</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/credentials.ts#L161">credentials.ts:161</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member"><a id="AID" class="tsd-anchor"></a>
Expand All @@ -70,40 +70,40 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/credentials.ts#L156">credentials.ts:156</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/credentials.ts#L156">credentials.ts:156</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="LEI" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>LEI</span><a href="#LEI" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">LEI</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>of the requesting Legal Entity</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/credentials.ts#L157">credentials.ts:157</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/credentials.ts#L157">credentials.ts:157</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="d" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>d</span><a href="#d" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">d</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/credentials.ts#L153">credentials.ts:153</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/credentials.ts#L153">credentials.ts:153</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="dt" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>dt</span><a href="#dt" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">dt</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/credentials.ts#L155">credentials.ts:155</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/credentials.ts#L155">credentials.ts:155</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="engagementContextRole" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>engagement<wbr/>Context<wbr/>Role</span><a href="#engagementContextRole" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">engagement<wbr/>Context<wbr/>Role</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/credentials.ts#L159">credentials.ts:159</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/credentials.ts#L159">credentials.ts:159</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="i" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>i</span><a href="#i" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">i</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/credentials.ts#L154">credentials.ts:154</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/credentials.ts#L154">credentials.ts:154</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="personLegalName" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>person<wbr/>Legal<wbr/>Name</span><a href="#personLegalName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">person<wbr/>Legal<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/816bac4/src/credentials.ts#L158">credentials.ts:158</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/3f6204a/src/credentials.ts#L158">credentials.ts:158</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
Loading

0 comments on commit b2994d4

Please sign in to comment.