@sudoplatform/sudo-privacy-interaction 2.0.0 → 2.2.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 (168) hide show
  1. package/cjs/gen/graphqlTypes.js +2291 -780
  2. package/cjs/private/data/action/actionSubscriptionManager.js +25 -0
  3. package/cjs/private/data/action/defaultActionService.js +80 -0
  4. package/cjs/private/data/action/transformer/actionFulfilmentMethodTransformer.js +47 -0
  5. package/cjs/private/data/action/transformer/actionIntentTransformer.js +69 -0
  6. package/cjs/private/data/action/transformer/actionOriginTransformer.js +37 -0
  7. package/cjs/private/data/action/transformer/actionStatusTransformer.js +53 -0
  8. package/cjs/private/data/action/transformer/actionTransformer.js +85 -0
  9. package/cjs/private/data/action/transformer/availableActionTransformer.js +37 -0
  10. package/cjs/private/data/analysis-result/transformer/privacyScoreTransformer.js +8 -0
  11. package/cjs/private/data/common/apiClient.js +58 -0
  12. package/cjs/private/data/data-holder/defaultDataHolderService.js +12 -0
  13. package/cjs/private/data/data-holder/transformer/dataHolderScanSummaryTransformer.js +56 -0
  14. package/cjs/private/data/organization-analysis/defaultOrganizationAnalysisService.js +31 -0
  15. package/cjs/private/data/organization-analysis/transformer/organizationAnalysisModeTransformer.js +29 -0
  16. package/cjs/private/data/organization-analysis/transformer/organizationAnalysisTransformer.js +45 -0
  17. package/cjs/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +2 -0
  18. package/cjs/private/domain/entities/action/actionEntity.js +86 -0
  19. package/cjs/private/domain/entities/action/actionService.js +7 -0
  20. package/cjs/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +24 -0
  21. package/cjs/private/domain/entities/organization-analysis/organizationAnalysisService.js +7 -0
  22. package/cjs/private/domain/use-cases/action/confirmActionOutcomeUseCase.js +25 -0
  23. package/cjs/private/domain/use-cases/action/initiateActionUseCase.js +26 -0
  24. package/cjs/private/domain/use-cases/action/listAvailableActionsUseCase.js +26 -0
  25. package/cjs/private/domain/use-cases/action/subscribeToActionUseCase.js +37 -0
  26. package/cjs/private/domain/use-cases/action/unsubscribeFromActionUseCase.js +27 -0
  27. package/cjs/private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase.js +29 -0
  28. package/cjs/private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase.js +25 -0
  29. package/cjs/public/defaultSudoPrivacyInteractionClient.js +133 -6
  30. package/cjs/public/inputs/action.js +7 -0
  31. package/cjs/public/inputs/index.js +2 -0
  32. package/cjs/public/inputs/organizationAnalysis.js +7 -0
  33. package/cjs/public/typings/action.js +85 -0
  34. package/cjs/public/typings/index.js +2 -0
  35. package/cjs/public/typings/organizationAnalysis.js +24 -0
  36. package/docs/assets/hierarchy.js +1 -1
  37. package/docs/assets/navigation.js +1 -1
  38. package/docs/assets/search.js +1 -1
  39. package/docs/classes/DefaultSudoPrivacyInteractionClient.html +176 -21
  40. package/docs/enums/ActionFulfilmentMethod.html +63 -0
  41. package/docs/enums/ActionIntent.html +84 -0
  42. package/docs/enums/ActionOrigin.html +75 -0
  43. package/docs/enums/ActionStatus.html +99 -0
  44. package/docs/enums/ConnectionState.html +3 -3
  45. package/docs/enums/DataCategory.html +18 -18
  46. package/docs/enums/DataHolderProtectionState.html +5 -5
  47. package/docs/enums/OrganizationAnalysisMode.html +70 -0
  48. package/docs/enums/OrganizationCategory.html +30 -30
  49. package/docs/enums/ProviderType.html +3 -3
  50. package/docs/enums/RetentionStyle.html +5 -5
  51. package/docs/enums/ShareStyle.html +6 -6
  52. package/docs/enums/SignalValue.html +4 -4
  53. package/docs/enums/VirtualPresenceState.html +7 -7
  54. package/docs/hierarchy.html +6 -5
  55. package/docs/interfaces/Action.html +167 -0
  56. package/docs/interfaces/ActionContact.html +77 -0
  57. package/docs/interfaces/ActionSubscriber.html +92 -0
  58. package/docs/interfaces/AnalysisResultSubscriber.html +3 -3
  59. package/docs/interfaces/AssistedEmailTemplate.html +70 -0
  60. package/docs/interfaces/AssistedPayload.html +113 -0
  61. package/docs/interfaces/AvailableAction.html +102 -0
  62. package/docs/interfaces/CapabilitySignals.html +9 -9
  63. package/docs/interfaces/CategorySignals.html +11 -11
  64. package/docs/interfaces/DataHolder.html +24 -14
  65. package/docs/interfaces/DataHolderScanSummary.html +158 -0
  66. package/docs/interfaces/DataHolderSubscriber.html +3 -3
  67. package/docs/interfaces/GetDataHolderOptions.html +63 -0
  68. package/docs/interfaces/GetOrganizationAnalysisInput.html +70 -0
  69. package/docs/interfaces/InitiateActionInput.html +79 -0
  70. package/docs/interfaces/ListAnalysisResultsInput.html +1 -1
  71. package/docs/interfaces/ListAvailableActionsInput.html +61 -0
  72. package/docs/interfaces/ListDataHolderScanSummariesInput.html +85 -0
  73. package/docs/interfaces/ListDataHoldersInput.html +1 -1
  74. package/docs/interfaces/ListVirtualPresencesInput.html +1 -1
  75. package/docs/interfaces/OrganizationAnalysis.html +131 -0
  76. package/docs/interfaces/OrganizationIdentity.html +5 -5
  77. package/docs/interfaces/Pagination.html +2 -1
  78. package/docs/interfaces/PrivacyScore.html +13 -5
  79. package/docs/interfaces/PrivacySummary.html +4 -4
  80. package/docs/interfaces/RetentionInfo.html +4 -4
  81. package/docs/interfaces/RiskIndicators.html +8 -8
  82. package/docs/interfaces/ScoreContribution.html +3 -3
  83. package/docs/interfaces/ScoreCoverage.html +70 -0
  84. package/docs/interfaces/SudoPrivacyInteractionClient.html +169 -21
  85. package/docs/interfaces/VirtualPresence.html +21 -12
  86. package/docs/interfaces/VirtualPresenceSubscriber.html +3 -3
  87. package/docs/modules.html +4 -4
  88. package/docs/types/SudoPrivacyInteractionClientOptions.html +2 -2
  89. package/lib/gen/graphqlTypes.js +2290 -779
  90. package/lib/private/data/action/actionSubscriptionManager.js +21 -0
  91. package/lib/private/data/action/defaultActionService.js +76 -0
  92. package/lib/private/data/action/transformer/actionFulfilmentMethodTransformer.js +43 -0
  93. package/lib/private/data/action/transformer/actionIntentTransformer.js +65 -0
  94. package/lib/private/data/action/transformer/actionOriginTransformer.js +33 -0
  95. package/lib/private/data/action/transformer/actionStatusTransformer.js +49 -0
  96. package/lib/private/data/action/transformer/actionTransformer.js +81 -0
  97. package/lib/private/data/action/transformer/availableActionTransformer.js +33 -0
  98. package/lib/private/data/analysis-result/transformer/privacyScoreTransformer.js +8 -0
  99. package/lib/private/data/common/apiClient.js +59 -1
  100. package/lib/private/data/data-holder/defaultDataHolderService.js +12 -0
  101. package/lib/private/data/data-holder/transformer/dataHolderScanSummaryTransformer.js +52 -0
  102. package/lib/private/data/organization-analysis/defaultOrganizationAnalysisService.js +27 -0
  103. package/lib/private/data/organization-analysis/transformer/organizationAnalysisModeTransformer.js +25 -0
  104. package/lib/private/data/organization-analysis/transformer/organizationAnalysisTransformer.js +41 -0
  105. package/lib/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +2 -0
  106. package/lib/private/domain/entities/action/actionEntity.js +83 -0
  107. package/lib/private/domain/entities/action/actionService.js +6 -0
  108. package/lib/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +21 -0
  109. package/lib/private/domain/entities/organization-analysis/organizationAnalysisService.js +6 -0
  110. package/lib/private/domain/use-cases/action/confirmActionOutcomeUseCase.js +21 -0
  111. package/lib/private/domain/use-cases/action/initiateActionUseCase.js +22 -0
  112. package/lib/private/domain/use-cases/action/listAvailableActionsUseCase.js +22 -0
  113. package/lib/private/domain/use-cases/action/subscribeToActionUseCase.js +33 -0
  114. package/lib/private/domain/use-cases/action/unsubscribeFromActionUseCase.js +23 -0
  115. package/lib/private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase.js +25 -0
  116. package/lib/private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase.js +21 -0
  117. package/lib/public/defaultSudoPrivacyInteractionClient.js +133 -6
  118. package/lib/public/inputs/action.js +6 -0
  119. package/lib/public/inputs/index.js +2 -0
  120. package/lib/public/inputs/organizationAnalysis.js +6 -0
  121. package/lib/public/typings/action.js +82 -0
  122. package/lib/public/typings/index.js +2 -0
  123. package/lib/public/typings/organizationAnalysis.js +21 -0
  124. package/package.json +5 -3
  125. package/types/gen/graphqlTypes.d.ts +569 -1
  126. package/types/private/data/action/actionSubscriptionManager.d.ts +19 -0
  127. package/types/private/data/action/defaultActionService.d.ts +23 -0
  128. package/types/private/data/action/transformer/actionFulfilmentMethodTransformer.d.ts +14 -0
  129. package/types/private/data/action/transformer/actionIntentTransformer.d.ts +14 -0
  130. package/types/private/data/action/transformer/actionOriginTransformer.d.ts +12 -0
  131. package/types/private/data/action/transformer/actionStatusTransformer.d.ts +12 -0
  132. package/types/private/data/action/transformer/actionTransformer.d.ts +39 -0
  133. package/types/private/data/action/transformer/availableActionTransformer.d.ts +15 -0
  134. package/types/private/data/common/apiClient.d.ts +16 -1
  135. package/types/private/data/common/baseSubscriptionManager.d.ts +5 -0
  136. package/types/private/data/data-holder/defaultDataHolderService.d.ts +3 -1
  137. package/types/private/data/data-holder/transformer/dataHolderScanSummaryTransformer.d.ts +18 -0
  138. package/types/private/data/organization-analysis/defaultOrganizationAnalysisService.d.ts +15 -0
  139. package/types/private/data/organization-analysis/transformer/organizationAnalysisModeTransformer.d.ts +12 -0
  140. package/types/private/data/organization-analysis/transformer/organizationAnalysisTransformer.d.ts +14 -0
  141. package/types/private/domain/entities/action/actionEntity.d.ts +187 -0
  142. package/types/private/domain/entities/action/actionService.d.ts +99 -0
  143. package/types/private/domain/entities/analysis-result/analysisResultEntity.d.ts +14 -0
  144. package/types/private/domain/entities/data-holder/dataHolderEntity.d.ts +34 -0
  145. package/types/private/domain/entities/data-holder/dataHolderService.d.ts +35 -1
  146. package/types/private/domain/entities/organization-analysis/organizationAnalysisEntity.d.ts +53 -0
  147. package/types/private/domain/entities/organization-analysis/organizationAnalysisService.d.ts +35 -0
  148. package/types/private/domain/entities/virtual-presence/virtualPresenceEntity.d.ts +3 -0
  149. package/types/private/domain/use-cases/action/confirmActionOutcomeUseCase.d.ts +16 -0
  150. package/types/private/domain/use-cases/action/initiateActionUseCase.d.ts +17 -0
  151. package/types/private/domain/use-cases/action/listAvailableActionsUseCase.d.ts +16 -0
  152. package/types/private/domain/use-cases/action/subscribeToActionUseCase.d.ts +27 -0
  153. package/types/private/domain/use-cases/action/unsubscribeFromActionUseCase.d.ts +15 -0
  154. package/types/private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase.d.ts +36 -0
  155. package/types/private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase.d.ts +16 -0
  156. package/types/public/defaultSudoPrivacyInteractionClient.d.ts +19 -3
  157. package/types/public/inputs/action.d.ts +30 -0
  158. package/types/public/inputs/dataHolder.d.ts +22 -0
  159. package/types/public/inputs/index.d.ts +2 -0
  160. package/types/public/inputs/organizationAnalysis.d.ts +18 -0
  161. package/types/public/sudoPrivacyInteractionClient.d.ts +64 -3
  162. package/types/public/typings/action.d.ts +185 -0
  163. package/types/public/typings/analysisResult.d.ts +14 -0
  164. package/types/public/typings/dataHolder.d.ts +38 -0
  165. package/types/public/typings/index.d.ts +2 -0
  166. package/types/public/typings/organizationAnalysis.d.ts +53 -0
  167. package/types/public/typings/subscription.d.ts +23 -0
  168. package/types/public/typings/virtualPresence.d.ts +3 -0
@@ -15,9 +15,9 @@
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
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="#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">
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">
19
19
  <ul>
20
- <li>Defined in src/public/typings/dataHolder.ts:25</li></ul></aside>
20
+ <li>Defined in src/public/typings/dataHolder.ts:28</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>
@@ -29,6 +29,7 @@
29
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
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
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>
32
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>
33
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>
34
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>
@@ -46,77 +47,86 @@
46
47
  <div class="tsd-comment tsd-typography"><p>Whether there is a compliance concern.</p>
47
48
  </div><aside class="tsd-sources">
48
49
  <ul>
49
- <li>Defined in src/public/typings/dataHolder.ts:32</li></ul></aside></section>
50
+ <li>Defined in src/public/typings/dataHolder.ts:35</li></ul></aside></section>
50
51
  <section class="tsd-panel tsd-member">
51
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>
52
53
  <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>
53
54
  <div class="tsd-comment tsd-typography"><p>Date for when the data holder was created.</p>
54
55
  </div><aside class="tsd-sources">
55
56
  <ul>
56
- <li>Defined in src/public/typings/dataHolder.ts:35</li></ul></aside></section>
57
+ <li>Defined in src/public/typings/dataHolder.ts:38</li></ul></aside></section>
57
58
  <section class="tsd-panel tsd-member">
58
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>
59
60
  <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>
60
61
  <div class="tsd-comment tsd-typography"><p>Domain name of the data holder.</p>
61
62
  </div><aside class="tsd-sources">
62
63
  <ul>
63
- <li>Defined in src/public/typings/dataHolder.ts:29</li></ul></aside></section>
64
+ <li>Defined in src/public/typings/dataHolder.ts:32</li></ul></aside></section>
64
65
  <section class="tsd-panel tsd-member">
65
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>
66
67
  <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>
67
68
  <div class="tsd-comment tsd-typography"><p>Unique identifier associated with the data holder.</p>
68
69
  </div><aside class="tsd-sources">
69
70
  <ul>
70
- <li>Defined in src/public/typings/dataHolder.ts:26</li></ul></aside></section>
71
+ <li>Defined in src/public/typings/dataHolder.ts:29</li></ul></aside></section>
72
+ <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>
74
+ <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
+ <div class="tsd-comment tsd-typography"><p>The most recent scan summary for this
76
+ data holder, when requested via <code>getDataHolder</code>. Undefined when not requested or when the
77
+ data holder has no scan summaries.</p>
78
+ </div><aside class="tsd-sources">
79
+ <ul>
80
+ <li>Defined in src/public/typings/dataHolder.ts:40</li></ul></aside></section>
71
81
  <section class="tsd-panel tsd-member">
72
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>
73
83
  <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>
74
84
  <div class="tsd-comment tsd-typography"><p>Date of the most recent interaction.</p>
75
85
  </div><aside class="tsd-sources">
76
86
  <ul>
77
- <li>Defined in src/public/typings/dataHolder.ts:33</li></ul></aside></section>
87
+ <li>Defined in src/public/typings/dataHolder.ts:36</li></ul></aside></section>
78
88
  <section class="tsd-panel tsd-member">
79
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>
80
90
  <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>
81
91
  <div class="tsd-comment tsd-typography"><p>Display name of the data holder.</p>
82
92
  </div><aside class="tsd-sources">
83
93
  <ul>
84
- <li>Defined in src/public/typings/dataHolder.ts:30</li></ul></aside></section>
94
+ <li>Defined in src/public/typings/dataHolder.ts:33</li></ul></aside></section>
85
95
  <section class="tsd-panel tsd-member">
86
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>
87
97
  <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>
88
98
  <div class="tsd-comment tsd-typography"><p>Unique identifier of the user.</p>
89
99
  </div><aside class="tsd-sources">
90
100
  <ul>
91
- <li>Defined in src/public/typings/dataHolder.ts:27</li></ul></aside></section>
101
+ <li>Defined in src/public/typings/dataHolder.ts:30</li></ul></aside></section>
92
102
  <section class="tsd-panel tsd-member">
93
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>
94
104
  <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>
95
105
  <div class="tsd-comment tsd-typography"><p>Current protection state.</p>
96
106
  </div><aside class="tsd-sources">
97
107
  <ul>
98
- <li>Defined in src/public/typings/dataHolder.ts:31</li></ul></aside></section>
108
+ <li>Defined in src/public/typings/dataHolder.ts:34</li></ul></aside></section>
99
109
  <section class="tsd-panel tsd-member">
100
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>
101
111
  <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>
102
112
  <div class="tsd-comment tsd-typography"><p>Date for when the data holder was last updated.</p>
103
113
  </div><aside class="tsd-sources">
104
114
  <ul>
105
- <li>Defined in src/public/typings/dataHolder.ts:36</li></ul></aside></section>
115
+ <li>Defined in src/public/typings/dataHolder.ts:39</li></ul></aside></section>
106
116
  <section class="tsd-panel tsd-member">
107
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>
108
118
  <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>
109
119
  <div class="tsd-comment tsd-typography"><p>Version of this entity. Increments on update.</p>
110
120
  </div><aside class="tsd-sources">
111
121
  <ul>
112
- <li>Defined in src/public/typings/dataHolder.ts:34</li></ul></aside></section>
122
+ <li>Defined in src/public/typings/dataHolder.ts:37</li></ul></aside></section>
113
123
  <section class="tsd-panel tsd-member">
114
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>
115
125
  <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>
116
126
  <div class="tsd-comment tsd-typography"><p>The virtual presence this data holder is associated with.</p>
117
127
  </div><aside class="tsd-sources">
118
128
  <ul>
119
- <li>Defined in src/public/typings/dataHolder.ts:28</li></ul></aside></section></section></details></div>
129
+ <li>Defined in src/public/typings/dataHolder.ts:31</li></ul></aside></section></section></details></div>
120
130
  <div class="col-sidebar">
121
131
  <div class="page-menu">
122
132
  <div class="tsd-navigation settings">
@@ -133,7 +143,7 @@
133
143
  <h3>On This Page</h3></summary>
134
144
  <div class="tsd-accordion-details">
135
145
  <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>
136
- <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="#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>
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>
137
147
  <div class="site-menu">
138
148
  <nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
139
149
  <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
@@ -0,0 +1,158 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DataHolderScanSummary | @sudoplatform/sudo-privacy-interaction</title><meta name="description" content="Documentation for @sudoplatform/sudo-privacy-interaction"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
2
+ <div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@sudoplatform/sudo-privacy-interaction</a>
3
+ <div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
4
+ <ul role="listbox" id="tsd-search-results"></ul>
5
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
6
+ <div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
7
+ <div class="container container-main">
8
+ <div class="col-content">
9
+ <div class="tsd-page-title">
10
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
+ <li><a href="" aria-current="page">DataHolderScanSummary</a></li></ul>
12
+ <h1>Interface DataHolderScanSummary</h1></div>
13
+ <section class="tsd-panel tsd-comment">
14
+ <div class="tsd-comment tsd-typography"><p>The Sudo Platform SDK representation of email interaction metrics captured
15
+ during a single scan for a specific data holder.</p>
16
+ <p>DataHolderScanSummary</p>
17
+ </div></section>
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
+ <ul>
20
+ <li>Defined in src/public/typings/dataHolder.ts:78</li></ul></aside>
21
+ <section class="tsd-panel-group tsd-index-group">
22
+ <section class="tsd-panel tsd-index-panel">
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>
24
+ <h5 class="tsd-index-heading uppercase">Index</h5></summary>
25
+ <div class="tsd-accordion-details">
26
+ <section class="tsd-index-section">
27
+ <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="#categorybreakdown" 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>category<wbr/>Breakdown</span></a>
29
+ <a href="#dataholderid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data<wbr/>Holder<wbr/>Id</span></a>
30
+ <a href="#emailcount" 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>email<wbr/>Count</span></a>
31
+ <a href="#marketingemailcount" 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>marketing<wbr/>Email<wbr/>Count</span></a>
32
+ <a href="#marketingemailopened" 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>marketing<wbr/>Email<wbr/>Opened</span></a>
33
+ <a href="#marketingopenrate" 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>marketing<wbr/>Open<wbr/>Rate</span></a>
34
+ <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>
35
+ <a href="#readcount" 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>read<wbr/>Count</span></a>
36
+ <a href="#readrate" 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>read<wbr/>Rate</span></a>
37
+ <a href="#scannedat" 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>scanned<wbr/>At</span></a>
38
+ <a href="#scanrangefrom" 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>scan<wbr/>Range<wbr/>From</span></a>
39
+ <a href="#scanrangeto" 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>scan<wbr/>Range<wbr/>To</span></a>
40
+ <a href="#uncategorizedcount" 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>uncategorized<wbr/>Count</span></a>
41
+ </div></section></div></details></section></section>
42
+ <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>
43
+ <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>
44
+ <section>
45
+ <section class="tsd-panel tsd-member">
46
+ <h3 class="tsd-anchor-link" id="categorybreakdown"><span>category<wbr/>Breakdown</span><a href="#categorybreakdown" 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
+ <div class="tsd-signature"><span class="tsd-kind-property">categoryBreakdown</span><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></div>
48
+ <div class="tsd-comment tsd-typography"><p>Count of emails per category.</p>
49
+ </div><aside class="tsd-sources">
50
+ <ul>
51
+ <li>Defined in src/public/typings/dataHolder.ts:90</li></ul></aside></section>
52
+ <section class="tsd-panel tsd-member">
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
+ <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
+ <div class="tsd-comment tsd-typography"><p>The data holder these metrics apply to.</p>
56
+ </div><aside class="tsd-sources">
57
+ <ul>
58
+ <li>Defined in src/public/typings/dataHolder.ts:79</li></ul></aside></section>
59
+ <section class="tsd-panel tsd-member">
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
+ <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
+ <div class="tsd-comment tsd-typography"><p>Total number of emails observed in the scan range.</p>
63
+ </div><aside class="tsd-sources">
64
+ <ul>
65
+ <li>Defined in src/public/typings/dataHolder.ts:84</li></ul></aside></section>
66
+ <section class="tsd-panel tsd-member">
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
+ <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
+ <div class="tsd-comment tsd-typography"><p>Number of marketing emails observed.</p>
70
+ </div><aside class="tsd-sources">
71
+ <ul>
72
+ <li>Defined in src/public/typings/dataHolder.ts:87</li></ul></aside></section>
73
+ <section class="tsd-panel tsd-member">
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
+ <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
+ <div class="tsd-comment tsd-typography"><p>Number of marketing emails that were opened.</p>
77
+ </div><aside class="tsd-sources">
78
+ <ul>
79
+ <li>Defined in src/public/typings/dataHolder.ts:88</li></ul></aside></section>
80
+ <section class="tsd-panel tsd-member">
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
+ <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
+ <div class="tsd-comment tsd-typography"><p>Ratio of opened marketing emails to marketing emails.</p>
84
+ </div><aside class="tsd-sources">
85
+ <ul>
86
+ <li>Defined in src/public/typings/dataHolder.ts:89</li></ul></aside></section>
87
+ <section class="tsd-panel tsd-member">
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
+ <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
+ <div class="tsd-comment tsd-typography"><p>Unique identifier of the user.</p>
91
+ </div><aside class="tsd-sources">
92
+ <ul>
93
+ <li>Defined in src/public/typings/dataHolder.ts:80</li></ul></aside></section>
94
+ <section class="tsd-panel tsd-member">
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
+ <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
+ <div class="tsd-comment tsd-typography"><p>Number of emails that were read.</p>
98
+ </div><aside class="tsd-sources">
99
+ <ul>
100
+ <li>Defined in src/public/typings/dataHolder.ts:85</li></ul></aside></section>
101
+ <section class="tsd-panel tsd-member">
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
+ <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
+ <div class="tsd-comment tsd-typography"><p>Ratio of read emails to total emails.</p>
105
+ </div><aside class="tsd-sources">
106
+ <ul>
107
+ <li>Defined in src/public/typings/dataHolder.ts:86</li></ul></aside></section>
108
+ <section class="tsd-panel tsd-member">
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
+ <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
+ <div class="tsd-comment tsd-typography"><p>Date for when the scan was performed.</p>
112
+ </div><aside class="tsd-sources">
113
+ <ul>
114
+ <li>Defined in src/public/typings/dataHolder.ts:81</li></ul></aside></section>
115
+ <section class="tsd-panel tsd-member">
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
+ <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
+ <div class="tsd-comment tsd-typography"><p>Start of the scanned time range.</p>
119
+ </div><aside class="tsd-sources">
120
+ <ul>
121
+ <li>Defined in src/public/typings/dataHolder.ts:82</li></ul></aside></section>
122
+ <section class="tsd-panel tsd-member">
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
+ <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
+ <div class="tsd-comment tsd-typography"><p>End of the scanned time range.</p>
126
+ </div><aside class="tsd-sources">
127
+ <ul>
128
+ <li>Defined in src/public/typings/dataHolder.ts:83</li></ul></aside></section>
129
+ <section class="tsd-panel tsd-member">
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
+ <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
+ <div class="tsd-comment tsd-typography"><p>Number of emails that could not be categorized.</p>
133
+ </div><aside class="tsd-sources">
134
+ <ul>
135
+ <li>Defined in src/public/typings/dataHolder.ts:91</li></ul></aside></section></section></details></div>
136
+ <div class="col-sidebar">
137
+ <div class="page-menu">
138
+ <div class="tsd-navigation settings">
139
+ <details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
140
+ <h3>Settings</h3></summary>
141
+ <div class="tsd-accordion-details">
142
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
143
+ <ul id="tsd-filter-options">
144
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
145
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
146
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
147
+ <div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
148
+ <details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
149
+ <h3>On This Page</h3></summary>
150
+ <div class="tsd-accordion-details">
151
+ <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>
152
+ <div><a href="#categorybreakdown"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>category<wbr/>Breakdown</span></a><a href="#dataholderid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data<wbr/>Holder<wbr/>Id</span></a><a href="#emailcount"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>email<wbr/>Count</span></a><a href="#marketingemailcount"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>marketing<wbr/>Email<wbr/>Count</span></a><a href="#marketingemailopened"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>marketing<wbr/>Email<wbr/>Opened</span></a><a href="#marketingopenrate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>marketing<wbr/>Open<wbr/>Rate</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="#readcount"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>read<wbr/>Count</span></a><a href="#readrate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>read<wbr/>Rate</span></a><a href="#scannedat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scanned<wbr/>At</span></a><a href="#scanrangefrom"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scan<wbr/>Range<wbr/>From</span></a><a href="#scanrangeto"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scan<wbr/>Range<wbr/>To</span></a><a href="#uncategorizedcount"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>uncategorized<wbr/>Count</span></a></div></details></div></details></div>
153
+ <div class="site-menu">
154
+ <nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
155
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
156
+ <li>Loading...</li></ul></nav></div></div></div><footer>
157
+ <p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
158
+ <div class="overlay"></div></body></html>
@@ -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">DataHolderSubscriber</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-call-signature" href="#connectionstatuschanged-1">connectionStatusChanged</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">:</span> <a href="../enums/ConnectionState.html" class="tsd-signature-type tsd-kind-enum">ConnectionState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#dataholdersupdated-1">dataHoldersUpdated</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dataHolders</span><span class="tsd-signature-symbol">:</span> <a href="DataHolder.html" class="tsd-signature-type tsd-kind-interface">DataHolder</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</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/subscription.ts:53</li></ul></aside>
19
+ <li>Defined in src/public/typings/subscription.ts:54</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>
@@ -49,7 +49,7 @@ data holder change notifications when the connection state changes to <code>Conn
49
49
  </div></li></ul></div>
50
50
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
51
51
  <ul>
52
- <li>Defined in src/public/typings/subscription.ts:69</li></ul></aside></div></li></ul></section>
52
+ <li>Defined in src/public/typings/subscription.ts:70</li></ul></aside></div></li></ul></section>
53
53
  <section class="tsd-panel tsd-member">
54
54
  <h3 class="tsd-anchor-link" id="dataholdersupdated"><span>data<wbr/>Holders<wbr/>Updated</span><a href="#dataholdersupdated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
55
55
  <ul class="tsd-signatures">
@@ -66,7 +66,7 @@ data holder change notifications when the connection state changes to <code>Conn
66
66
  </div></li></ul></div>
67
67
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
68
68
  <ul>
69
- <li>Defined in src/public/typings/subscription.ts:59</li></ul></aside></div></li></ul></section></section></details></div>
69
+ <li>Defined in src/public/typings/subscription.ts:60</li></ul></aside></div></li></ul></section></section></details></div>
70
70
  <div class="col-sidebar">
71
71
  <div class="page-menu">
72
72
  <div class="tsd-navigation settings">
@@ -0,0 +1,63 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GetDataHolderOptions | @sudoplatform/sudo-privacy-interaction</title><meta name="description" content="Documentation for @sudoplatform/sudo-privacy-interaction"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
2
+ <div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@sudoplatform/sudo-privacy-interaction</a>
3
+ <div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
4
+ <ul role="listbox" id="tsd-search-results"></ul>
5
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
6
+ <div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
7
+ <div class="container container-main">
8
+ <div class="col-content">
9
+ <div class="tsd-page-title">
10
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
+ <li><a href="" aria-current="page">GetDataHolderOptions</a></li></ul>
12
+ <h1>Interface GetDataHolderOptions</h1></div>
13
+ <section class="tsd-panel tsd-comment">
14
+ <div class="tsd-comment tsd-typography"><p>Options to control what <code>getDataHolder</code> returns.</p>
15
+ <p>GetDataHolderOptions</p>
16
+ </div></section>
17
+ <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">GetDataHolderOptions</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#includescansummary">includeScanSummary</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
18
+ <ul>
19
+ <li>Defined in src/public/inputs/dataHolder.ts:41</li></ul></aside>
20
+ <section class="tsd-panel-group tsd-index-group">
21
+ <section class="tsd-panel tsd-index-panel">
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>
23
+ <h5 class="tsd-index-heading uppercase">Index</h5></summary>
24
+ <div class="tsd-accordion-details">
25
+ <section class="tsd-index-section">
26
+ <h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
27
+ <div class="tsd-index-list"><a href="#includescansummary" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>include<wbr/>Scan<wbr/>Summary?</span></a>
28
+ </div></section></div></details></section></section>
29
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
30
+ <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>
31
+ <section>
32
+ <section class="tsd-panel tsd-member">
33
+ <h3 class="tsd-anchor-link" id="includescansummary"><code class="tsd-tag">Optional</code><span>include<wbr/>Scan<wbr/>Summary</span><a href="#includescansummary" 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>
34
+ <div class="tsd-signature"><span class="tsd-kind-property">includeScanSummary</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
35
+ <div class="tsd-comment tsd-typography"><p>Whether to also fetch and attach the most recent
36
+ scan summary to the returned data holder. Defaults to <code>true</code>. When <code>true</code>, the data holder
37
+ and its latest scan summary are fetched concurrently.</p>
38
+ </div><aside class="tsd-sources">
39
+ <ul>
40
+ <li>Defined in src/public/inputs/dataHolder.ts:42</li></ul></aside></section></section></details></div>
41
+ <div class="col-sidebar">
42
+ <div class="page-menu">
43
+ <div class="tsd-navigation settings">
44
+ <details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
45
+ <h3>Settings</h3></summary>
46
+ <div class="tsd-accordion-details">
47
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
48
+ <ul id="tsd-filter-options">
49
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
50
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
51
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
52
+ <div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
53
+ <details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
54
+ <h3>On This Page</h3></summary>
55
+ <div class="tsd-accordion-details">
56
+ <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>
57
+ <div><a href="#includescansummary"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>include<wbr/>Scan<wbr/>Summary</span></a></div></details></div></details></div>
58
+ <div class="site-menu">
59
+ <nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
60
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
61
+ <li>Loading...</li></ul></nav></div></div></div><footer>
62
+ <p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
63
+ <div class="overlay"></div></body></html>