@sudoplatform/sudo-privacy-interaction 2.4.0 → 2.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/gen/graphqlTypes.js +356 -7
- package/cjs/private/data/action/defaultActionService.js +8 -0
- package/cjs/private/data/action/transformer/actionIntentTransformer.js +32 -0
- package/cjs/private/data/action/transformer/availableActionTransformer.js +8 -0
- package/cjs/private/data/analysis-result/transformer/capabilitySignalsTransformer.js +2 -0
- package/cjs/private/data/common/apiClient.js +21 -0
- package/cjs/private/data/data-holder/transformer/dataHolderTransformer.js +8 -1
- package/cjs/private/data/virtual-presence/defaultVirtualPresenceService.js +4 -0
- package/cjs/private/domain/entities/action/actionEntity.js +14 -0
- package/cjs/private/domain/use-cases/action/listActionsForDataHolderUseCase.js +26 -0
- package/cjs/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithRefreshTokenUseCase.js +4 -1
- package/cjs/private/domain/use-cases/virtual-presence/refreshVirtualPresenceStateUseCase.js +25 -0
- package/cjs/public/defaultSudoPrivacyInteractionClient.js +24 -1
- package/cjs/public/typings/action.js +14 -0
- package/docs/assets/hierarchy.js +1 -1
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/DefaultSudoPrivacyInteractionClient.html +77 -29
- package/docs/enums/ActionFulfilmentMethod.html +3 -3
- package/docs/enums/ActionIntent.html +31 -7
- package/docs/enums/ActionOrigin.html +5 -5
- package/docs/enums/ActionStatus.html +9 -9
- package/docs/enums/DataHolderProtectionState.html +6 -6
- package/docs/enums/OrganizationCategory.html +31 -31
- package/docs/enums/RelationshipProvider.html +3 -3
- package/docs/hierarchy.html +7 -6
- package/docs/interfaces/Action.html +15 -15
- package/docs/interfaces/ActionContact.html +4 -4
- package/docs/interfaces/AssistedEmailTemplate.html +3 -3
- package/docs/interfaces/AssistedPayload.html +8 -8
- package/docs/interfaces/AvailableAction.html +20 -9
- package/docs/interfaces/CapabilitySignals.html +20 -12
- package/docs/interfaces/ConnectVirtualPresenceWithRefreshTokenInput.html +36 -21
- package/docs/interfaces/DataHolder.html +62 -42
- package/docs/interfaces/DataHolderScanSummary.html +14 -14
- package/docs/interfaces/InitiateActionInput.html +4 -4
- package/docs/interfaces/ListActionsForDataHolderInput.html +85 -0
- package/docs/interfaces/ListAnalysisResultsInput.html +1 -1
- package/docs/interfaces/ListAvailableActionsInput.html +14 -4
- package/docs/interfaces/ListDataHolderScanSummariesInput.html +1 -1
- package/docs/interfaces/ListDataHoldersInput.html +1 -1
- package/docs/interfaces/ListVirtualPresencesInput.html +2 -2
- package/docs/interfaces/OrganizationIdentity.html +5 -5
- package/docs/interfaces/Pagination.html +2 -1
- package/docs/interfaces/RescanVirtualPresenceInput.html +3 -3
- package/docs/interfaces/RiskIndicators.html +8 -8
- package/docs/interfaces/ScanOptions.html +6 -6
- package/docs/interfaces/SudoPrivacyInteractionClient.html +75 -29
- package/docs/modules.html +2 -2
- package/docs/types/SudoPrivacyInteractionClientOptions.html +2 -2
- package/lib/gen/graphqlTypes.js +355 -6
- package/lib/private/data/action/defaultActionService.js +8 -0
- package/lib/private/data/action/transformer/actionIntentTransformer.js +32 -0
- package/lib/private/data/action/transformer/availableActionTransformer.js +8 -0
- package/lib/private/data/analysis-result/transformer/capabilitySignalsTransformer.js +2 -0
- package/lib/private/data/common/apiClient.js +22 -1
- package/lib/private/data/data-holder/transformer/dataHolderTransformer.js +8 -1
- package/lib/private/data/virtual-presence/defaultVirtualPresenceService.js +4 -0
- package/lib/private/domain/entities/action/actionEntity.js +14 -0
- package/lib/private/domain/use-cases/action/listActionsForDataHolderUseCase.js +22 -0
- package/lib/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithRefreshTokenUseCase.js +4 -1
- package/lib/private/domain/use-cases/virtual-presence/refreshVirtualPresenceStateUseCase.js +21 -0
- package/lib/public/defaultSudoPrivacyInteractionClient.js +24 -1
- package/lib/public/typings/action.js +14 -0
- package/package.json +6 -1
- package/types/gen/graphqlTypes.d.ts +90 -8
- package/types/gen/schema-types.d.ts +41 -5
- package/types/private/data/action/defaultActionService.d.ts +2 -1
- package/types/private/data/action/transformer/availableActionTransformer.d.ts +1 -0
- package/types/private/data/common/apiClient.d.ts +8 -1
- package/types/private/data/virtual-presence/defaultVirtualPresenceService.d.ts +1 -0
- package/types/private/domain/entities/action/actionEntity.d.ts +18 -0
- package/types/private/domain/entities/action/actionService.d.ts +36 -0
- package/types/private/domain/entities/analysis-result/analysisResultEntity.d.ts +2 -0
- package/types/private/domain/entities/data-holder/dataHolderEntity.d.ts +5 -1
- package/types/private/domain/entities/virtual-presence/virtualPresenceService.d.ts +13 -3
- package/types/private/domain/use-cases/action/listActionsForDataHolderUseCase.d.ts +16 -0
- package/types/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithRefreshTokenUseCase.d.ts +2 -0
- package/types/private/domain/use-cases/virtual-presence/refreshVirtualPresenceStateUseCase.d.ts +16 -0
- package/types/public/defaultSudoPrivacyInteractionClient.d.ts +3 -1
- package/types/public/inputs/action.d.ts +16 -0
- package/types/public/inputs/virtualPresence.d.ts +10 -1
- package/types/public/sudoPrivacyInteractionClient.d.ts +23 -1
- package/types/public/typings/action.d.ts +19 -0
- package/types/public/typings/analysisResult.d.ts +2 -0
- package/types/public/typings/dataHolder.d.ts +9 -1
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
</div></section>
|
|
17
17
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">InitiateActionInput</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#dataholderid">dataHolderId</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#fulfilmentmethod">fulfilmentMethod</a><span class="tsd-signature-symbol">:</span> <a href="../enums/ActionFulfilmentMethod.html" class="tsd-signature-type tsd-kind-enum">ActionFulfilmentMethod</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#intent">intent</a><span class="tsd-signature-symbol">:</span> <a href="../enums/ActionIntent.html" class="tsd-signature-type tsd-kind-enum">ActionIntent</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
18
18
|
<ul>
|
|
19
|
-
<li>Defined in src/public/inputs/action.ts:
|
|
19
|
+
<li>Defined in src/public/inputs/action.ts:20</li></ul></aside>
|
|
20
20
|
<section class="tsd-panel-group tsd-index-group">
|
|
21
21
|
<section class="tsd-panel tsd-index-panel">
|
|
22
22
|
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
@@ -37,7 +37,7 @@
|
|
|
37
37
|
<div class="tsd-comment tsd-typography"><p>The data holder relationship to scope the action to.</p>
|
|
38
38
|
</div><aside class="tsd-sources">
|
|
39
39
|
<ul>
|
|
40
|
-
<li>Defined in src/public/inputs/action.ts:
|
|
40
|
+
<li>Defined in src/public/inputs/action.ts:21</li></ul></aside></section>
|
|
41
41
|
<section class="tsd-panel tsd-member">
|
|
42
42
|
<h3 class="tsd-anchor-link" id="fulfilmentmethod"><span>fulfilment<wbr/>Method</span><a href="#fulfilmentmethod" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
43
43
|
<div class="tsd-signature"><span class="tsd-kind-property">fulfilmentMethod</span><span class="tsd-signature-symbol">:</span> <a href="../enums/ActionFulfilmentMethod.html" class="tsd-signature-type tsd-kind-enum">ActionFulfilmentMethod</a></div>
|
|
@@ -46,14 +46,14 @@ was offered for this intent. Initiation fails if the server re-resolves a differ
|
|
|
46
46
|
method.</p>
|
|
47
47
|
</div><aside class="tsd-sources">
|
|
48
48
|
<ul>
|
|
49
|
-
<li>Defined in src/public/inputs/action.ts:
|
|
49
|
+
<li>Defined in src/public/inputs/action.ts:23</li></ul></aside></section>
|
|
50
50
|
<section class="tsd-panel tsd-member">
|
|
51
51
|
<h3 class="tsd-anchor-link" id="intent"><span>intent</span><a href="#intent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
52
52
|
<div class="tsd-signature"><span class="tsd-kind-property">intent</span><span class="tsd-signature-symbol">:</span> <a href="../enums/ActionIntent.html" class="tsd-signature-type tsd-kind-enum">ActionIntent</a></div>
|
|
53
53
|
<div class="tsd-comment tsd-typography"><p>The intent of the action to initiate.</p>
|
|
54
54
|
</div><aside class="tsd-sources">
|
|
55
55
|
<ul>
|
|
56
|
-
<li>Defined in src/public/inputs/action.ts:
|
|
56
|
+
<li>Defined in src/public/inputs/action.ts:22</li></ul></aside></section></section></details></div>
|
|
57
57
|
<div class="col-sidebar">
|
|
58
58
|
<div class="page-menu">
|
|
59
59
|
<div class="tsd-navigation settings">
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ListActionsForDataHolderInput | @sudoplatform/sudo-privacy-interaction</title><meta name="description" content="Documentation for @sudoplatform/sudo-privacy-interaction"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@sudoplatform/sudo-privacy-interaction</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="" aria-current="page">ListActionsForDataHolderInput</a></li></ul>
|
|
12
|
+
<h1>Interface ListActionsForDataHolderInput</h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>Properties required to list the persisted action history for a data holder.</p>
|
|
15
|
+
<p>ListActionsForDataHolderInput</p>
|
|
16
|
+
</div></section>
|
|
17
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListActionsForDataHolderInput</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#dataholderid">dataHolderId</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#limit">limit</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#nexttoken">nextToken</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
18
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="248">
|
|
19
|
+
<h4>Hierarchy (<a href="../hierarchy.html#ListActionsForDataHolderInput">View Summary</a>)</h4>
|
|
20
|
+
<ul class="tsd-hierarchy">
|
|
21
|
+
<li class="tsd-hierarchy-item"><a href="Pagination.html" class="tsd-signature-type tsd-kind-interface">Pagination</a>
|
|
22
|
+
<ul class="tsd-hierarchy">
|
|
23
|
+
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ListActionsForDataHolderInput</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
24
|
+
<ul>
|
|
25
|
+
<li>Defined in src/public/inputs/action.ts:48</li></ul></aside>
|
|
26
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
27
|
+
<section class="tsd-panel tsd-index-panel">
|
|
28
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
29
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
30
|
+
<div class="tsd-accordion-details">
|
|
31
|
+
<section class="tsd-index-section">
|
|
32
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
33
|
+
<div class="tsd-index-list"><a href="#dataholderid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data<wbr/>Holder<wbr/>Id</span></a>
|
|
34
|
+
<a href="#limit" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>limit?</span></a>
|
|
35
|
+
<a href="#nexttoken" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next<wbr/>Token?</span></a>
|
|
36
|
+
</div></section></div></details></section></section>
|
|
37
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
38
|
+
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
39
|
+
<section>
|
|
40
|
+
<section class="tsd-panel tsd-member">
|
|
41
|
+
<h3 class="tsd-anchor-link" id="dataholderid"><span>data<wbr/>Holder<wbr/>Id</span><a href="#dataholderid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
42
|
+
<div class="tsd-signature"><span class="tsd-kind-property">dataHolderId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
43
|
+
<div class="tsd-comment tsd-typography"><p>The data holder relationship to list the action history for.</p>
|
|
44
|
+
</div><aside class="tsd-sources">
|
|
45
|
+
<ul>
|
|
46
|
+
<li>Defined in src/public/inputs/action.ts:49</li></ul></aside></section>
|
|
47
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
48
|
+
<h3 class="tsd-anchor-link" id="limit"><code class="tsd-tag">Optional</code><span>limit</span><a href="#limit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
49
|
+
<div class="tsd-signature"><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
50
|
+
<div class="tsd-comment tsd-typography"><p>Number of items to return.</p>
|
|
51
|
+
</div><aside class="tsd-sources">
|
|
52
|
+
<p>Inherited from <a href="Pagination.html">Pagination</a>.<a href="Pagination.html#limit">limit</a></p>
|
|
53
|
+
<ul>
|
|
54
|
+
<li>Defined in src/public/inputs/common.ts:15</li></ul></aside></section>
|
|
55
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
56
|
+
<h3 class="tsd-anchor-link" id="nexttoken"><code class="tsd-tag">Optional</code><span>next<wbr/>Token</span><a href="#nexttoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
57
|
+
<div class="tsd-signature"><span class="tsd-kind-property">nextToken</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
58
|
+
<div class="tsd-comment tsd-typography"><p>A token generated by a previous call.</p>
|
|
59
|
+
</div><aside class="tsd-sources">
|
|
60
|
+
<p>Inherited from <a href="Pagination.html">Pagination</a>.<a href="Pagination.html#nexttoken">nextToken</a></p>
|
|
61
|
+
<ul>
|
|
62
|
+
<li>Defined in src/public/inputs/common.ts:16</li></ul></aside></section></section></details></div>
|
|
63
|
+
<div class="col-sidebar">
|
|
64
|
+
<div class="page-menu">
|
|
65
|
+
<div class="tsd-navigation settings">
|
|
66
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
67
|
+
<h3>Settings</h3></summary>
|
|
68
|
+
<div class="tsd-accordion-details">
|
|
69
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
70
|
+
<ul id="tsd-filter-options">
|
|
71
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
72
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
73
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
|
|
74
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
75
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
76
|
+
<h3>On This Page</h3></summary>
|
|
77
|
+
<div class="tsd-accordion-details">
|
|
78
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
|
|
79
|
+
<div><a href="#dataholderid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data<wbr/>Holder<wbr/>Id</span></a><a href="#limit" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>limit</span></a><a href="#nexttoken" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next<wbr/>Token</span></a></div></details></div></details></div>
|
|
80
|
+
<div class="site-menu">
|
|
81
|
+
<nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
|
|
82
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
83
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
84
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
85
|
+
<div class="overlay"></div></body></html>
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
<p>ListAnalysisResultsInput</p>
|
|
16
16
|
</div></section>
|
|
17
17
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListAnalysisResultsInput</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#limit">limit</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#nexttoken">nextToken</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#virtualpresenceid">virtualPresenceId</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
18
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
18
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="252">
|
|
19
19
|
<h4>Hierarchy (<a href="../hierarchy.html#ListAnalysisResultsInput">View Summary</a>)</h4>
|
|
20
20
|
<ul class="tsd-hierarchy">
|
|
21
21
|
<li class="tsd-hierarchy-item"><a href="Pagination.html" class="tsd-signature-type tsd-kind-interface">Pagination</a>
|
|
@@ -14,9 +14,9 @@
|
|
|
14
14
|
<div class="tsd-comment tsd-typography"><p>Properties required to list the actions available for a data holder relationship.</p>
|
|
15
15
|
<p>ListAvailableActionsInput</p>
|
|
16
16
|
</div></section>
|
|
17
|
-
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListAvailableActionsInput</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#dataholderid">dataHolderId</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
17
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListAvailableActionsInput</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#dataholderid">dataHolderId</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#includecompleted">includeCompleted</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
18
18
|
<ul>
|
|
19
|
-
<li>Defined in src/public/inputs/action.ts:
|
|
19
|
+
<li>Defined in src/public/inputs/action.ts:35</li></ul></aside>
|
|
20
20
|
<section class="tsd-panel-group tsd-index-group">
|
|
21
21
|
<section class="tsd-panel tsd-index-panel">
|
|
22
22
|
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
@@ -25,6 +25,7 @@
|
|
|
25
25
|
<section class="tsd-index-section">
|
|
26
26
|
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
27
27
|
<div class="tsd-index-list"><a href="#dataholderid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data<wbr/>Holder<wbr/>Id</span></a>
|
|
28
|
+
<a href="#includecompleted" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>include<wbr/>Completed?</span></a>
|
|
28
29
|
</div></section></div></details></section></section>
|
|
29
30
|
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
30
31
|
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
@@ -35,7 +36,16 @@
|
|
|
35
36
|
<div class="tsd-comment tsd-typography"><p>The data holder relationship to list available actions for.</p>
|
|
36
37
|
</div><aside class="tsd-sources">
|
|
37
38
|
<ul>
|
|
38
|
-
<li>Defined in src/public/inputs/action.ts:
|
|
39
|
+
<li>Defined in src/public/inputs/action.ts:36</li></ul></aside></section>
|
|
40
|
+
<section class="tsd-panel tsd-member">
|
|
41
|
+
<h3 class="tsd-anchor-link" id="includecompleted"><code class="tsd-tag">Optional</code><span>include<wbr/>Completed</span><a href="#includecompleted" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
42
|
+
<div class="tsd-signature"><span class="tsd-kind-property">includeCompleted</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
43
|
+
<div class="tsd-comment tsd-typography"><p>When true, actions the user has already
|
|
44
|
+
completed are included in the results. Defaults to false, omitting completed
|
|
45
|
+
actions.</p>
|
|
46
|
+
</div><aside class="tsd-sources">
|
|
47
|
+
<ul>
|
|
48
|
+
<li>Defined in src/public/inputs/action.ts:37</li></ul></aside></section></section></details></div>
|
|
39
49
|
<div class="col-sidebar">
|
|
40
50
|
<div class="page-menu">
|
|
41
51
|
<div class="tsd-navigation settings">
|
|
@@ -52,7 +62,7 @@
|
|
|
52
62
|
<h3>On This Page</h3></summary>
|
|
53
63
|
<div class="tsd-accordion-details">
|
|
54
64
|
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
|
|
55
|
-
<div><a href="#dataholderid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data<wbr/>Holder<wbr/>Id</span></a></div></details></div></details></div>
|
|
65
|
+
<div><a href="#dataholderid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data<wbr/>Holder<wbr/>Id</span></a><a href="#includecompleted"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>include<wbr/>Completed</span></a></div></details></div></details></div>
|
|
56
66
|
<div class="site-menu">
|
|
57
67
|
<nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
|
|
58
68
|
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
<p>ListDataHolderScanSummariesInput</p>
|
|
16
16
|
</div></section>
|
|
17
17
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListDataHolderScanSummariesInput</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#dataholderid">dataHolderId</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#limit">limit</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#nexttoken">nextToken</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
18
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
18
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="263">
|
|
19
19
|
<h4>Hierarchy (<a href="../hierarchy.html#ListDataHolderScanSummariesInput">View Summary</a>)</h4>
|
|
20
20
|
<ul class="tsd-hierarchy">
|
|
21
21
|
<li class="tsd-hierarchy-item"><a href="Pagination.html" class="tsd-signature-type tsd-kind-interface">Pagination</a>
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
<p>ListDataHoldersInput</p>
|
|
16
16
|
</div></section>
|
|
17
17
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListDataHoldersInput</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#limit">limit</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#nexttoken">nextToken</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#virtualpresenceid">virtualPresenceId</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
18
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
18
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="259">
|
|
19
19
|
<h4>Hierarchy (<a href="../hierarchy.html#ListDataHoldersInput">View Summary</a>)</h4>
|
|
20
20
|
<ul class="tsd-hierarchy">
|
|
21
21
|
<li class="tsd-hierarchy-item"><a href="Pagination.html" class="tsd-signature-type tsd-kind-interface">Pagination</a>
|
|
@@ -15,14 +15,14 @@
|
|
|
15
15
|
<p>ListVirtualPresencesInput</p>
|
|
16
16
|
</div></section>
|
|
17
17
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListVirtualPresencesInput</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#limit">limit</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#nexttoken">nextToken</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
18
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
18
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="288">
|
|
19
19
|
<h4>Hierarchy (<a href="../hierarchy.html#ListVirtualPresencesInput">View Summary</a>)</h4>
|
|
20
20
|
<ul class="tsd-hierarchy">
|
|
21
21
|
<li class="tsd-hierarchy-item"><a href="Pagination.html" class="tsd-signature-type tsd-kind-interface">Pagination</a>
|
|
22
22
|
<ul class="tsd-hierarchy">
|
|
23
23
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ListVirtualPresencesInput</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
24
24
|
<ul>
|
|
25
|
-
<li>Defined in src/public/inputs/virtualPresence.ts:
|
|
25
|
+
<li>Defined in src/public/inputs/virtualPresence.ts:74</li></ul></aside>
|
|
26
26
|
<section class="tsd-panel-group tsd-index-group">
|
|
27
27
|
<section class="tsd-panel tsd-index-panel">
|
|
28
28
|
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
</div></section>
|
|
17
17
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">OrganizationIdentity</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#brandname">brandName</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#categories">categories</a><span class="tsd-signature-symbol">:</span> <a href="../enums/OrganizationCategory.html" class="tsd-signature-type tsd-kind-enum">OrganizationCategory</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#companyname">companyName</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#primarycategory">primaryCategory</a><span class="tsd-signature-symbol">:</span> <a href="../enums/OrganizationCategory.html" class="tsd-signature-type tsd-kind-enum">OrganizationCategory</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
18
18
|
<ul>
|
|
19
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
19
|
+
<li>Defined in src/public/typings/analysisResult.ts:395</li></ul></aside>
|
|
20
20
|
<section class="tsd-panel-group tsd-index-group">
|
|
21
21
|
<section class="tsd-panel tsd-index-panel">
|
|
22
22
|
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
@@ -38,28 +38,28 @@
|
|
|
38
38
|
<div class="tsd-comment tsd-typography"><p>The consumer-facing brand name of the organization.</p>
|
|
39
39
|
</div><aside class="tsd-sources">
|
|
40
40
|
<ul>
|
|
41
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
41
|
+
<li>Defined in src/public/typings/analysisResult.ts:396</li></ul></aside></section>
|
|
42
42
|
<section class="tsd-panel tsd-member">
|
|
43
43
|
<h3 class="tsd-anchor-link" id="categories"><span>categories</span><a href="#categories" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
44
44
|
<div class="tsd-signature"><span class="tsd-kind-property">categories</span><span class="tsd-signature-symbol">:</span> <a href="../enums/OrganizationCategory.html" class="tsd-signature-type tsd-kind-enum">OrganizationCategory</a><span class="tsd-signature-symbol">[]</span></div>
|
|
45
45
|
<div class="tsd-comment tsd-typography"><p>All business categories the organization belongs to.</p>
|
|
46
46
|
</div><aside class="tsd-sources">
|
|
47
47
|
<ul>
|
|
48
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
48
|
+
<li>Defined in src/public/typings/analysisResult.ts:399</li></ul></aside></section>
|
|
49
49
|
<section class="tsd-panel tsd-member">
|
|
50
50
|
<h3 class="tsd-anchor-link" id="companyname"><span>company<wbr/>Name</span><a href="#companyname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
51
51
|
<div class="tsd-signature"><span class="tsd-kind-property">companyName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
52
52
|
<div class="tsd-comment tsd-typography"><p>The legal or corporate name of the organization.</p>
|
|
53
53
|
</div><aside class="tsd-sources">
|
|
54
54
|
<ul>
|
|
55
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
55
|
+
<li>Defined in src/public/typings/analysisResult.ts:397</li></ul></aside></section>
|
|
56
56
|
<section class="tsd-panel tsd-member">
|
|
57
57
|
<h3 class="tsd-anchor-link" id="primarycategory"><span>primary<wbr/>Category</span><a href="#primarycategory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
58
58
|
<div class="tsd-signature"><span class="tsd-kind-property">primaryCategory</span><span class="tsd-signature-symbol">:</span> <a href="../enums/OrganizationCategory.html" class="tsd-signature-type tsd-kind-enum">OrganizationCategory</a></div>
|
|
59
59
|
<div class="tsd-comment tsd-typography"><p>The primary business category of the organization.</p>
|
|
60
60
|
</div><aside class="tsd-sources">
|
|
61
61
|
<ul>
|
|
62
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
62
|
+
<li>Defined in src/public/typings/analysisResult.ts:398</li></ul></aside></section></section></details></div>
|
|
63
63
|
<div class="col-sidebar">
|
|
64
64
|
<div class="page-menu">
|
|
65
65
|
<div class="tsd-navigation settings">
|
|
@@ -15,11 +15,12 @@
|
|
|
15
15
|
<p>Pagination</p>
|
|
16
16
|
</div></section>
|
|
17
17
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">Pagination</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#limit">limit</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#nexttoken">nextToken</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
18
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
18
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="256">
|
|
19
19
|
<h4>Hierarchy (<a href="../hierarchy.html#Pagination">View Summary</a>)</h4>
|
|
20
20
|
<ul class="tsd-hierarchy">
|
|
21
21
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">Pagination</span>
|
|
22
22
|
<ul class="tsd-hierarchy">
|
|
23
|
+
<li class="tsd-hierarchy-item"><a href="ListActionsForDataHolderInput.html" class="tsd-signature-type tsd-kind-interface">ListActionsForDataHolderInput</a></li>
|
|
23
24
|
<li class="tsd-hierarchy-item"><a href="ListAnalysisResultsInput.html" class="tsd-signature-type tsd-kind-interface">ListAnalysisResultsInput</a></li>
|
|
24
25
|
<li class="tsd-hierarchy-item"><a href="ListDataHoldersInput.html" class="tsd-signature-type tsd-kind-interface">ListDataHoldersInput</a></li>
|
|
25
26
|
<li class="tsd-hierarchy-item"><a href="ListDataHolderScanSummariesInput.html" class="tsd-signature-type tsd-kind-interface">ListDataHolderScanSummariesInput</a></li>
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
</div></section>
|
|
17
17
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">RescanVirtualPresenceInput</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#id">id</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#options">options</a><span class="tsd-signature-symbol">?:</span> <a href="ScanOptions.html" class="tsd-signature-type tsd-kind-interface">ScanOptions</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
18
18
|
<ul>
|
|
19
|
-
<li>Defined in src/public/inputs/virtualPresence.ts:
|
|
19
|
+
<li>Defined in src/public/inputs/virtualPresence.ts:83</li></ul></aside>
|
|
20
20
|
<section class="tsd-panel-group tsd-index-group">
|
|
21
21
|
<section class="tsd-panel tsd-index-panel">
|
|
22
22
|
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
@@ -36,14 +36,14 @@
|
|
|
36
36
|
<div class="tsd-comment tsd-typography"><p>The unique identifier of the virtual presence to rescan.</p>
|
|
37
37
|
</div><aside class="tsd-sources">
|
|
38
38
|
<ul>
|
|
39
|
-
<li>Defined in src/public/inputs/virtualPresence.ts:
|
|
39
|
+
<li>Defined in src/public/inputs/virtualPresence.ts:84</li></ul></aside></section>
|
|
40
40
|
<section class="tsd-panel tsd-member">
|
|
41
41
|
<h3 class="tsd-anchor-link" id="options"><code class="tsd-tag">Optional</code><span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
42
42
|
<div class="tsd-signature"><span class="tsd-kind-property">options</span><span class="tsd-signature-symbol">?:</span> <a href="ScanOptions.html" class="tsd-signature-type tsd-kind-interface">ScanOptions</a></div>
|
|
43
43
|
<div class="tsd-comment tsd-typography"><p>Optional scan options to control the rescan behavior.</p>
|
|
44
44
|
</div><aside class="tsd-sources">
|
|
45
45
|
<ul>
|
|
46
|
-
<li>Defined in src/public/inputs/virtualPresence.ts:
|
|
46
|
+
<li>Defined in src/public/inputs/virtualPresence.ts:85</li></ul></aside></section></section></details></div>
|
|
47
47
|
<div class="col-sidebar">
|
|
48
48
|
<div class="page-menu">
|
|
49
49
|
<div class="tsd-navigation settings">
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
</div></section>
|
|
17
17
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">RiskIndicators</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#breachrisk">breachRisk</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#collectssensitivedatafornonessentialpurposes">collectsSensitiveDataForNonEssentialPurposes</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#datacollectionbreadth">dataCollectionBreadth</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#encryptionpractices">encryptionPractices</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hasindefiniteretention">hasIndefiniteRetention</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#maxretentiondays">maxRetentionDays</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#sellspersonalinformation">sellsPersonalInformation</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
18
18
|
<ul>
|
|
19
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
19
|
+
<li>Defined in src/public/typings/analysisResult.ts:338</li></ul></aside>
|
|
20
20
|
<section class="tsd-panel-group tsd-index-group">
|
|
21
21
|
<section class="tsd-panel tsd-index-panel">
|
|
22
22
|
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
@@ -41,7 +41,7 @@
|
|
|
41
41
|
<div class="tsd-comment tsd-typography"><p>Whether there is an elevated risk of data breach.</p>
|
|
42
42
|
</div><aside class="tsd-sources">
|
|
43
43
|
<ul>
|
|
44
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
44
|
+
<li>Defined in src/public/typings/analysisResult.ts:345</li></ul></aside></section>
|
|
45
45
|
<section class="tsd-panel tsd-member">
|
|
46
46
|
<h3 class="tsd-anchor-link" id="collectssensitivedatafornonessentialpurposes"><span>collects<wbr/>Sensitive<wbr/>Data<wbr/>For<wbr/>Non<wbr/>Essential<wbr/>Purposes</span><a href="#collectssensitivedatafornonessentialpurposes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
47
47
|
<div class="tsd-signature"><span class="tsd-kind-property">collectsSensitiveDataForNonEssentialPurposes</span><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a></div>
|
|
@@ -49,42 +49,42 @@
|
|
|
49
49
|
are collected for non-essential purposes.</p>
|
|
50
50
|
</div><aside class="tsd-sources">
|
|
51
51
|
<ul>
|
|
52
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
52
|
+
<li>Defined in src/public/typings/analysisResult.ts:340</li></ul></aside></section>
|
|
53
53
|
<section class="tsd-panel tsd-member">
|
|
54
54
|
<h3 class="tsd-anchor-link" id="datacollectionbreadth"><span>data<wbr/>Collection<wbr/>Breadth</span><a href="#datacollectionbreadth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
55
55
|
<div class="tsd-signature"><span class="tsd-kind-property">dataCollectionBreadth</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
56
56
|
<div class="tsd-comment tsd-typography"><p>Total number of data categories collected.</p>
|
|
57
57
|
</div><aside class="tsd-sources">
|
|
58
58
|
<ul>
|
|
59
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
59
|
+
<li>Defined in src/public/typings/analysisResult.ts:339</li></ul></aside></section>
|
|
60
60
|
<section class="tsd-panel tsd-member">
|
|
61
61
|
<h3 class="tsd-anchor-link" id="encryptionpractices"><span>encryption<wbr/>Practices</span><a href="#encryptionpractices" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
62
62
|
<div class="tsd-signature"><span class="tsd-kind-property">encryptionPractices</span><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a></div>
|
|
63
63
|
<div class="tsd-comment tsd-typography"><p>Whether strong encryption practices are in place.</p>
|
|
64
64
|
</div><aside class="tsd-sources">
|
|
65
65
|
<ul>
|
|
66
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
66
|
+
<li>Defined in src/public/typings/analysisResult.ts:344</li></ul></aside></section>
|
|
67
67
|
<section class="tsd-panel tsd-member">
|
|
68
68
|
<h3 class="tsd-anchor-link" id="hasindefiniteretention"><span>has<wbr/>Indefinite<wbr/>Retention</span><a href="#hasindefiniteretention" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
69
69
|
<div class="tsd-signature"><span class="tsd-kind-property">hasIndefiniteRetention</span><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a></div>
|
|
70
70
|
<div class="tsd-comment tsd-typography"><p>Whether any category has indefinite retention.</p>
|
|
71
71
|
</div><aside class="tsd-sources">
|
|
72
72
|
<ul>
|
|
73
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
73
|
+
<li>Defined in src/public/typings/analysisResult.ts:343</li></ul></aside></section>
|
|
74
74
|
<section class="tsd-panel tsd-member">
|
|
75
75
|
<h3 class="tsd-anchor-link" id="maxretentiondays"><code class="tsd-tag">Optional</code><span>max<wbr/>Retention<wbr/>Days</span><a href="#maxretentiondays" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
76
76
|
<div class="tsd-signature"><span class="tsd-kind-property">maxRetentionDays</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
77
77
|
<div class="tsd-comment tsd-typography"><p>Longest known retention period in days across all categories.</p>
|
|
78
78
|
</div><aside class="tsd-sources">
|
|
79
79
|
<ul>
|
|
80
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
80
|
+
<li>Defined in src/public/typings/analysisResult.ts:342</li></ul></aside></section>
|
|
81
81
|
<section class="tsd-panel tsd-member">
|
|
82
82
|
<h3 class="tsd-anchor-link" id="sellspersonalinformation"><span>sells<wbr/>Personal<wbr/>Information</span><a href="#sellspersonalinformation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
83
83
|
<div class="tsd-signature"><span class="tsd-kind-property">sellsPersonalInformation</span><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a></div>
|
|
84
84
|
<div class="tsd-comment tsd-typography"><p>Whether data selling is indicated.</p>
|
|
85
85
|
</div><aside class="tsd-sources">
|
|
86
86
|
<ul>
|
|
87
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
87
|
+
<li>Defined in src/public/typings/analysisResult.ts:341</li></ul></aside></section></section></details></div>
|
|
88
88
|
<div class="col-sidebar">
|
|
89
89
|
<div class="page-menu">
|
|
90
90
|
<div class="tsd-navigation settings">
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
</div></section>
|
|
17
17
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ScanOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#earliestscandate">earliestScanDate</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#excludecategories">excludeCategories</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#excludedomains">excludeDomains</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#latestscandate">latestScanDate</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#maximumitemsprocessed">maximumItemsProcessed</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
18
18
|
<ul>
|
|
19
|
-
<li>Defined in src/public/inputs/virtualPresence.ts:
|
|
19
|
+
<li>Defined in src/public/inputs/virtualPresence.ts:98</li></ul></aside>
|
|
20
20
|
<section class="tsd-panel-group tsd-index-group">
|
|
21
21
|
<section class="tsd-panel tsd-index-panel">
|
|
22
22
|
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
@@ -39,35 +39,35 @@
|
|
|
39
39
|
<div class="tsd-comment tsd-typography"><p>Earliest date boundary for the scan (ISO 8601 string).</p>
|
|
40
40
|
</div><aside class="tsd-sources">
|
|
41
41
|
<ul>
|
|
42
|
-
<li>Defined in src/public/inputs/virtualPresence.ts:
|
|
42
|
+
<li>Defined in src/public/inputs/virtualPresence.ts:100</li></ul></aside></section>
|
|
43
43
|
<section class="tsd-panel tsd-member">
|
|
44
44
|
<h3 class="tsd-anchor-link" id="excludecategories"><code class="tsd-tag">Optional</code><span>exclude<wbr/>Categories</span><a href="#excludecategories" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
45
45
|
<div class="tsd-signature"><span class="tsd-kind-property">excludeCategories</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
46
46
|
<div class="tsd-comment tsd-typography"><p>Categories to exclude from the scan.</p>
|
|
47
47
|
</div><aside class="tsd-sources">
|
|
48
48
|
<ul>
|
|
49
|
-
<li>Defined in src/public/inputs/virtualPresence.ts:
|
|
49
|
+
<li>Defined in src/public/inputs/virtualPresence.ts:103</li></ul></aside></section>
|
|
50
50
|
<section class="tsd-panel tsd-member">
|
|
51
51
|
<h3 class="tsd-anchor-link" id="excludedomains"><code class="tsd-tag">Optional</code><span>exclude<wbr/>Domains</span><a href="#excludedomains" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
52
52
|
<div class="tsd-signature"><span class="tsd-kind-property">excludeDomains</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
53
53
|
<div class="tsd-comment tsd-typography"><p>Domains to exclude from the scan.</p>
|
|
54
54
|
</div><aside class="tsd-sources">
|
|
55
55
|
<ul>
|
|
56
|
-
<li>Defined in src/public/inputs/virtualPresence.ts:
|
|
56
|
+
<li>Defined in src/public/inputs/virtualPresence.ts:102</li></ul></aside></section>
|
|
57
57
|
<section class="tsd-panel tsd-member">
|
|
58
58
|
<h3 class="tsd-anchor-link" id="latestscandate"><code class="tsd-tag">Optional</code><span>latest<wbr/>Scan<wbr/>Date</span><a href="#latestscandate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
59
59
|
<div class="tsd-signature"><span class="tsd-kind-property">latestScanDate</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
60
60
|
<div class="tsd-comment tsd-typography"><p>Latest date boundary for the scan (ISO 8601 string).</p>
|
|
61
61
|
</div><aside class="tsd-sources">
|
|
62
62
|
<ul>
|
|
63
|
-
<li>Defined in src/public/inputs/virtualPresence.ts:
|
|
63
|
+
<li>Defined in src/public/inputs/virtualPresence.ts:101</li></ul></aside></section>
|
|
64
64
|
<section class="tsd-panel tsd-member">
|
|
65
65
|
<h3 class="tsd-anchor-link" id="maximumitemsprocessed"><code class="tsd-tag">Optional</code><span>maximum<wbr/>Items<wbr/>Processed</span><a href="#maximumitemsprocessed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
66
66
|
<div class="tsd-signature"><span class="tsd-kind-property">maximumItemsProcessed</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
67
67
|
<div class="tsd-comment tsd-typography"><p>Maximum number of items to process during the scan.</p>
|
|
68
68
|
</div><aside class="tsd-sources">
|
|
69
69
|
<ul>
|
|
70
|
-
<li>Defined in src/public/inputs/virtualPresence.ts:
|
|
70
|
+
<li>Defined in src/public/inputs/virtualPresence.ts:99</li></ul></aside></section></section></details></div>
|
|
71
71
|
<div class="col-sidebar">
|
|
72
72
|
<div class="page-menu">
|
|
73
73
|
<div class="tsd-navigation settings">
|