@sudoplatform/sudo-privacy-interaction 2.2.0 → 2.4.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 +443 -11
- package/cjs/gen/schema-types.js +2 -0
- package/cjs/private/data/action/defaultActionService.js +7 -0
- package/cjs/private/data/analysis-result/defaultAnalysisResultService.js +6 -0
- package/cjs/private/data/analysis-result/transformer/analysisResultStatusReasonTransformer.js +45 -0
- package/cjs/private/data/analysis-result/transformer/analysisResultTransformer.js +6 -0
- package/cjs/private/data/analysis-result/transformer/capabilitySignalsTransformer.js +5 -2
- package/cjs/private/data/analysis-result/transformer/organizationCategoryTransformer.js +4 -0
- package/cjs/private/data/common/apiClient.js +29 -1
- package/cjs/private/data/data-holder/defaultDataHolderService.js +8 -0
- package/cjs/private/data/data-holder/transformer/dataHolderProtectionStateTransformer.js +4 -0
- package/cjs/private/data/organization-analysis/defaultOrganizationAnalysisService.js +6 -0
- package/cjs/private/data/organization-analysis/transformer/organizationAnalysisDomainResolutionTransformer.js +29 -0
- package/cjs/private/data/organization-analysis/transformer/organizationAnalysisTransformer.js +6 -0
- package/cjs/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +8 -0
- package/cjs/private/domain/entities/analysis-result/analysisResultEntity.js +21 -1
- package/cjs/private/domain/entities/data-holder/dataHolderEntity.js +2 -0
- package/cjs/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +17 -1
- package/cjs/private/domain/use-cases/action/getActionUseCase.js +25 -0
- package/cjs/private/domain/use-cases/data-holder/archiveDataHolderUseCase.js +25 -0
- package/cjs/private/domain/use-cases/data-holder/unarchiveDataHolderUseCase.js +25 -0
- package/cjs/public/defaultSudoPrivacyInteractionClient.js +31 -0
- package/cjs/public/typings/analysisResult.js +21 -1
- package/cjs/public/typings/dataHolder.js +2 -0
- package/cjs/public/typings/organizationAnalysis.js +17 -1
- 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 +93 -27
- package/docs/enums/AnalysisResultStatus.html +6 -6
- package/docs/enums/AnalysisResultStatusReason.html +81 -0
- package/docs/enums/DataCategory.html +18 -18
- package/docs/enums/DataHolderProtectionState.html +12 -6
- package/docs/enums/OrganizationAnalysisDomainResolution.html +70 -0
- package/docs/enums/OrganizationAnalysisMode.html +3 -3
- package/docs/enums/OrganizationCategory.html +38 -32
- package/docs/enums/ProviderType.html +3 -3
- package/docs/enums/RetentionStyle.html +5 -5
- package/docs/enums/ShareStyle.html +6 -6
- package/docs/enums/SignalValue.html +4 -4
- package/docs/enums/VirtualPresenceState.html +7 -7
- package/docs/hierarchy.html +6 -6
- package/docs/interfaces/AnalysisResult.html +21 -13
- package/docs/interfaces/AnalysisResultData.html +8 -8
- package/docs/interfaces/AnalysisResultUpdate.html +20 -12
- package/docs/interfaces/CapabilitySignals.html +41 -29
- package/docs/interfaces/CategorySignals.html +11 -11
- package/docs/interfaces/DataHolderCount.html +98 -0
- package/docs/interfaces/DataHolderScanSummary.html +14 -14
- package/docs/interfaces/GetOrganizationAnalysisInput.html +24 -5
- package/docs/interfaces/ListAnalysisResultsInput.html +1 -1
- package/docs/interfaces/ListDataHolderScanSummariesInput.html +1 -1
- package/docs/interfaces/ListDataHoldersInput.html +1 -1
- package/docs/interfaces/ListVirtualPresencesInput.html +1 -1
- package/docs/interfaces/OrganizationAnalysis.html +20 -12
- package/docs/interfaces/OrganizationIdentity.html +5 -5
- package/docs/interfaces/Pagination.html +1 -1
- package/docs/interfaces/PrivacyScore.html +4 -4
- package/docs/interfaces/PrivacySummary.html +4 -4
- package/docs/interfaces/RetentionInfo.html +4 -4
- package/docs/interfaces/RiskIndicators.html +8 -8
- package/docs/interfaces/ScoreContribution.html +3 -3
- package/docs/interfaces/ScoreCoverage.html +3 -3
- package/docs/interfaces/SudoPrivacyInteractionClient.html +78 -15
- package/docs/interfaces/VirtualPresence.html +22 -13
- package/docs/modules.html +4 -4
- package/docs/types/SudoPrivacyInteractionClientOptions.html +2 -2
- package/lib/gen/graphqlTypes.js +441 -10
- package/lib/gen/schema-types.js +1 -0
- package/lib/private/data/action/defaultActionService.js +7 -0
- package/lib/private/data/analysis-result/defaultAnalysisResultService.js +6 -0
- package/lib/private/data/analysis-result/transformer/analysisResultStatusReasonTransformer.js +41 -0
- package/lib/private/data/analysis-result/transformer/analysisResultTransformer.js +6 -0
- package/lib/private/data/analysis-result/transformer/capabilitySignalsTransformer.js +5 -2
- package/lib/private/data/analysis-result/transformer/organizationCategoryTransformer.js +4 -0
- package/lib/private/data/common/apiClient.js +30 -2
- package/lib/private/data/data-holder/defaultDataHolderService.js +8 -0
- package/lib/private/data/data-holder/transformer/dataHolderProtectionStateTransformer.js +4 -0
- package/lib/private/data/organization-analysis/defaultOrganizationAnalysisService.js +6 -0
- package/lib/private/data/organization-analysis/transformer/organizationAnalysisDomainResolutionTransformer.js +25 -0
- package/lib/private/data/organization-analysis/transformer/organizationAnalysisTransformer.js +6 -0
- package/lib/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +8 -0
- package/lib/private/domain/entities/analysis-result/analysisResultEntity.js +20 -0
- package/lib/private/domain/entities/data-holder/dataHolderEntity.js +2 -0
- package/lib/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +16 -0
- package/lib/private/domain/use-cases/action/getActionUseCase.js +21 -0
- package/lib/private/domain/use-cases/data-holder/archiveDataHolderUseCase.js +21 -0
- package/lib/private/domain/use-cases/data-holder/unarchiveDataHolderUseCase.js +21 -0
- package/lib/public/defaultSudoPrivacyInteractionClient.js +31 -0
- package/lib/public/typings/analysisResult.js +20 -0
- package/lib/public/typings/dataHolder.js +2 -0
- package/lib/public/typings/organizationAnalysis.js +16 -0
- package/package.json +19 -23
- package/types/gen/graphqlTypes.d.ts +338 -645
- package/types/gen/schema-types.d.ts +525 -0
- package/types/private/data/action/defaultActionService.d.ts +1 -0
- package/types/private/data/analysis-result/defaultAnalysisResultService.d.ts +1 -0
- package/types/private/data/analysis-result/transformer/analysisResultStatusReasonTransformer.d.ts +12 -0
- package/types/private/data/analysis-result/transformer/analysisResultTransformer.d.ts +1 -0
- package/types/private/data/common/apiClient.d.ts +6 -1
- package/types/private/data/data-holder/defaultDataHolderService.d.ts +2 -0
- package/types/private/data/organization-analysis/defaultOrganizationAnalysisService.d.ts +1 -0
- package/types/private/data/organization-analysis/transformer/organizationAnalysisDomainResolutionTransformer.d.ts +12 -0
- package/types/private/data/organization-analysis/transformer/organizationAnalysisTransformer.d.ts +1 -0
- package/types/private/domain/entities/action/actionService.d.ts +11 -0
- package/types/private/domain/entities/analysis-result/analysisResultEntity.d.ts +23 -2
- package/types/private/domain/entities/data-holder/dataHolderEntity.d.ts +2 -0
- package/types/private/domain/entities/data-holder/dataHolderService.d.ts +16 -0
- package/types/private/domain/entities/organization-analysis/organizationAnalysisEntity.d.ts +18 -1
- package/types/private/domain/entities/organization-analysis/organizationAnalysisService.d.ts +8 -1
- package/types/private/domain/entities/virtual-presence/virtualPresenceEntity.d.ts +24 -0
- package/types/private/domain/use-cases/action/getActionUseCase.d.ts +16 -0
- package/types/private/domain/use-cases/data-holder/archiveDataHolderUseCase.d.ts +16 -0
- package/types/private/domain/use-cases/data-holder/unarchiveDataHolderUseCase.d.ts +16 -0
- package/types/public/defaultSudoPrivacyInteractionClient.d.ts +4 -0
- package/types/public/inputs/organizationAnalysis.d.ts +8 -1
- package/types/public/sudoPrivacyInteractionClient.d.ts +27 -0
- package/types/public/typings/analysisResult.d.ts +30 -0
- package/types/public/typings/dataHolder.d.ts +2 -0
- package/types/public/typings/organizationAnalysis.d.ts +18 -1
- package/types/public/typings/virtualPresence.d.ts +25 -0
|
@@ -14,9 +14,9 @@
|
|
|
14
14
|
<div class="tsd-comment tsd-typography"><p>The Sudo Platform SDK representation of an analysis result.</p>
|
|
15
15
|
<p>AnalysisResult</p>
|
|
16
16
|
</div></section>
|
|
17
|
-
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AnalysisResult</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#createdat">createdAt</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#data">data</a><span class="tsd-signature-symbol">?:</span> <a href="AnalysisResultData.html" class="tsd-signature-type tsd-kind-interface">AnalysisResultData</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#dataholderidentifier">dataHolderIdentifier</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="#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="#lastanalyzedat">lastAnalyzedAt</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#owner">owner</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="#status">status</a><span class="tsd-signature-symbol">:</span> <a href="../enums/AnalysisResultStatus.html" class="tsd-signature-type tsd-kind-enum">AnalysisResultStatus</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#updatedat">updatedAt</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#version">version</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="#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><aside class="tsd-sources">
|
|
17
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AnalysisResult</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#createdat">createdAt</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#data">data</a><span class="tsd-signature-symbol">?:</span> <a href="AnalysisResultData.html" class="tsd-signature-type tsd-kind-interface">AnalysisResultData</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#dataholderidentifier">dataHolderIdentifier</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="#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="#lastanalyzedat">lastAnalyzedAt</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#owner">owner</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="#status">status</a><span class="tsd-signature-symbol">:</span> <a href="../enums/AnalysisResultStatus.html" class="tsd-signature-type tsd-kind-enum">AnalysisResultStatus</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#statusreason">statusReason</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/AnalysisResultStatusReason.html" class="tsd-signature-type tsd-kind-enum">AnalysisResultStatusReason</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#updatedat">updatedAt</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#version">version</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="#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><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:23</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>
|
|
@@ -31,6 +31,7 @@
|
|
|
31
31
|
<a href="#lastanalyzedat" 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>last<wbr/>Analyzed<wbr/>At</span></a>
|
|
32
32
|
<a href="#owner" 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>owner</span></a>
|
|
33
33
|
<a href="#status" 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>status</span></a>
|
|
34
|
+
<a href="#statusreason" 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>status<wbr/>Reason?</span></a>
|
|
34
35
|
<a href="#updatedat" 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>updated<wbr/>At</span></a>
|
|
35
36
|
<a href="#version" 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>version</span></a>
|
|
36
37
|
<a href="#virtualpresenceid" 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>virtual<wbr/>Presence<wbr/>Id</span></a>
|
|
@@ -44,70 +45,77 @@
|
|
|
44
45
|
<div class="tsd-comment tsd-typography"><p>Date for when the analysis result was created.</p>
|
|
45
46
|
</div><aside class="tsd-sources">
|
|
46
47
|
<ul>
|
|
47
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
48
|
+
<li>Defined in src/public/typings/analysisResult.ts:33</li></ul></aside></section>
|
|
48
49
|
<section class="tsd-panel tsd-member">
|
|
49
50
|
<h3 class="tsd-anchor-link" id="data"><code class="tsd-tag">Optional</code><span>data</span><a href="#data" 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>
|
|
50
51
|
<div class="tsd-signature"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">?:</span> <a href="AnalysisResultData.html" class="tsd-signature-type tsd-kind-interface">AnalysisResultData</a></div>
|
|
51
52
|
<div class="tsd-comment tsd-typography"><p>Structured analysis data. Populated when status is COMPLETE or PARTIAL.</p>
|
|
52
53
|
</div><aside class="tsd-sources">
|
|
53
54
|
<ul>
|
|
54
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
55
|
+
<li>Defined in src/public/typings/analysisResult.ts:30</li></ul></aside></section>
|
|
55
56
|
<section class="tsd-panel tsd-member">
|
|
56
57
|
<h3 class="tsd-anchor-link" id="dataholderidentifier"><span>data<wbr/>Holder<wbr/>Identifier</span><a href="#dataholderidentifier" 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
58
|
<div class="tsd-signature"><span class="tsd-kind-property">dataHolderIdentifier</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
58
59
|
<div class="tsd-comment tsd-typography"><p>The data holder domain that this analysis is about.</p>
|
|
59
60
|
</div><aside class="tsd-sources">
|
|
60
61
|
<ul>
|
|
61
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
62
|
+
<li>Defined in src/public/typings/analysisResult.ts:26</li></ul></aside></section>
|
|
62
63
|
<section class="tsd-panel tsd-member">
|
|
63
64
|
<h3 class="tsd-anchor-link" id="id"><span>id</span><a href="#id" 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>
|
|
64
65
|
<div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
65
66
|
<div class="tsd-comment tsd-typography"><p>Unique identifier associated with the analysis result.</p>
|
|
66
67
|
</div><aside class="tsd-sources">
|
|
67
68
|
<ul>
|
|
68
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
69
|
+
<li>Defined in src/public/typings/analysisResult.ts:24</li></ul></aside></section>
|
|
69
70
|
<section class="tsd-panel tsd-member">
|
|
70
71
|
<h3 class="tsd-anchor-link" id="lastanalyzedat"><span>last<wbr/>Analyzed<wbr/>At</span><a href="#lastanalyzedat" 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>
|
|
71
72
|
<div class="tsd-signature"><span class="tsd-kind-property">lastAnalyzedAt</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
|
|
72
73
|
<div class="tsd-comment tsd-typography"><p>Date for when the analysis was last performed.</p>
|
|
73
74
|
</div><aside class="tsd-sources">
|
|
74
75
|
<ul>
|
|
75
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
76
|
+
<li>Defined in src/public/typings/analysisResult.ts:29</li></ul></aside></section>
|
|
76
77
|
<section class="tsd-panel tsd-member">
|
|
77
78
|
<h3 class="tsd-anchor-link" id="owner"><span>owner</span><a href="#owner" 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>
|
|
78
79
|
<div class="tsd-signature"><span class="tsd-kind-property">owner</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
79
80
|
<div class="tsd-comment tsd-typography"><p>Unique identifier of the user.</p>
|
|
80
81
|
</div><aside class="tsd-sources">
|
|
81
82
|
<ul>
|
|
82
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
83
|
+
<li>Defined in src/public/typings/analysisResult.ts:31</li></ul></aside></section>
|
|
83
84
|
<section class="tsd-panel tsd-member">
|
|
84
85
|
<h3 class="tsd-anchor-link" id="status"><span>status</span><a href="#status" 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>
|
|
85
86
|
<div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">:</span> <a href="../enums/AnalysisResultStatus.html" class="tsd-signature-type tsd-kind-enum">AnalysisResultStatus</a></div>
|
|
86
87
|
<div class="tsd-comment tsd-typography"><p>Current status of the analysis.</p>
|
|
87
88
|
</div><aside class="tsd-sources">
|
|
88
89
|
<ul>
|
|
89
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
90
|
+
<li>Defined in src/public/typings/analysisResult.ts:27</li></ul></aside></section>
|
|
91
|
+
<section class="tsd-panel tsd-member">
|
|
92
|
+
<h3 class="tsd-anchor-link" id="statusreason"><code class="tsd-tag">Optional</code><span>status<wbr/>Reason</span><a href="#statusreason" 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>
|
|
93
|
+
<div class="tsd-signature"><span class="tsd-kind-property">statusReason</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/AnalysisResultStatusReason.html" class="tsd-signature-type tsd-kind-enum">AnalysisResultStatusReason</a></div>
|
|
94
|
+
<div class="tsd-comment tsd-typography"><p>Reason explaining the current status, when one applies.</p>
|
|
95
|
+
</div><aside class="tsd-sources">
|
|
96
|
+
<ul>
|
|
97
|
+
<li>Defined in src/public/typings/analysisResult.ts:28</li></ul></aside></section>
|
|
90
98
|
<section class="tsd-panel tsd-member">
|
|
91
99
|
<h3 class="tsd-anchor-link" id="updatedat"><span>updated<wbr/>At</span><a href="#updatedat" 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>
|
|
92
100
|
<div class="tsd-signature"><span class="tsd-kind-property">updatedAt</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
|
|
93
101
|
<div class="tsd-comment tsd-typography"><p>Date for when the analysis result was last updated.</p>
|
|
94
102
|
</div><aside class="tsd-sources">
|
|
95
103
|
<ul>
|
|
96
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
104
|
+
<li>Defined in src/public/typings/analysisResult.ts:34</li></ul></aside></section>
|
|
97
105
|
<section class="tsd-panel tsd-member">
|
|
98
106
|
<h3 class="tsd-anchor-link" id="version"><span>version</span><a href="#version" 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>
|
|
99
107
|
<div class="tsd-signature"><span class="tsd-kind-property">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
100
108
|
<div class="tsd-comment tsd-typography"><p>Version of this entity. Increments on update.</p>
|
|
101
109
|
</div><aside class="tsd-sources">
|
|
102
110
|
<ul>
|
|
103
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
111
|
+
<li>Defined in src/public/typings/analysisResult.ts:32</li></ul></aside></section>
|
|
104
112
|
<section class="tsd-panel tsd-member">
|
|
105
113
|
<h3 class="tsd-anchor-link" id="virtualpresenceid"><span>virtual<wbr/>Presence<wbr/>Id</span><a href="#virtualpresenceid" 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>
|
|
106
114
|
<div class="tsd-signature"><span class="tsd-kind-property">virtualPresenceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
107
115
|
<div class="tsd-comment tsd-typography"><p>The virtual presence this analysis is associated with.</p>
|
|
108
116
|
</div><aside class="tsd-sources">
|
|
109
117
|
<ul>
|
|
110
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
118
|
+
<li>Defined in src/public/typings/analysisResult.ts:25</li></ul></aside></section></section></details></div>
|
|
111
119
|
<div class="col-sidebar">
|
|
112
120
|
<div class="page-menu">
|
|
113
121
|
<div class="tsd-navigation settings">
|
|
@@ -124,7 +132,7 @@
|
|
|
124
132
|
<h3>On This Page</h3></summary>
|
|
125
133
|
<div class="tsd-accordion-details">
|
|
126
134
|
<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>
|
|
127
|
-
<div><a href="#createdat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>created<wbr/>At</span></a><a href="#data"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#dataholderidentifier"><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/>Identifier</span></a><a href="#id"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#lastanalyzedat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>last<wbr/>Analyzed<wbr/>At</span></a><a href="#owner"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>owner</span></a><a href="#status"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#updatedat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>updated<wbr/>At</span></a><a href="#version"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>version</span></a><a href="#virtualpresenceid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>virtual<wbr/>Presence<wbr/>Id</span></a></div></details></div></details></div>
|
|
135
|
+
<div><a href="#createdat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>created<wbr/>At</span></a><a href="#data"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#dataholderidentifier"><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/>Identifier</span></a><a href="#id"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#lastanalyzedat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>last<wbr/>Analyzed<wbr/>At</span></a><a href="#owner"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>owner</span></a><a href="#status"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#statusreason"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status<wbr/>Reason</span></a><a href="#updatedat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>updated<wbr/>At</span></a><a href="#version"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>version</span></a><a href="#virtualpresenceid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>virtual<wbr/>Presence<wbr/>Id</span></a></div></details></div></details></div>
|
|
128
136
|
<div class="site-menu">
|
|
129
137
|
<nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
|
|
130
138
|
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
@@ -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">AnalysisResultData</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#attribution">attribution</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="#capabilities">capabilities</a><span class="tsd-signature-symbol">:</span> <a href="CapabilitySignals.html" class="tsd-signature-type tsd-kind-interface">CapabilitySignals</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#categories">categories</a><span class="tsd-signature-symbol">:</span> <a href="CategorySignals.html" class="tsd-signature-type tsd-kind-interface">CategorySignals</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#organizationidentity">organizationIdentity</a><span class="tsd-signature-symbol">?:</span> <a href="OrganizationIdentity.html" class="tsd-signature-type tsd-kind-interface">OrganizationIdentity</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#privacyscore">privacyScore</a><span class="tsd-signature-symbol">?:</span> <a href="PrivacyScore.html" class="tsd-signature-type tsd-kind-interface">PrivacyScore</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#privacysummary">privacySummary</a><span class="tsd-signature-symbol">:</span> <a href="PrivacySummary.html" class="tsd-signature-type tsd-kind-interface">PrivacySummary</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#riskindicators">riskIndicators</a><span class="tsd-signature-symbol">:</span> <a href="RiskIndicators.html" class="tsd-signature-type tsd-kind-interface">RiskIndicators</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:116</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,28 +41,28 @@
|
|
|
41
41
|
<div class="tsd-comment tsd-typography"><p>Information describing where the analysis result is derived from.</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:123</li></ul></aside></section>
|
|
45
45
|
<section class="tsd-panel tsd-member">
|
|
46
46
|
<h3 class="tsd-anchor-link" id="capabilities"><span>capabilities</span><a href="#capabilities" 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">capabilities</span><span class="tsd-signature-symbol">:</span> <a href="CapabilitySignals.html" class="tsd-signature-type tsd-kind-interface">CapabilitySignals</a></div>
|
|
48
48
|
<div class="tsd-comment tsd-typography"><p>Action-derived capability signals.</p>
|
|
49
49
|
</div><aside class="tsd-sources">
|
|
50
50
|
<ul>
|
|
51
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
51
|
+
<li>Defined in src/public/typings/analysisResult.ts:120</li></ul></aside></section>
|
|
52
52
|
<section class="tsd-panel tsd-member">
|
|
53
53
|
<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>
|
|
54
54
|
<div class="tsd-signature"><span class="tsd-kind-property">categories</span><span class="tsd-signature-symbol">:</span> <a href="CategorySignals.html" class="tsd-signature-type tsd-kind-interface">CategorySignals</a><span class="tsd-signature-symbol">[]</span></div>
|
|
55
55
|
<div class="tsd-comment tsd-typography"><p>Per-category signal breakdown.</p>
|
|
56
56
|
</div><aside class="tsd-sources">
|
|
57
57
|
<ul>
|
|
58
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
58
|
+
<li>Defined in src/public/typings/analysisResult.ts:119</li></ul></aside></section>
|
|
59
59
|
<section class="tsd-panel tsd-member">
|
|
60
60
|
<h3 class="tsd-anchor-link" id="organizationidentity"><code class="tsd-tag">Optional</code><span>organization<wbr/>Identity</span><a href="#organizationidentity" 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>
|
|
61
61
|
<div class="tsd-signature"><span class="tsd-kind-property">organizationIdentity</span><span class="tsd-signature-symbol">?:</span> <a href="OrganizationIdentity.html" class="tsd-signature-type tsd-kind-interface">OrganizationIdentity</a></div>
|
|
62
62
|
<div class="tsd-comment tsd-typography"><p>Organization identity (brand, company, business categories).</p>
|
|
63
63
|
</div><aside class="tsd-sources">
|
|
64
64
|
<ul>
|
|
65
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
65
|
+
<li>Defined in src/public/typings/analysisResult.ts:122</li></ul></aside></section>
|
|
66
66
|
<section class="tsd-panel tsd-member">
|
|
67
67
|
<h3 class="tsd-anchor-link" id="privacyscore"><code class="tsd-tag">Optional</code><span>privacy<wbr/>Score</span><a href="#privacyscore" 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>
|
|
68
68
|
<div class="tsd-signature"><span class="tsd-kind-property">privacyScore</span><span class="tsd-signature-symbol">?:</span> <a href="PrivacyScore.html" class="tsd-signature-type tsd-kind-interface">PrivacyScore</a></div>
|
|
@@ -70,21 +70,21 @@
|
|
|
70
70
|
Undefined when scoring is disabled.</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:117</li></ul></aside></section>
|
|
74
74
|
<section class="tsd-panel tsd-member">
|
|
75
75
|
<h3 class="tsd-anchor-link" id="privacysummary"><span>privacy<wbr/>Summary</span><a href="#privacysummary" 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">privacySummary</span><span class="tsd-signature-symbol">:</span> <a href="PrivacySummary.html" class="tsd-signature-type tsd-kind-interface">PrivacySummary</a></div>
|
|
77
77
|
<div class="tsd-comment tsd-typography"><p>Concise human-readable summary of privacy findings.</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:118</li></ul></aside></section>
|
|
81
81
|
<section class="tsd-panel tsd-member">
|
|
82
82
|
<h3 class="tsd-anchor-link" id="riskindicators"><span>risk<wbr/>Indicators</span><a href="#riskindicators" 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">riskIndicators</span><span class="tsd-signature-symbol">:</span> <a href="RiskIndicators.html" class="tsd-signature-type tsd-kind-interface">RiskIndicators</a></div>
|
|
84
84
|
<div class="tsd-comment tsd-typography"><p>Aggregated risk indicators.</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:121</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">
|
|
@@ -14,9 +14,9 @@
|
|
|
14
14
|
<div class="tsd-comment tsd-typography"><p>The Sudo Platform SDK representation of a lightweight notification of an analysis result update.</p>
|
|
15
15
|
<p>AnalysisResultUpdate</p>
|
|
16
16
|
</div></section>
|
|
17
|
-
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AnalysisResultUpdate</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#createdat">createdAt</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#dataholderidentifier">dataHolderIdentifier</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="#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="#lastanalyzedat">lastAnalyzedAt</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#owner">owner</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="#status">status</a><span class="tsd-signature-symbol">:</span> <a href="../enums/AnalysisResultStatus.html" class="tsd-signature-type tsd-kind-enum">AnalysisResultStatus</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#updatedat">updatedAt</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#version">version</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="#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><aside class="tsd-sources">
|
|
17
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AnalysisResultUpdate</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#createdat">createdAt</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#dataholderidentifier">dataHolderIdentifier</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="#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="#lastanalyzedat">lastAnalyzedAt</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#owner">owner</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="#status">status</a><span class="tsd-signature-symbol">:</span> <a href="../enums/AnalysisResultStatus.html" class="tsd-signature-type tsd-kind-enum">AnalysisResultStatus</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#statusreason">statusReason</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/AnalysisResultStatusReason.html" class="tsd-signature-type tsd-kind-enum">AnalysisResultStatusReason</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#updatedat">updatedAt</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#version">version</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="#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><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:52</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>
|
|
@@ -30,6 +30,7 @@
|
|
|
30
30
|
<a href="#lastanalyzedat" 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>last<wbr/>Analyzed<wbr/>At</span></a>
|
|
31
31
|
<a href="#owner" 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>owner</span></a>
|
|
32
32
|
<a href="#status" 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>status</span></a>
|
|
33
|
+
<a href="#statusreason" 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>status<wbr/>Reason?</span></a>
|
|
33
34
|
<a href="#updatedat" 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>updated<wbr/>At</span></a>
|
|
34
35
|
<a href="#version" 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>version</span></a>
|
|
35
36
|
<a href="#virtualpresenceid" 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>virtual<wbr/>Presence<wbr/>Id</span></a>
|
|
@@ -43,63 +44,70 @@
|
|
|
43
44
|
<div class="tsd-comment tsd-typography"><p>Date for when the analysis result was created.</p>
|
|
44
45
|
</div><aside class="tsd-sources">
|
|
45
46
|
<ul>
|
|
46
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
47
|
+
<li>Defined in src/public/typings/analysisResult.ts:61</li></ul></aside></section>
|
|
47
48
|
<section class="tsd-panel tsd-member">
|
|
48
49
|
<h3 class="tsd-anchor-link" id="dataholderidentifier"><span>data<wbr/>Holder<wbr/>Identifier</span><a href="#dataholderidentifier" 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
50
|
<div class="tsd-signature"><span class="tsd-kind-property">dataHolderIdentifier</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
50
51
|
<div class="tsd-comment tsd-typography"><p>The data holder domain that this analysis is about.</p>
|
|
51
52
|
</div><aside class="tsd-sources">
|
|
52
53
|
<ul>
|
|
53
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
54
|
+
<li>Defined in src/public/typings/analysisResult.ts:55</li></ul></aside></section>
|
|
54
55
|
<section class="tsd-panel tsd-member">
|
|
55
56
|
<h3 class="tsd-anchor-link" id="id"><span>id</span><a href="#id" 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>
|
|
56
57
|
<div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
57
58
|
<div class="tsd-comment tsd-typography"><p>Unique identifier of the analysis result.</p>
|
|
58
59
|
</div><aside class="tsd-sources">
|
|
59
60
|
<ul>
|
|
60
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
61
|
+
<li>Defined in src/public/typings/analysisResult.ts:53</li></ul></aside></section>
|
|
61
62
|
<section class="tsd-panel tsd-member">
|
|
62
63
|
<h3 class="tsd-anchor-link" id="lastanalyzedat"><span>last<wbr/>Analyzed<wbr/>At</span><a href="#lastanalyzedat" 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>
|
|
63
64
|
<div class="tsd-signature"><span class="tsd-kind-property">lastAnalyzedAt</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
|
|
64
65
|
<div class="tsd-comment tsd-typography"><p>Date for when the analysis was last performed.</p>
|
|
65
66
|
</div><aside class="tsd-sources">
|
|
66
67
|
<ul>
|
|
67
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
68
|
+
<li>Defined in src/public/typings/analysisResult.ts:58</li></ul></aside></section>
|
|
68
69
|
<section class="tsd-panel tsd-member">
|
|
69
70
|
<h3 class="tsd-anchor-link" id="owner"><span>owner</span><a href="#owner" 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>
|
|
70
71
|
<div class="tsd-signature"><span class="tsd-kind-property">owner</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
71
72
|
<div class="tsd-comment tsd-typography"><p>Unique identifier of the user.</p>
|
|
72
73
|
</div><aside class="tsd-sources">
|
|
73
74
|
<ul>
|
|
74
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
75
|
+
<li>Defined in src/public/typings/analysisResult.ts:59</li></ul></aside></section>
|
|
75
76
|
<section class="tsd-panel tsd-member">
|
|
76
77
|
<h3 class="tsd-anchor-link" id="status"><span>status</span><a href="#status" 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>
|
|
77
78
|
<div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">:</span> <a href="../enums/AnalysisResultStatus.html" class="tsd-signature-type tsd-kind-enum">AnalysisResultStatus</a></div>
|
|
78
79
|
<div class="tsd-comment tsd-typography"><p>Current status of the analysis.</p>
|
|
79
80
|
</div><aside class="tsd-sources">
|
|
80
81
|
<ul>
|
|
81
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
82
|
+
<li>Defined in src/public/typings/analysisResult.ts:56</li></ul></aside></section>
|
|
83
|
+
<section class="tsd-panel tsd-member">
|
|
84
|
+
<h3 class="tsd-anchor-link" id="statusreason"><code class="tsd-tag">Optional</code><span>status<wbr/>Reason</span><a href="#statusreason" 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>
|
|
85
|
+
<div class="tsd-signature"><span class="tsd-kind-property">statusReason</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/AnalysisResultStatusReason.html" class="tsd-signature-type tsd-kind-enum">AnalysisResultStatusReason</a></div>
|
|
86
|
+
<div class="tsd-comment tsd-typography"><p>Reason explaining the current status, when one applies.</p>
|
|
87
|
+
</div><aside class="tsd-sources">
|
|
88
|
+
<ul>
|
|
89
|
+
<li>Defined in src/public/typings/analysisResult.ts:57</li></ul></aside></section>
|
|
82
90
|
<section class="tsd-panel tsd-member">
|
|
83
91
|
<h3 class="tsd-anchor-link" id="updatedat"><span>updated<wbr/>At</span><a href="#updatedat" 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>
|
|
84
92
|
<div class="tsd-signature"><span class="tsd-kind-property">updatedAt</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
|
|
85
93
|
<div class="tsd-comment tsd-typography"><p>Date for when the analysis result was last updated.</p>
|
|
86
94
|
</div><aside class="tsd-sources">
|
|
87
95
|
<ul>
|
|
88
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
96
|
+
<li>Defined in src/public/typings/analysisResult.ts:62</li></ul></aside></section>
|
|
89
97
|
<section class="tsd-panel tsd-member">
|
|
90
98
|
<h3 class="tsd-anchor-link" id="version"><span>version</span><a href="#version" 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>
|
|
91
99
|
<div class="tsd-signature"><span class="tsd-kind-property">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
92
100
|
<div class="tsd-comment tsd-typography"><p>Version of this entity. Increments on update.</p>
|
|
93
101
|
</div><aside class="tsd-sources">
|
|
94
102
|
<ul>
|
|
95
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
103
|
+
<li>Defined in src/public/typings/analysisResult.ts:60</li></ul></aside></section>
|
|
96
104
|
<section class="tsd-panel tsd-member">
|
|
97
105
|
<h3 class="tsd-anchor-link" id="virtualpresenceid"><span>virtual<wbr/>Presence<wbr/>Id</span><a href="#virtualpresenceid" 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>
|
|
98
106
|
<div class="tsd-signature"><span class="tsd-kind-property">virtualPresenceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
99
107
|
<div class="tsd-comment tsd-typography"><p>The virtual presence this analysis is associated with.</p>
|
|
100
108
|
</div><aside class="tsd-sources">
|
|
101
109
|
<ul>
|
|
102
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
110
|
+
<li>Defined in src/public/typings/analysisResult.ts:54</li></ul></aside></section></section></details></div>
|
|
103
111
|
<div class="col-sidebar">
|
|
104
112
|
<div class="page-menu">
|
|
105
113
|
<div class="tsd-navigation settings">
|
|
@@ -116,7 +124,7 @@
|
|
|
116
124
|
<h3>On This Page</h3></summary>
|
|
117
125
|
<div class="tsd-accordion-details">
|
|
118
126
|
<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>
|
|
119
|
-
<div><a href="#createdat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>created<wbr/>At</span></a><a href="#dataholderidentifier"><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/>Identifier</span></a><a href="#id"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#lastanalyzedat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>last<wbr/>Analyzed<wbr/>At</span></a><a href="#owner"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>owner</span></a><a href="#status"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#updatedat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>updated<wbr/>At</span></a><a href="#version"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>version</span></a><a href="#virtualpresenceid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>virtual<wbr/>Presence<wbr/>Id</span></a></div></details></div></details></div>
|
|
127
|
+
<div><a href="#createdat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>created<wbr/>At</span></a><a href="#dataholderidentifier"><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/>Identifier</span></a><a href="#id"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#lastanalyzedat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>last<wbr/>Analyzed<wbr/>At</span></a><a href="#owner"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>owner</span></a><a href="#status"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#statusreason"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status<wbr/>Reason</span></a><a href="#updatedat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>updated<wbr/>At</span></a><a href="#version"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>version</span></a><a href="#virtualpresenceid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>virtual<wbr/>Presence<wbr/>Id</span></a></div></details></div></details></div>
|
|
120
128
|
<div class="site-menu">
|
|
121
129
|
<nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
|
|
122
130
|
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|