@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.
Files changed (86) hide show
  1. package/cjs/gen/graphqlTypes.js +356 -7
  2. package/cjs/private/data/action/defaultActionService.js +8 -0
  3. package/cjs/private/data/action/transformer/actionIntentTransformer.js +32 -0
  4. package/cjs/private/data/action/transformer/availableActionTransformer.js +8 -0
  5. package/cjs/private/data/analysis-result/transformer/capabilitySignalsTransformer.js +2 -0
  6. package/cjs/private/data/common/apiClient.js +21 -0
  7. package/cjs/private/data/data-holder/transformer/dataHolderTransformer.js +8 -1
  8. package/cjs/private/data/virtual-presence/defaultVirtualPresenceService.js +4 -0
  9. package/cjs/private/domain/entities/action/actionEntity.js +14 -0
  10. package/cjs/private/domain/use-cases/action/listActionsForDataHolderUseCase.js +26 -0
  11. package/cjs/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithRefreshTokenUseCase.js +4 -1
  12. package/cjs/private/domain/use-cases/virtual-presence/refreshVirtualPresenceStateUseCase.js +25 -0
  13. package/cjs/public/defaultSudoPrivacyInteractionClient.js +24 -1
  14. package/cjs/public/typings/action.js +14 -0
  15. package/docs/assets/hierarchy.js +1 -1
  16. package/docs/assets/navigation.js +1 -1
  17. package/docs/assets/search.js +1 -1
  18. package/docs/classes/DefaultSudoPrivacyInteractionClient.html +77 -29
  19. package/docs/enums/ActionFulfilmentMethod.html +3 -3
  20. package/docs/enums/ActionIntent.html +31 -7
  21. package/docs/enums/ActionOrigin.html +5 -5
  22. package/docs/enums/ActionStatus.html +9 -9
  23. package/docs/enums/DataHolderProtectionState.html +6 -6
  24. package/docs/enums/OrganizationCategory.html +31 -31
  25. package/docs/enums/RelationshipProvider.html +3 -3
  26. package/docs/hierarchy.html +7 -6
  27. package/docs/interfaces/Action.html +15 -15
  28. package/docs/interfaces/ActionContact.html +4 -4
  29. package/docs/interfaces/AssistedEmailTemplate.html +3 -3
  30. package/docs/interfaces/AssistedPayload.html +8 -8
  31. package/docs/interfaces/AvailableAction.html +20 -9
  32. package/docs/interfaces/CapabilitySignals.html +20 -12
  33. package/docs/interfaces/ConnectVirtualPresenceWithRefreshTokenInput.html +36 -21
  34. package/docs/interfaces/DataHolder.html +62 -42
  35. package/docs/interfaces/DataHolderScanSummary.html +14 -14
  36. package/docs/interfaces/InitiateActionInput.html +4 -4
  37. package/docs/interfaces/ListActionsForDataHolderInput.html +85 -0
  38. package/docs/interfaces/ListAnalysisResultsInput.html +1 -1
  39. package/docs/interfaces/ListAvailableActionsInput.html +14 -4
  40. package/docs/interfaces/ListDataHolderScanSummariesInput.html +1 -1
  41. package/docs/interfaces/ListDataHoldersInput.html +1 -1
  42. package/docs/interfaces/ListVirtualPresencesInput.html +2 -2
  43. package/docs/interfaces/OrganizationIdentity.html +5 -5
  44. package/docs/interfaces/Pagination.html +2 -1
  45. package/docs/interfaces/RescanVirtualPresenceInput.html +3 -3
  46. package/docs/interfaces/RiskIndicators.html +8 -8
  47. package/docs/interfaces/ScanOptions.html +6 -6
  48. package/docs/interfaces/SudoPrivacyInteractionClient.html +75 -29
  49. package/docs/modules.html +2 -2
  50. package/docs/types/SudoPrivacyInteractionClientOptions.html +2 -2
  51. package/lib/gen/graphqlTypes.js +355 -6
  52. package/lib/private/data/action/defaultActionService.js +8 -0
  53. package/lib/private/data/action/transformer/actionIntentTransformer.js +32 -0
  54. package/lib/private/data/action/transformer/availableActionTransformer.js +8 -0
  55. package/lib/private/data/analysis-result/transformer/capabilitySignalsTransformer.js +2 -0
  56. package/lib/private/data/common/apiClient.js +22 -1
  57. package/lib/private/data/data-holder/transformer/dataHolderTransformer.js +8 -1
  58. package/lib/private/data/virtual-presence/defaultVirtualPresenceService.js +4 -0
  59. package/lib/private/domain/entities/action/actionEntity.js +14 -0
  60. package/lib/private/domain/use-cases/action/listActionsForDataHolderUseCase.js +22 -0
  61. package/lib/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithRefreshTokenUseCase.js +4 -1
  62. package/lib/private/domain/use-cases/virtual-presence/refreshVirtualPresenceStateUseCase.js +21 -0
  63. package/lib/public/defaultSudoPrivacyInteractionClient.js +24 -1
  64. package/lib/public/typings/action.js +14 -0
  65. package/package.json +6 -1
  66. package/types/gen/graphqlTypes.d.ts +90 -8
  67. package/types/gen/schema-types.d.ts +41 -5
  68. package/types/private/data/action/defaultActionService.d.ts +2 -1
  69. package/types/private/data/action/transformer/availableActionTransformer.d.ts +1 -0
  70. package/types/private/data/common/apiClient.d.ts +8 -1
  71. package/types/private/data/virtual-presence/defaultVirtualPresenceService.d.ts +1 -0
  72. package/types/private/domain/entities/action/actionEntity.d.ts +18 -0
  73. package/types/private/domain/entities/action/actionService.d.ts +36 -0
  74. package/types/private/domain/entities/analysis-result/analysisResultEntity.d.ts +2 -0
  75. package/types/private/domain/entities/data-holder/dataHolderEntity.d.ts +5 -1
  76. package/types/private/domain/entities/virtual-presence/virtualPresenceService.d.ts +13 -3
  77. package/types/private/domain/use-cases/action/listActionsForDataHolderUseCase.d.ts +16 -0
  78. package/types/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithRefreshTokenUseCase.d.ts +2 -0
  79. package/types/private/domain/use-cases/virtual-presence/refreshVirtualPresenceStateUseCase.d.ts +16 -0
  80. package/types/public/defaultSudoPrivacyInteractionClient.d.ts +3 -1
  81. package/types/public/inputs/action.d.ts +16 -0
  82. package/types/public/inputs/virtualPresence.d.ts +10 -1
  83. package/types/public/sudoPrivacyInteractionClient.d.ts +23 -1
  84. package/types/public/typings/action.d.ts +19 -0
  85. package/types/public/typings/analysisResult.d.ts +2 -0
  86. package/types/public/typings/dataHolder.d.ts +9 -1
@@ -9,14 +9,18 @@
9
9
  <div class="tsd-page-title">
10
10
  <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
11
  <li><a href="" aria-current="page">ConnectVirtualPresenceWithRefreshTokenInput</a></li></ul>
12
- <h1>Interface ConnectVirtualPresenceWithRefreshTokenInput</h1></div>
12
+ <h1 class="deprecated">Interface ConnectVirtualPresenceWithRefreshTokenInput</h1></div>
13
13
  <section class="tsd-panel tsd-comment">
14
14
  <div class="tsd-comment tsd-typography"><p>Properties required to connect a virtual presence with a refresh token.</p>
15
15
  <p>ConnectVirtualPresenceWithRefreshTokenInput</p>
16
- </div></section>
17
- <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ConnectVirtualPresenceWithRefreshTokenInput</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#expiresinepochms">expiresInEpochMs</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="#provideridentity">providerIdentity</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="#refreshtoken">refreshToken</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="#relationshipprovider">relationshipProvider</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/RelationshipProvider.html" class="tsd-signature-type tsd-kind-enum">RelationshipProvider</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#scopes">scopes</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/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
16
+ </div>
17
+ <div class="tsd-comment tsd-typography">
18
+ <div class="tsd-tag-deprecated">
19
+ <h4 class="tsd-anchor-link" id="deprecated">Deprecated<a href="#deprecated" 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></h4><p>Use <a href="#expiresatepochms" class="tsd-kind-property">ConnectVirtualPresenceWithRefreshTokenInput.expiresAtEpochMs</a> instead.</p>
20
+ </div></div></section>
21
+ <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ConnectVirtualPresenceWithRefreshTokenInput</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#expiresatepochms">expiresAtEpochMs</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="#expiresinepochms">expiresInEpochMs</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="#provideridentity">providerIdentity</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="#refreshtoken">refreshToken</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="#relationshipprovider">relationshipProvider</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/RelationshipProvider.html" class="tsd-signature-type tsd-kind-enum">RelationshipProvider</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#scopes">scopes</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/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
18
22
  <ul>
19
- <li>Defined in src/public/inputs/virtualPresence.ts:36</li></ul></aside>
23
+ <li>Defined in src/public/inputs/virtualPresence.ts:41</li></ul></aside>
20
24
  <section class="tsd-panel-group tsd-index-group">
21
25
  <section class="tsd-panel tsd-index-panel">
22
26
  <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>
@@ -24,51 +28,62 @@
24
28
  <div class="tsd-accordion-details">
25
29
  <section class="tsd-index-section">
26
30
  <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
- <div class="tsd-index-list"><a href="#expiresinepochms" 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>expires<wbr/>In<wbr/>Epoch<wbr/>Ms?</span></a>
28
- <a href="#provideridentity" 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>provider<wbr/>Identity</span></a>
29
- <a href="#refreshtoken" 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>refresh<wbr/>Token</span></a>
30
- <a href="#relationshipprovider" 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>relationship<wbr/>Provider?</span></a>
31
- <a href="#scopes" 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>scopes?</span></a>
31
+ <div class="tsd-index-list"><a href="#expiresatepochms" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>expires<wbr/>At<wbr/>Epoch<wbr/>Ms?</span></a>
32
+ <a href="#expiresinepochms" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>expires<wbr/>In<wbr/>Epoch<wbr/>Ms?</span></a>
33
+ <a href="#provideridentity" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>provider<wbr/>Identity</span></a>
34
+ <a href="#refreshtoken" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>refresh<wbr/>Token</span></a>
35
+ <a href="#relationshipprovider" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>relationship<wbr/>Provider?</span></a>
36
+ <a href="#scopes" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scopes?</span></a>
32
37
  </div></section></div></details></section></section>
33
38
  <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>
34
39
  <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
40
  <section>
36
41
  <section class="tsd-panel tsd-member">
37
- <h3 class="tsd-anchor-link" id="expiresinepochms"><code class="tsd-tag">Optional</code><span>expires<wbr/>In<wbr/>Epoch<wbr/>Ms</span><a href="#expiresinepochms" 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
+ <h3 class="tsd-anchor-link" id="expiresatepochms"><code class="tsd-tag">Optional</code><span class="deprecated">expires<wbr/>At<wbr/>Epoch<wbr/>Ms</span><a href="#expiresatepochms" 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
+ <div class="tsd-signature"><span class="tsd-kind-property">expiresAtEpochMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
44
+ <div class="tsd-comment tsd-typography"><p>Optional absolute expiry of the credential in milliseconds
45
+ since epoch. Takes precedence over <code>expiresInEpochMs</code> when both are provided. Defaults to one
46
+ year after the request when neither is provided.</p>
47
+ </div><aside class="tsd-sources">
48
+ <ul>
49
+ <li>Defined in src/public/inputs/virtualPresence.ts:45</li></ul></aside></section>
50
+ <section class="tsd-panel tsd-member">
51
+ <h3 class="tsd-anchor-link" id="expiresinepochms"><code class="tsd-tag">Optional</code><span class="deprecated">expires<wbr/>In<wbr/>Epoch<wbr/>Ms</span><a href="#expiresinepochms" 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>
38
52
  <div class="tsd-signature"><span class="tsd-kind-property">expiresInEpochMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
39
- <div class="tsd-comment tsd-typography"><p>Optional expiration time in milliseconds since epoch.</p>
53
+ <div class="tsd-comment tsd-typography"><p>Optional relative expiry: the number of milliseconds after
54
+ the request at which the credential expires.</p>
40
55
  </div><aside class="tsd-sources">
41
56
  <ul>
42
- <li>Defined in src/public/inputs/virtualPresence.ts:40</li></ul></aside></section>
57
+ <li>Defined in src/public/inputs/virtualPresence.ts:49</li></ul></aside></section>
43
58
  <section class="tsd-panel tsd-member">
44
- <h3 class="tsd-anchor-link" id="provideridentity"><span>provider<wbr/>Identity</span><a href="#provideridentity" 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
+ <h3 class="tsd-anchor-link" id="provideridentity"><span class="deprecated">provider<wbr/>Identity</span><a href="#provideridentity" 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
60
  <div class="tsd-signature"><span class="tsd-kind-property">providerIdentity</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
46
61
  <div class="tsd-comment tsd-typography"><p>The identity associated with the provider.</p>
47
62
  </div><aside class="tsd-sources">
48
63
  <ul>
49
- <li>Defined in src/public/inputs/virtualPresence.ts:38</li></ul></aside></section>
64
+ <li>Defined in src/public/inputs/virtualPresence.ts:43</li></ul></aside></section>
50
65
  <section class="tsd-panel tsd-member">
51
- <h3 class="tsd-anchor-link" id="refreshtoken"><span>refresh<wbr/>Token</span><a href="#refreshtoken" 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
+ <h3 class="tsd-anchor-link" id="refreshtoken"><span class="deprecated">refresh<wbr/>Token</span><a href="#refreshtoken" 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
67
  <div class="tsd-signature"><span class="tsd-kind-property">refreshToken</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
53
68
  <div class="tsd-comment tsd-typography"><p>The refresh token value.</p>
54
69
  </div><aside class="tsd-sources">
55
70
  <ul>
56
- <li>Defined in src/public/inputs/virtualPresence.ts:37</li></ul></aside></section>
71
+ <li>Defined in src/public/inputs/virtualPresence.ts:42</li></ul></aside></section>
57
72
  <section class="tsd-panel tsd-member">
58
- <h3 class="tsd-anchor-link" id="relationshipprovider"><code class="tsd-tag">Optional</code><span>relationship<wbr/>Provider</span><a href="#relationshipprovider" 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>
73
+ <h3 class="tsd-anchor-link" id="relationshipprovider"><code class="tsd-tag">Optional</code><span class="deprecated">relationship<wbr/>Provider</span><a href="#relationshipprovider" 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
74
  <div class="tsd-signature"><span class="tsd-kind-property">relationshipProvider</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/RelationshipProvider.html" class="tsd-signature-type tsd-kind-enum">RelationshipProvider</a></div>
60
75
  <div class="tsd-comment tsd-typography"><p>The relationship provider
61
76
  to associate with the connection.</p>
62
77
  </div><aside class="tsd-sources">
63
78
  <ul>
64
- <li>Defined in src/public/inputs/virtualPresence.ts:41</li></ul></aside></section>
79
+ <li>Defined in src/public/inputs/virtualPresence.ts:50</li></ul></aside></section>
65
80
  <section class="tsd-panel tsd-member">
66
- <h3 class="tsd-anchor-link" id="scopes"><code class="tsd-tag">Optional</code><span>scopes</span><a href="#scopes" 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>
81
+ <h3 class="tsd-anchor-link" id="scopes"><code class="tsd-tag">Optional</code><span class="deprecated">scopes</span><a href="#scopes" 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>
67
82
  <div class="tsd-signature"><span class="tsd-kind-property">scopes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
68
83
  <div class="tsd-comment tsd-typography"><p>Optional OAuth scopes associated with the token.</p>
69
84
  </div><aside class="tsd-sources">
70
85
  <ul>
71
- <li>Defined in src/public/inputs/virtualPresence.ts:39</li></ul></aside></section></section></details></div>
86
+ <li>Defined in src/public/inputs/virtualPresence.ts:44</li></ul></aside></section></section></details></div>
72
87
  <div class="col-sidebar">
73
88
  <div class="page-menu">
74
89
  <div class="tsd-navigation settings">
@@ -85,7 +100,7 @@ to associate with the connection.</p>
85
100
  <h3>On This Page</h3></summary>
86
101
  <div class="tsd-accordion-details">
87
102
  <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>
88
- <div><a href="#expiresinepochms"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>expires<wbr/>In<wbr/>Epoch<wbr/>Ms</span></a><a href="#provideridentity"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>provider<wbr/>Identity</span></a><a href="#refreshtoken"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>refresh<wbr/>Token</span></a><a href="#relationshipprovider"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>relationship<wbr/>Provider</span></a><a href="#scopes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scopes</span></a></div></details></div></details></div>
103
+ <div><a href="#expiresatepochms"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>expires<wbr/>At<wbr/>Epoch<wbr/>Ms</span></a><a href="#expiresinepochms"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>expires<wbr/>In<wbr/>Epoch<wbr/>Ms</span></a><a href="#provideridentity"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>provider<wbr/>Identity</span></a><a href="#refreshtoken"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>refresh<wbr/>Token</span></a><a href="#relationshipprovider"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>relationship<wbr/>Provider</span></a><a href="#scopes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scopes</span></a></div></details></div></details></div>
89
104
  <div class="site-menu">
90
105
  <nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
91
106
  <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
@@ -9,15 +9,19 @@
9
9
  <div class="tsd-page-title">
10
10
  <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
11
  <li><a href="" aria-current="page">DataHolder</a></li></ul>
12
- <h1>Interface DataHolder</h1></div>
12
+ <h1 class="deprecated">Interface DataHolder</h1></div>
13
13
  <section class="tsd-panel tsd-comment">
14
14
  <div class="tsd-comment tsd-typography"><p>The Sudo Platform SDK representation of a data holder.</p>
15
15
  <p>A data holder is an organization that holds data associated with a user's virtual presence.</p>
16
16
  <p>DataHolder</p>
17
- </div></section>
18
- <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">DataHolder</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#complianceconcern">complianceConcern</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</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="#domainname">domainName</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="#latestscansummary">latestScanSummary</a><span class="tsd-signature-symbol">?:</span> <a href="DataHolderScanSummary.html" class="tsd-signature-type tsd-kind-interface">DataHolderScanSummary</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#mostrecentinteractionat">mostRecentInteractionAt</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="#name">name</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="#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="#protectionstate">protectionState</a><span class="tsd-signature-symbol">:</span> <a href="../enums/DataHolderProtectionState.html" class="tsd-signature-type tsd-kind-enum">DataHolderProtectionState</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>
18
+ <div class="tsd-comment tsd-typography">
19
+ <div class="tsd-tag-deprecated">
20
+ <h4 class="tsd-anchor-link" id="deprecated">Deprecated<a href="#deprecated" 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></h4><p>Use <a href="#mostrecentinboundcontactat" class="tsd-kind-property">DataHolder.mostRecentInboundContactAt</a> instead.</p>
21
+ </div></div></section>
22
+ <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">DataHolder</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#complianceconcern">complianceConcern</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</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="#domainname">domainName</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="#firstinboundcontactat">firstInboundContactAt</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="#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="#latestscansummary">latestScanSummary</a><span class="tsd-signature-symbol">?:</span> <a href="DataHolderScanSummary.html" class="tsd-signature-type tsd-kind-interface">DataHolderScanSummary</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#mostrecentinboundcontactat">mostRecentInboundContactAt</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="#mostrecentinteractionat">mostRecentInteractionAt</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="#name">name</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="#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="#protectionstate">protectionState</a><span class="tsd-signature-symbol">:</span> <a href="../enums/DataHolderProtectionState.html" class="tsd-signature-type tsd-kind-enum">DataHolderProtectionState</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">
19
23
  <ul>
20
- <li>Defined in src/public/typings/dataHolder.ts:28</li></ul></aside>
24
+ <li>Defined in src/public/typings/dataHolder.ts:31</li></ul></aside>
21
25
  <section class="tsd-panel-group tsd-index-group">
22
26
  <section class="tsd-panel tsd-index-panel">
23
27
  <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,108 +29,124 @@
25
29
  <div class="tsd-accordion-details">
26
30
  <section class="tsd-index-section">
27
31
  <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>
28
- <div class="tsd-index-list"><a href="#complianceconcern" 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>compliance<wbr/>Concern</span></a>
29
- <a href="#createdat" 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>created<wbr/>At</span></a>
30
- <a href="#domainname" 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>domain<wbr/>Name</span></a>
31
- <a href="#id" 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>id</span></a>
32
- <a href="#latestscansummary" 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>latest<wbr/>Scan<wbr/>Summary?</span></a>
33
- <a href="#mostrecentinteractionat" 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>most<wbr/>Recent<wbr/>Interaction<wbr/>At</span></a>
34
- <a href="#name" 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>name</span></a>
35
- <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>
36
- <a href="#protectionstate" 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>protection<wbr/>State</span></a>
37
- <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>
38
- <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>
39
- <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>
32
+ <div class="tsd-index-list"><a href="#complianceconcern" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>compliance<wbr/>Concern</span></a>
33
+ <a href="#createdat" class="tsd-index-link deprecated"><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>
34
+ <a href="#domainname" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>domain<wbr/>Name</span></a>
35
+ <a href="#firstinboundcontactat" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>first<wbr/>Inbound<wbr/>Contact<wbr/>At</span></a>
36
+ <a href="#id" class="tsd-index-link deprecated"><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>
37
+ <a href="#latestscansummary" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>latest<wbr/>Scan<wbr/>Summary?</span></a>
38
+ <a href="#mostrecentinboundcontactat" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>most<wbr/>Recent<wbr/>Inbound<wbr/>Contact<wbr/>At</span></a>
39
+ <a href="#mostrecentinteractionat" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>most<wbr/>Recent<wbr/>Interaction<wbr/>At</span></a>
40
+ <a href="#name" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a>
41
+ <a href="#owner" class="tsd-index-link deprecated"><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>
42
+ <a href="#protectionstate" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>protection<wbr/>State</span></a>
43
+ <a href="#updatedat" class="tsd-index-link deprecated"><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>
44
+ <a href="#version" class="tsd-index-link deprecated"><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>
45
+ <a href="#virtualpresenceid" class="tsd-index-link deprecated"><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>
40
46
  </div></section></div></details></section></section>
41
47
  <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>
42
48
  <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>
43
49
  <section>
44
50
  <section class="tsd-panel tsd-member">
45
- <h3 class="tsd-anchor-link" id="complianceconcern"><span>compliance<wbr/>Concern</span><a href="#complianceconcern" 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
+ <h3 class="tsd-anchor-link" id="complianceconcern"><span class="deprecated">compliance<wbr/>Concern</span><a href="#complianceconcern" 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>
46
52
  <div class="tsd-signature"><span class="tsd-kind-property">complianceConcern</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
47
53
  <div class="tsd-comment tsd-typography"><p>Whether there is a compliance concern.</p>
48
54
  </div><aside class="tsd-sources">
49
55
  <ul>
50
- <li>Defined in src/public/typings/dataHolder.ts:35</li></ul></aside></section>
56
+ <li>Defined in src/public/typings/dataHolder.ts:38</li></ul></aside></section>
51
57
  <section class="tsd-panel tsd-member">
52
- <h3 class="tsd-anchor-link" id="createdat"><span>created<wbr/>At</span><a href="#createdat" 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
+ <h3 class="tsd-anchor-link" id="createdat"><span class="deprecated">created<wbr/>At</span><a href="#createdat" 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>
53
59
  <div class="tsd-signature"><span class="tsd-kind-property">createdAt</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
54
60
  <div class="tsd-comment tsd-typography"><p>Date for when the data holder was created.</p>
55
61
  </div><aside class="tsd-sources">
56
62
  <ul>
57
- <li>Defined in src/public/typings/dataHolder.ts:38</li></ul></aside></section>
63
+ <li>Defined in src/public/typings/dataHolder.ts:46</li></ul></aside></section>
58
64
  <section class="tsd-panel tsd-member">
59
- <h3 class="tsd-anchor-link" id="domainname"><span>domain<wbr/>Name</span><a href="#domainname" 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>
65
+ <h3 class="tsd-anchor-link" id="domainname"><span class="deprecated">domain<wbr/>Name</span><a href="#domainname" 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>
60
66
  <div class="tsd-signature"><span class="tsd-kind-property">domainName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
61
67
  <div class="tsd-comment tsd-typography"><p>Domain name of the data holder.</p>
62
68
  </div><aside class="tsd-sources">
63
69
  <ul>
64
- <li>Defined in src/public/typings/dataHolder.ts:32</li></ul></aside></section>
70
+ <li>Defined in src/public/typings/dataHolder.ts:35</li></ul></aside></section>
65
71
  <section class="tsd-panel tsd-member">
66
- <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>
72
+ <h3 class="tsd-anchor-link" id="firstinboundcontactat"><span class="deprecated">first<wbr/>Inbound<wbr/>Contact<wbr/>At</span><a href="#firstinboundcontactat" 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>
73
+ <div class="tsd-signature"><span class="tsd-kind-property">firstInboundContactAt</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
74
+ <div class="tsd-comment tsd-typography"><p>Date of the earliest observed contact from the data holder.</p>
75
+ </div><aside class="tsd-sources">
76
+ <ul>
77
+ <li>Defined in src/public/typings/dataHolder.ts:44</li></ul></aside></section>
78
+ <section class="tsd-panel tsd-member">
79
+ <h3 class="tsd-anchor-link" id="id"><span class="deprecated">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>
67
80
  <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>
68
81
  <div class="tsd-comment tsd-typography"><p>Unique identifier associated with the data holder.</p>
69
82
  </div><aside class="tsd-sources">
70
83
  <ul>
71
- <li>Defined in src/public/typings/dataHolder.ts:29</li></ul></aside></section>
84
+ <li>Defined in src/public/typings/dataHolder.ts:32</li></ul></aside></section>
72
85
  <section class="tsd-panel tsd-member">
73
- <h3 class="tsd-anchor-link" id="latestscansummary"><code class="tsd-tag">Optional</code><span>latest<wbr/>Scan<wbr/>Summary</span><a href="#latestscansummary" 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>
86
+ <h3 class="tsd-anchor-link" id="latestscansummary"><code class="tsd-tag">Optional</code><span class="deprecated">latest<wbr/>Scan<wbr/>Summary</span><a href="#latestscansummary" 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>
74
87
  <div class="tsd-signature"><span class="tsd-kind-property">latestScanSummary</span><span class="tsd-signature-symbol">?:</span> <a href="DataHolderScanSummary.html" class="tsd-signature-type tsd-kind-interface">DataHolderScanSummary</a></div>
75
88
  <div class="tsd-comment tsd-typography"><p>The most recent scan summary for this
76
89
  data holder, when requested via <code>getDataHolder</code>. Undefined when not requested or when the
77
90
  data holder has no scan summaries.</p>
78
91
  </div><aside class="tsd-sources">
79
92
  <ul>
80
- <li>Defined in src/public/typings/dataHolder.ts:40</li></ul></aside></section>
93
+ <li>Defined in src/public/typings/dataHolder.ts:48</li></ul></aside></section>
81
94
  <section class="tsd-panel tsd-member">
82
- <h3 class="tsd-anchor-link" id="mostrecentinteractionat"><span>most<wbr/>Recent<wbr/>Interaction<wbr/>At</span><a href="#mostrecentinteractionat" 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>
95
+ <h3 class="tsd-anchor-link" id="mostrecentinboundcontactat"><span class="deprecated">most<wbr/>Recent<wbr/>Inbound<wbr/>Contact<wbr/>At</span><a href="#mostrecentinboundcontactat" 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>
96
+ <div class="tsd-signature"><span class="tsd-kind-property">mostRecentInboundContactAt</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
97
+ <div class="tsd-comment tsd-typography"><p>Date of the most recent inbound contact from the data holder.</p>
98
+ </div><aside class="tsd-sources">
99
+ <ul>
100
+ <li>Defined in src/public/typings/dataHolder.ts:43</li></ul></aside></section>
101
+ <section class="tsd-panel tsd-member">
102
+ <h3 class="tsd-anchor-link" id="mostrecentinteractionat"><span class="deprecated">most<wbr/>Recent<wbr/>Interaction<wbr/>At</span><a href="#mostrecentinteractionat" 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
103
  <div class="tsd-signature"><span class="tsd-kind-property">mostRecentInteractionAt</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
84
- <div class="tsd-comment tsd-typography"><p>Date of the most recent interaction.</p>
104
+ <div class="tsd-comment tsd-typography"><p>Date of the most recent inbound contact from the data holder.</p>
85
105
  </div><aside class="tsd-sources">
86
106
  <ul>
87
- <li>Defined in src/public/typings/dataHolder.ts:36</li></ul></aside></section>
107
+ <li>Defined in src/public/typings/dataHolder.ts:42</li></ul></aside></section>
88
108
  <section class="tsd-panel tsd-member">
89
- <h3 class="tsd-anchor-link" id="name"><span>name</span><a href="#name" 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>
109
+ <h3 class="tsd-anchor-link" id="name"><span class="deprecated">name</span><a href="#name" 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>
90
110
  <div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
91
111
  <div class="tsd-comment tsd-typography"><p>Display name of the data holder.</p>
92
112
  </div><aside class="tsd-sources">
93
113
  <ul>
94
- <li>Defined in src/public/typings/dataHolder.ts:33</li></ul></aside></section>
114
+ <li>Defined in src/public/typings/dataHolder.ts:36</li></ul></aside></section>
95
115
  <section class="tsd-panel tsd-member">
96
- <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>
116
+ <h3 class="tsd-anchor-link" id="owner"><span class="deprecated">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>
97
117
  <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>
98
118
  <div class="tsd-comment tsd-typography"><p>Unique identifier of the user.</p>
99
119
  </div><aside class="tsd-sources">
100
120
  <ul>
101
- <li>Defined in src/public/typings/dataHolder.ts:30</li></ul></aside></section>
121
+ <li>Defined in src/public/typings/dataHolder.ts:33</li></ul></aside></section>
102
122
  <section class="tsd-panel tsd-member">
103
- <h3 class="tsd-anchor-link" id="protectionstate"><span>protection<wbr/>State</span><a href="#protectionstate" 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>
123
+ <h3 class="tsd-anchor-link" id="protectionstate"><span class="deprecated">protection<wbr/>State</span><a href="#protectionstate" 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>
104
124
  <div class="tsd-signature"><span class="tsd-kind-property">protectionState</span><span class="tsd-signature-symbol">:</span> <a href="../enums/DataHolderProtectionState.html" class="tsd-signature-type tsd-kind-enum">DataHolderProtectionState</a></div>
105
125
  <div class="tsd-comment tsd-typography"><p>Current protection state.</p>
106
126
  </div><aside class="tsd-sources">
107
127
  <ul>
108
- <li>Defined in src/public/typings/dataHolder.ts:34</li></ul></aside></section>
128
+ <li>Defined in src/public/typings/dataHolder.ts:37</li></ul></aside></section>
109
129
  <section class="tsd-panel tsd-member">
110
- <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>
130
+ <h3 class="tsd-anchor-link" id="updatedat"><span class="deprecated">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>
111
131
  <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>
112
132
  <div class="tsd-comment tsd-typography"><p>Date for when the data holder was last updated.</p>
113
133
  </div><aside class="tsd-sources">
114
134
  <ul>
115
- <li>Defined in src/public/typings/dataHolder.ts:39</li></ul></aside></section>
135
+ <li>Defined in src/public/typings/dataHolder.ts:47</li></ul></aside></section>
116
136
  <section class="tsd-panel tsd-member">
117
- <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>
137
+ <h3 class="tsd-anchor-link" id="version"><span class="deprecated">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>
118
138
  <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>
119
139
  <div class="tsd-comment tsd-typography"><p>Version of this entity. Increments on update.</p>
120
140
  </div><aside class="tsd-sources">
121
141
  <ul>
122
- <li>Defined in src/public/typings/dataHolder.ts:37</li></ul></aside></section>
142
+ <li>Defined in src/public/typings/dataHolder.ts:45</li></ul></aside></section>
123
143
  <section class="tsd-panel tsd-member">
124
- <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>
144
+ <h3 class="tsd-anchor-link" id="virtualpresenceid"><span class="deprecated">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>
125
145
  <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>
126
146
  <div class="tsd-comment tsd-typography"><p>The virtual presence this data holder is associated with.</p>
127
147
  </div><aside class="tsd-sources">
128
148
  <ul>
129
- <li>Defined in src/public/typings/dataHolder.ts:31</li></ul></aside></section></section></details></div>
149
+ <li>Defined in src/public/typings/dataHolder.ts:34</li></ul></aside></section></section></details></div>
130
150
  <div class="col-sidebar">
131
151
  <div class="page-menu">
132
152
  <div class="tsd-navigation settings">
@@ -143,7 +163,7 @@ data holder has no scan summaries.</p>
143
163
  <h3>On This Page</h3></summary>
144
164
  <div class="tsd-accordion-details">
145
165
  <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>
146
- <div><a href="#complianceconcern"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>compliance<wbr/>Concern</span></a><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="#domainname"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>domain<wbr/>Name</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="#latestscansummary"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>latest<wbr/>Scan<wbr/>Summary</span></a><a href="#mostrecentinteractionat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>most<wbr/>Recent<wbr/>Interaction<wbr/>At</span></a><a href="#name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</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="#protectionstate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>protection<wbr/>State</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>
166
+ <div><a href="#complianceconcern"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>compliance<wbr/>Concern</span></a><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="#domainname"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>domain<wbr/>Name</span></a><a href="#firstinboundcontactat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>first<wbr/>Inbound<wbr/>Contact<wbr/>At</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="#latestscansummary"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>latest<wbr/>Scan<wbr/>Summary</span></a><a href="#mostrecentinboundcontactat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>most<wbr/>Recent<wbr/>Inbound<wbr/>Contact<wbr/>At</span></a><a href="#mostrecentinteractionat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>most<wbr/>Recent<wbr/>Interaction<wbr/>At</span></a><a href="#name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</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="#protectionstate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>protection<wbr/>State</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>
147
167
  <div class="site-menu">
148
168
  <nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
149
169
  <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
@@ -17,7 +17,7 @@ during a single scan for a specific data holder.</p>
17
17
  </div></section>
18
18
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">DataHolderScanSummary</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#categorybreakdown">categoryBreakdown</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</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="#emailcount">emailCount</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="#marketingemailcount">marketingEmailCount</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="#marketingemailopened">marketingEmailOpened</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="#marketingopenrate">marketingOpenRate</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="#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="#readcount">readCount</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="#readrate">readRate</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="#scannedat">scannedAt</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="#scanrangefrom">scanRangeFrom</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="#scanrangeto">scanRangeTo</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="#uncategorizedcount">uncategorizedCount</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">
19
19
  <ul>
20
- <li>Defined in src/public/typings/dataHolder.ts:80</li></ul></aside>
20
+ <li>Defined in src/public/typings/dataHolder.ts:88</li></ul></aside>
21
21
  <section class="tsd-panel-group tsd-index-group">
22
22
  <section class="tsd-panel tsd-index-panel">
23
23
  <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>
@@ -48,91 +48,91 @@ during a single scan for a specific data holder.</p>
48
48
  <div class="tsd-comment tsd-typography"><p>Count of emails per category.</p>
49
49
  </div><aside class="tsd-sources">
50
50
  <ul>
51
- <li>Defined in src/public/typings/dataHolder.ts:92</li></ul></aside></section>
51
+ <li>Defined in src/public/typings/dataHolder.ts:100</li></ul></aside></section>
52
52
  <section class="tsd-panel tsd-member">
53
53
  <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>
54
54
  <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>
55
55
  <div class="tsd-comment tsd-typography"><p>The data holder these metrics apply to.</p>
56
56
  </div><aside class="tsd-sources">
57
57
  <ul>
58
- <li>Defined in src/public/typings/dataHolder.ts:81</li></ul></aside></section>
58
+ <li>Defined in src/public/typings/dataHolder.ts:89</li></ul></aside></section>
59
59
  <section class="tsd-panel tsd-member">
60
60
  <h3 class="tsd-anchor-link" id="emailcount"><span>email<wbr/>Count</span><a href="#emailcount" 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">emailCount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
62
62
  <div class="tsd-comment tsd-typography"><p>Total number of emails observed in the scan range.</p>
63
63
  </div><aside class="tsd-sources">
64
64
  <ul>
65
- <li>Defined in src/public/typings/dataHolder.ts:86</li></ul></aside></section>
65
+ <li>Defined in src/public/typings/dataHolder.ts:94</li></ul></aside></section>
66
66
  <section class="tsd-panel tsd-member">
67
67
  <h3 class="tsd-anchor-link" id="marketingemailcount"><span>marketing<wbr/>Email<wbr/>Count</span><a href="#marketingemailcount" 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">marketingEmailCount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
69
69
  <div class="tsd-comment tsd-typography"><p>Number of marketing emails observed.</p>
70
70
  </div><aside class="tsd-sources">
71
71
  <ul>
72
- <li>Defined in src/public/typings/dataHolder.ts:89</li></ul></aside></section>
72
+ <li>Defined in src/public/typings/dataHolder.ts:97</li></ul></aside></section>
73
73
  <section class="tsd-panel tsd-member">
74
74
  <h3 class="tsd-anchor-link" id="marketingemailopened"><span>marketing<wbr/>Email<wbr/>Opened</span><a href="#marketingemailopened" 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>
75
75
  <div class="tsd-signature"><span class="tsd-kind-property">marketingEmailOpened</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
76
76
  <div class="tsd-comment tsd-typography"><p>Number of marketing emails that were opened.</p>
77
77
  </div><aside class="tsd-sources">
78
78
  <ul>
79
- <li>Defined in src/public/typings/dataHolder.ts:90</li></ul></aside></section>
79
+ <li>Defined in src/public/typings/dataHolder.ts:98</li></ul></aside></section>
80
80
  <section class="tsd-panel tsd-member">
81
81
  <h3 class="tsd-anchor-link" id="marketingopenrate"><span>marketing<wbr/>Open<wbr/>Rate</span><a href="#marketingopenrate" 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>
82
82
  <div class="tsd-signature"><span class="tsd-kind-property">marketingOpenRate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
83
83
  <div class="tsd-comment tsd-typography"><p>Ratio of opened marketing emails to marketing emails.</p>
84
84
  </div><aside class="tsd-sources">
85
85
  <ul>
86
- <li>Defined in src/public/typings/dataHolder.ts:91</li></ul></aside></section>
86
+ <li>Defined in src/public/typings/dataHolder.ts:99</li></ul></aside></section>
87
87
  <section class="tsd-panel tsd-member">
88
88
  <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>
89
89
  <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>
90
90
  <div class="tsd-comment tsd-typography"><p>Unique identifier of the user.</p>
91
91
  </div><aside class="tsd-sources">
92
92
  <ul>
93
- <li>Defined in src/public/typings/dataHolder.ts:82</li></ul></aside></section>
93
+ <li>Defined in src/public/typings/dataHolder.ts:90</li></ul></aside></section>
94
94
  <section class="tsd-panel tsd-member">
95
95
  <h3 class="tsd-anchor-link" id="readcount"><span>read<wbr/>Count</span><a href="#readcount" 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>
96
96
  <div class="tsd-signature"><span class="tsd-kind-property">readCount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
97
97
  <div class="tsd-comment tsd-typography"><p>Number of emails that were read.</p>
98
98
  </div><aside class="tsd-sources">
99
99
  <ul>
100
- <li>Defined in src/public/typings/dataHolder.ts:87</li></ul></aside></section>
100
+ <li>Defined in src/public/typings/dataHolder.ts:95</li></ul></aside></section>
101
101
  <section class="tsd-panel tsd-member">
102
102
  <h3 class="tsd-anchor-link" id="readrate"><span>read<wbr/>Rate</span><a href="#readrate" 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>
103
103
  <div class="tsd-signature"><span class="tsd-kind-property">readRate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
104
104
  <div class="tsd-comment tsd-typography"><p>Ratio of read emails to total emails.</p>
105
105
  </div><aside class="tsd-sources">
106
106
  <ul>
107
- <li>Defined in src/public/typings/dataHolder.ts:88</li></ul></aside></section>
107
+ <li>Defined in src/public/typings/dataHolder.ts:96</li></ul></aside></section>
108
108
  <section class="tsd-panel tsd-member">
109
109
  <h3 class="tsd-anchor-link" id="scannedat"><span>scanned<wbr/>At</span><a href="#scannedat" 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>
110
110
  <div class="tsd-signature"><span class="tsd-kind-property">scannedAt</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
111
111
  <div class="tsd-comment tsd-typography"><p>Date for when the scan was performed.</p>
112
112
  </div><aside class="tsd-sources">
113
113
  <ul>
114
- <li>Defined in src/public/typings/dataHolder.ts:83</li></ul></aside></section>
114
+ <li>Defined in src/public/typings/dataHolder.ts:91</li></ul></aside></section>
115
115
  <section class="tsd-panel tsd-member">
116
116
  <h3 class="tsd-anchor-link" id="scanrangefrom"><span>scan<wbr/>Range<wbr/>From</span><a href="#scanrangefrom" 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>
117
117
  <div class="tsd-signature"><span class="tsd-kind-property">scanRangeFrom</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
118
118
  <div class="tsd-comment tsd-typography"><p>Start of the scanned time range.</p>
119
119
  </div><aside class="tsd-sources">
120
120
  <ul>
121
- <li>Defined in src/public/typings/dataHolder.ts:84</li></ul></aside></section>
121
+ <li>Defined in src/public/typings/dataHolder.ts:92</li></ul></aside></section>
122
122
  <section class="tsd-panel tsd-member">
123
123
  <h3 class="tsd-anchor-link" id="scanrangeto"><span>scan<wbr/>Range<wbr/>To</span><a href="#scanrangeto" 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>
124
124
  <div class="tsd-signature"><span class="tsd-kind-property">scanRangeTo</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
125
125
  <div class="tsd-comment tsd-typography"><p>End of the scanned time range.</p>
126
126
  </div><aside class="tsd-sources">
127
127
  <ul>
128
- <li>Defined in src/public/typings/dataHolder.ts:85</li></ul></aside></section>
128
+ <li>Defined in src/public/typings/dataHolder.ts:93</li></ul></aside></section>
129
129
  <section class="tsd-panel tsd-member">
130
130
  <h3 class="tsd-anchor-link" id="uncategorizedcount"><span>uncategorized<wbr/>Count</span><a href="#uncategorizedcount" 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>
131
131
  <div class="tsd-signature"><span class="tsd-kind-property">uncategorizedCount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
132
132
  <div class="tsd-comment tsd-typography"><p>Number of emails that could not be categorized.</p>
133
133
  </div><aside class="tsd-sources">
134
134
  <ul>
135
- <li>Defined in src/public/typings/dataHolder.ts:93</li></ul></aside></section></section></details></div>
135
+ <li>Defined in src/public/typings/dataHolder.ts:101</li></ul></aside></section></section></details></div>
136
136
  <div class="col-sidebar">
137
137
  <div class="page-menu">
138
138
  <div class="tsd-navigation settings">