@sudoplatform/sudo-privacy-interaction 2.2.0 → 2.3.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 (92) hide show
  1. package/cjs/gen/graphqlTypes.js +434 -11
  2. package/cjs/gen/schema-types.js +2 -0
  3. package/cjs/private/data/action/defaultActionService.js +7 -0
  4. package/cjs/private/data/analysis-result/transformer/capabilitySignalsTransformer.js +5 -2
  5. package/cjs/private/data/analysis-result/transformer/organizationCategoryTransformer.js +4 -0
  6. package/cjs/private/data/common/apiClient.js +29 -1
  7. package/cjs/private/data/data-holder/defaultDataHolderService.js +8 -0
  8. package/cjs/private/data/data-holder/transformer/dataHolderProtectionStateTransformer.js +4 -0
  9. package/cjs/private/data/organization-analysis/defaultOrganizationAnalysisService.js +6 -0
  10. package/cjs/private/data/organization-analysis/transformer/organizationAnalysisDomainResolutionTransformer.js +29 -0
  11. package/cjs/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +8 -0
  12. package/cjs/private/domain/entities/analysis-result/analysisResultEntity.js +1 -0
  13. package/cjs/private/domain/entities/data-holder/dataHolderEntity.js +2 -0
  14. package/cjs/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +17 -1
  15. package/cjs/private/domain/use-cases/action/getActionUseCase.js +25 -0
  16. package/cjs/private/domain/use-cases/data-holder/archiveDataHolderUseCase.js +25 -0
  17. package/cjs/private/domain/use-cases/data-holder/unarchiveDataHolderUseCase.js +25 -0
  18. package/cjs/public/defaultSudoPrivacyInteractionClient.js +31 -0
  19. package/cjs/public/typings/analysisResult.js +1 -0
  20. package/cjs/public/typings/dataHolder.js +2 -0
  21. package/cjs/public/typings/organizationAnalysis.js +17 -1
  22. package/docs/assets/hierarchy.js +1 -1
  23. package/docs/assets/navigation.js +1 -1
  24. package/docs/assets/search.js +1 -1
  25. package/docs/classes/DefaultSudoPrivacyInteractionClient.html +93 -27
  26. package/docs/enums/DataHolderProtectionState.html +12 -6
  27. package/docs/enums/OrganizationAnalysisDomainResolution.html +70 -0
  28. package/docs/enums/OrganizationCategory.html +38 -32
  29. package/docs/enums/ProviderType.html +3 -3
  30. package/docs/enums/VirtualPresenceState.html +7 -7
  31. package/docs/hierarchy.html +6 -6
  32. package/docs/interfaces/CapabilitySignals.html +41 -29
  33. package/docs/interfaces/DataHolderCount.html +98 -0
  34. package/docs/interfaces/DataHolderScanSummary.html +14 -14
  35. package/docs/interfaces/GetOrganizationAnalysisInput.html +24 -5
  36. package/docs/interfaces/ListAnalysisResultsInput.html +1 -1
  37. package/docs/interfaces/ListDataHolderScanSummariesInput.html +1 -1
  38. package/docs/interfaces/ListDataHoldersInput.html +1 -1
  39. package/docs/interfaces/ListVirtualPresencesInput.html +1 -1
  40. package/docs/interfaces/OrganizationIdentity.html +5 -5
  41. package/docs/interfaces/Pagination.html +1 -1
  42. package/docs/interfaces/RiskIndicators.html +8 -8
  43. package/docs/interfaces/SudoPrivacyInteractionClient.html +78 -15
  44. package/docs/interfaces/VirtualPresence.html +22 -13
  45. package/docs/modules.html +4 -4
  46. package/docs/types/SudoPrivacyInteractionClientOptions.html +2 -2
  47. package/lib/gen/graphqlTypes.js +432 -10
  48. package/lib/gen/schema-types.js +1 -0
  49. package/lib/private/data/action/defaultActionService.js +7 -0
  50. package/lib/private/data/analysis-result/transformer/capabilitySignalsTransformer.js +5 -2
  51. package/lib/private/data/analysis-result/transformer/organizationCategoryTransformer.js +4 -0
  52. package/lib/private/data/common/apiClient.js +30 -2
  53. package/lib/private/data/data-holder/defaultDataHolderService.js +8 -0
  54. package/lib/private/data/data-holder/transformer/dataHolderProtectionStateTransformer.js +4 -0
  55. package/lib/private/data/organization-analysis/defaultOrganizationAnalysisService.js +6 -0
  56. package/lib/private/data/organization-analysis/transformer/organizationAnalysisDomainResolutionTransformer.js +25 -0
  57. package/lib/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +8 -0
  58. package/lib/private/domain/entities/analysis-result/analysisResultEntity.js +1 -0
  59. package/lib/private/domain/entities/data-holder/dataHolderEntity.js +2 -0
  60. package/lib/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +16 -0
  61. package/lib/private/domain/use-cases/action/getActionUseCase.js +21 -0
  62. package/lib/private/domain/use-cases/data-holder/archiveDataHolderUseCase.js +21 -0
  63. package/lib/private/domain/use-cases/data-holder/unarchiveDataHolderUseCase.js +21 -0
  64. package/lib/public/defaultSudoPrivacyInteractionClient.js +31 -0
  65. package/lib/public/typings/analysisResult.js +1 -0
  66. package/lib/public/typings/dataHolder.js +2 -0
  67. package/lib/public/typings/organizationAnalysis.js +16 -0
  68. package/package.json +19 -23
  69. package/types/gen/graphqlTypes.d.ts +331 -645
  70. package/types/gen/schema-types.d.ts +521 -0
  71. package/types/private/data/action/defaultActionService.d.ts +1 -0
  72. package/types/private/data/common/apiClient.d.ts +6 -1
  73. package/types/private/data/data-holder/defaultDataHolderService.d.ts +2 -0
  74. package/types/private/data/organization-analysis/defaultOrganizationAnalysisService.d.ts +1 -0
  75. package/types/private/data/organization-analysis/transformer/organizationAnalysisDomainResolutionTransformer.d.ts +12 -0
  76. package/types/private/domain/entities/action/actionService.d.ts +11 -0
  77. package/types/private/domain/entities/analysis-result/analysisResultEntity.d.ts +3 -2
  78. package/types/private/domain/entities/data-holder/dataHolderEntity.d.ts +2 -0
  79. package/types/private/domain/entities/data-holder/dataHolderService.d.ts +16 -0
  80. package/types/private/domain/entities/organization-analysis/organizationAnalysisEntity.d.ts +15 -0
  81. package/types/private/domain/entities/organization-analysis/organizationAnalysisService.d.ts +8 -1
  82. package/types/private/domain/entities/virtual-presence/virtualPresenceEntity.d.ts +24 -0
  83. package/types/private/domain/use-cases/action/getActionUseCase.d.ts +16 -0
  84. package/types/private/domain/use-cases/data-holder/archiveDataHolderUseCase.d.ts +16 -0
  85. package/types/private/domain/use-cases/data-holder/unarchiveDataHolderUseCase.d.ts +16 -0
  86. package/types/public/defaultSudoPrivacyInteractionClient.d.ts +4 -0
  87. package/types/public/inputs/organizationAnalysis.d.ts +8 -1
  88. package/types/public/sudoPrivacyInteractionClient.d.ts +27 -0
  89. package/types/public/typings/analysisResult.d.ts +8 -0
  90. package/types/public/typings/dataHolder.d.ts +2 -0
  91. package/types/public/typings/organizationAnalysis.d.ts +15 -0
  92. package/types/public/typings/virtualPresence.d.ts +25 -0
@@ -99,6 +99,22 @@ export interface DataHolderService {
99
99
  * search criteria. Can be empty if no scan summaries found.
100
100
  */
101
101
  listScanSummaries(input: ListDataHolderScanSummariesInput): Promise<ListDataHolderScanSummariesOutput>;
102
+ /**
103
+ * Archive a data holder, removing it from the user's active list.
104
+ *
105
+ * @param {string} id The unique identifier of the data holder to archive.
106
+ * @returns {DataHolderEntity} The archived data holder.
107
+ */
108
+ archive(id: string): Promise<DataHolderEntity>;
109
+ /**
110
+ * Unarchive a previously archived data holder, returning it to the
111
+ * `Monitored` state. Only a data holder in the `Archived` state may be
112
+ * unarchived.
113
+ *
114
+ * @param {string} id The unique identifier of the data holder to unarchive.
115
+ * @returns {DataHolderEntity} The unarchived data holder.
116
+ */
117
+ unarchive(id: string): Promise<DataHolderEntity>;
102
118
  /**
103
119
  * Subscribe to data holder state events.
104
120
  *
@@ -51,3 +51,18 @@ export declare enum OrganizationAnalysisModeEntity {
51
51
  Analyze = "ANALYZE",
52
52
  Fetch = "FETCH"
53
53
  }
54
+ /**
55
+ * Controls how `getOrganizationAnalysis` treats the requested domain before
56
+ * sources query their backing services.
57
+ *
58
+ * @property REGISTRABLE Reduce the domain to its registrable (eTLD+1) form before analysis,
59
+ * e.g. `mail.sub.example.co.uk` becomes `example.co.uk`.
60
+ * @property EXACT Analyze the domain verbatim, without reducing it to a registrable domain.
61
+ * Used to analyze a specific host/subdomain rather than the organization.
62
+ *
63
+ * @enum
64
+ */
65
+ export declare enum OrganizationAnalysisDomainResolutionEntity {
66
+ Registrable = "REGISTRABLE",
67
+ Exact = "EXACT"
68
+ }
@@ -3,18 +3,25 @@
3
3
  *
4
4
  * SPDX-License-Identifier: Apache-2.0
5
5
  */
6
- import { OrganizationAnalysisEntity, OrganizationAnalysisModeEntity } from './organizationAnalysisEntity';
6
+ import { OrganizationAnalysisDomainResolutionEntity, OrganizationAnalysisEntity, OrganizationAnalysisModeEntity } from './organizationAnalysisEntity';
7
7
  /**
8
8
  * Input for `OrganizationAnalysisService.getOrganizationAnalysis` method.
9
9
  *
10
10
  * @interface GetOrganizationAnalysisInput
11
11
  * @property {string} domain The domain to analyze.
12
+ * @property {string} name Organization name to analyze (e.g. "amazon", "stripe"). When it resolves
13
+ * to a domain it takes precedence over `domain`; `domain` remains required and is used as the
14
+ * fallback when the name cannot be resolved.
12
15
  * @property {OrganizationAnalysisModeEntity} mode How to obtain source results. When omitted,
13
16
  * the backend behaves as ANALYZE.
17
+ * @property {OrganizationAnalysisDomainResolutionEntity} resolution How the requested domain is
18
+ * treated before analysis.
14
19
  */
15
20
  export interface GetOrganizationAnalysisInput {
16
21
  domain: string;
22
+ name?: string;
17
23
  mode?: OrganizationAnalysisModeEntity;
24
+ resolution?: OrganizationAnalysisDomainResolutionEntity;
18
25
  }
19
26
  /**
20
27
  * Core entity representation of an organization analysis service used in business logic.
@@ -18,6 +18,8 @@
18
18
  * @property {Date} lastScannedAt Date for when the virtual presence was last scanned.
19
19
  * @property {string} lastScanFailureReason Reason the most recent completed scan failed (an error/exception name).
20
20
  * Undefined when the most recent completed scan succeeded (or none has completed).
21
+ * @property {DataHolderCountEntity} dataHolderCount Counts of this virtual presence's data holders,
22
+ * broken down by protection state.
21
23
  * @property {Date} createdAt Date for when the virtual presence was created.
22
24
  * @property {Date} updatedAt Date for when the virtual presence was last updated.
23
25
  */
@@ -30,9 +32,31 @@ export interface VirtualPresenceEntity {
30
32
  state: VirtualPresenceStateEntity;
31
33
  lastScannedAt: Date;
32
34
  lastScanFailureReason?: string;
35
+ dataHolderCount: DataHolderCountEntity;
33
36
  createdAt: Date;
34
37
  updatedAt: Date;
35
38
  }
39
+ /**
40
+ * Core entity representation of a virtual presence's data holder counts,
41
+ * broken down by protection state.
42
+ *
43
+ * @interface DataHolderCountEntity
44
+ * @property {number} count Active (non-archived) data holders: the sum of monitored,
45
+ * initiatedActions, and completedActions. Excludes archived.
46
+ * @property {number} monitored Data holders the system has identified (protection state Monitored).
47
+ * @property {number} initiatedActions Data holders with an action in progress
48
+ * (protection state ActionRequested).
49
+ * @property {number} completedActions Data holders whose action has completed
50
+ * (protection state Resolved).
51
+ * @property {number} archived Data holders the user has archived (protection state Archived).
52
+ */
53
+ export interface DataHolderCountEntity {
54
+ count: number;
55
+ monitored: number;
56
+ initiatedActions: number;
57
+ completedActions: number;
58
+ archived: number;
59
+ }
36
60
  /**
37
61
  * Enumeration that defines the provider type of the virtual presence.
38
62
  *
@@ -0,0 +1,16 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { ActionEntity } from '../../entities/action/actionEntity';
7
+ import { ActionService } from '../../entities/action/actionService';
8
+ /**
9
+ * Application business logic for retrieving a single action.
10
+ */
11
+ export declare class GetActionUseCase {
12
+ private readonly actionService;
13
+ private readonly log;
14
+ constructor(actionService: ActionService);
15
+ execute(id: string): Promise<ActionEntity | undefined>;
16
+ }
@@ -0,0 +1,16 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { DataHolderEntity } from '../../entities/data-holder/dataHolderEntity';
7
+ import { DataHolderService } from '../../entities/data-holder/dataHolderService';
8
+ /**
9
+ * Application business logic for archiving a data holder.
10
+ */
11
+ export declare class ArchiveDataHolderUseCase {
12
+ private readonly dataHolderService;
13
+ private readonly log;
14
+ constructor(dataHolderService: DataHolderService);
15
+ execute(id: string): Promise<DataHolderEntity>;
16
+ }
@@ -0,0 +1,16 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { DataHolderEntity } from '../../entities/data-holder/dataHolderEntity';
7
+ import { DataHolderService } from '../../entities/data-holder/dataHolderService';
8
+ /**
9
+ * Application business logic for unarchiving a data holder.
10
+ */
11
+ export declare class UnarchiveDataHolderUseCase {
12
+ private readonly dataHolderService;
13
+ private readonly log;
14
+ constructor(dataHolderService: DataHolderService);
15
+ execute(id: string): Promise<DataHolderEntity>;
16
+ }
@@ -24,6 +24,7 @@ export declare class DefaultSudoPrivacyInteractionClient implements SudoPrivacyI
24
24
  private readonly analysisResultTransformer;
25
25
  private readonly organizationAnalysisTransformer;
26
26
  private readonly organizationAnalysisModeTransformer;
27
+ private readonly organizationAnalysisDomainResolutionTransformer;
27
28
  private readonly actionTransformer;
28
29
  private readonly availableActionTransformer;
29
30
  private readonly actionIntentTransformer;
@@ -41,6 +42,8 @@ export declare class DefaultSudoPrivacyInteractionClient implements SudoPrivacyI
41
42
  getDataHolder(id: string, options?: GetDataHolderOptions): Promise<DataHolder | undefined>;
42
43
  listDataHolders(input: ListDataHoldersInput): Promise<ListOutput<DataHolder>>;
43
44
  listDataHolderScanSummaries(input: ListDataHolderScanSummariesInput): Promise<ListOutput<DataHolderScanSummary>>;
45
+ archiveDataHolder(id: string): Promise<DataHolder>;
46
+ unarchiveDataHolder(id: string): Promise<DataHolder>;
44
47
  subscribeToDataHolders(subscriptionId: string, subscriber: DataHolderSubscriber): Promise<void>;
45
48
  unsubscribeFromDataHolders(subscriptionId: string): void;
46
49
  getAnalysisResult(id: string): Promise<AnalysisResult | undefined>;
@@ -49,6 +52,7 @@ export declare class DefaultSudoPrivacyInteractionClient implements SudoPrivacyI
49
52
  unsubscribeFromAnalysisResult(subscriptionId: string): void;
50
53
  getOrganizationAnalysis(input: GetOrganizationAnalysisInput): Promise<OrganizationAnalysis | undefined>;
51
54
  initiateAction(input: InitiateActionInput): Promise<Action>;
55
+ getAction(id: string): Promise<Action | undefined>;
52
56
  confirmActionOutcome(id: string): Promise<Action>;
53
57
  listAvailableActions(input: ListAvailableActionsInput): Promise<ListOutput<AvailableAction>>;
54
58
  subscribeToActions(subscriptionId: string, subscriber: ActionSubscriber): Promise<void>;
@@ -3,16 +3,23 @@
3
3
  *
4
4
  * SPDX-License-Identifier: Apache-2.0
5
5
  */
6
- import { OrganizationAnalysisMode } from '../typings/organizationAnalysis';
6
+ import { OrganizationAnalysisDomainResolution, OrganizationAnalysisMode } from '../typings/organizationAnalysis';
7
7
  /**
8
8
  * Properties required to obtain an organization analysis.
9
9
  *
10
10
  * @interface GetOrganizationAnalysisInput
11
11
  * @property {string} domain The domain to analyze.
12
+ * @property {string} name Organization name to analyze (e.g. "amazon", "stripe"). When it resolves
13
+ * to a domain it takes precedence over `domain`; `domain` remains required and is used as the
14
+ * fallback when the name cannot be resolved.
12
15
  * @property {OrganizationAnalysisMode} mode How to obtain source results. When omitted, the
13
16
  * backend behaves as `Analyze` (read-through).
17
+ * @property {OrganizationAnalysisDomainResolution} resolution How the requested domain is treated
18
+ * before analysis. When omitted, defaults to `Exact` (the domain is analyzed verbatim).
14
19
  */
15
20
  export interface GetOrganizationAnalysisInput {
16
21
  domain: string;
22
+ name?: string;
17
23
  mode?: OrganizationAnalysisMode;
24
+ resolution?: OrganizationAnalysisDomainResolution;
18
25
  }
@@ -91,6 +91,22 @@ export interface SudoPrivacyInteractionClient {
91
91
  * search criteria.
92
92
  */
93
93
  listDataHolderScanSummaries(input: ListDataHolderScanSummariesInput): Promise<ListOutput<DataHolderScanSummary>>;
94
+ /**
95
+ * Archive a data holder, removing it from the user's active list.
96
+ *
97
+ * @param {string} id The unique identifier of the data holder to archive.
98
+ * @returns {DataHolder} The archived data holder.
99
+ */
100
+ archiveDataHolder(id: string): Promise<DataHolder>;
101
+ /**
102
+ * Unarchive a previously archived data holder, returning it to the
103
+ * `Monitored` state. Only a data holder in the `Archived` state may be
104
+ * unarchived.
105
+ *
106
+ * @param {string} id The unique identifier of the data holder to unarchive.
107
+ * @returns {DataHolder} The unarchived data holder.
108
+ */
109
+ unarchiveDataHolder(id: string): Promise<DataHolder>;
94
110
  /**
95
111
  * Subscribe to data holder state events. Emitted when data holders are discovered
96
112
  * or updated during scanning.
@@ -154,6 +170,17 @@ export interface SudoPrivacyInteractionClient {
154
170
  * @returns {Action} The initiated action.
155
171
  */
156
172
  initiateAction(input: InitiateActionInput): Promise<Action>;
173
+ /**
174
+ * Read a single initiated action by id. Resolves an in-flight delegated
175
+ * action on read: if the action is still in progress, its outcome is polled
176
+ * and, once terminal, the action is updated to its verified result before
177
+ * being returned.
178
+ *
179
+ * @param {string} id The unique identifier of the action.
180
+ * @returns {Action | undefined} The action, or undefined if no action with the
181
+ * given id exists for the user.
182
+ */
183
+ getAction(id: string): Promise<Action | undefined>;
157
184
  /**
158
185
  * Confirm that an assisted or delegated action was completed, transitioning it
159
186
  * from `CompletedUnverified` to `CompletedVerified`.
@@ -260,7 +260,9 @@ export interface CategorySignals {
260
260
  * @property {SignalValue} supportsDataDeletionRequests Whether the organization supports data deletion requests.
261
261
  * @property {SignalValue} supportsDataExport Whether the organization supports data export.
262
262
  * @property {SignalValue} supportsSubscriptions Whether the organization supports subscription management.
263
+ * @property {SignalValue} supportsOptOutOfSale Whether the organization exposes an opt-out-of-sale control to users.
263
264
  * @property {SignalValue} sellsPersonalInformation Whether the organization sells personal information.
265
+ * @deprecated Use {@link CapabilitySignals.supportsOptOutOfSale} instead. Populated from `supportsOptOutOfSale`.
264
266
  * @property {SignalValue} usesCookiesOrTracking Whether the organization uses cookies or tracking.
265
267
  * @property {SignalValue} supportsTwoFactorAuth Whether the organization supports two-factor auth for logins.
266
268
  */
@@ -270,6 +272,11 @@ export interface CapabilitySignals {
270
272
  supportsDataDeletionRequests: SignalValue;
271
273
  supportsDataExport: SignalValue;
272
274
  supportsSubscriptions: SignalValue;
275
+ supportsOptOutOfSale: SignalValue;
276
+ /**
277
+ * @deprecated Use {@link CapabilitySignals.supportsOptOutOfSale} instead.
278
+ * Populated from the `supportsOptOutOfSale` value.
279
+ */
273
280
  sellsPersonalInformation: SignalValue;
274
281
  usesCookiesOrTracking: SignalValue;
275
282
  supportsTwoFactorAuth: SignalValue;
@@ -302,6 +309,7 @@ export interface RiskIndicators {
302
309
  * @enum
303
310
  */
304
311
  export declare enum OrganizationCategory {
312
+ AdultEntertainment = "AdultEntertainment",
305
313
  Automotive = "Automotive",
306
314
  Communications = "Communications",
307
315
  CommunityAndCharity = "CommunityAndCharity",
@@ -44,6 +44,7 @@ export interface DataHolder {
44
44
  * @property MONITORED The data holder is being monitored.
45
45
  * @property ACTION_REQUESTED An action has been requested against this data holder.
46
46
  * @property RESOLVED The data holder has been resolved.
47
+ * @property ARCHIVED The data holder has been archived by the user.
47
48
  *
48
49
  * @enum
49
50
  */
@@ -51,6 +52,7 @@ export declare enum DataHolderProtectionState {
51
52
  Monitored = "MONITORED",
52
53
  ActionRequested = "ACTION_REQUESTED",
53
54
  Resolved = "RESOLVED",
55
+ Archived = "ARCHIVED",
54
56
  Unknown = "UNKNOWN"
55
57
  }
56
58
  /**
@@ -51,3 +51,18 @@ export declare enum OrganizationAnalysisMode {
51
51
  Analyze = "ANALYZE",
52
52
  Fetch = "FETCH"
53
53
  }
54
+ /**
55
+ * Controls how `getOrganizationAnalysis` treats the requested domain before
56
+ * sources query their backing services.
57
+ *
58
+ * @property Registrable Reduce the domain to its registrable (eTLD+1) form before analysis,
59
+ * e.g. `mail.sub.example.co.uk` becomes `example.co.uk`.
60
+ * @property Exact Analyze the domain verbatim, without reducing it to a registrable domain.
61
+ * Used to analyze a specific host/subdomain rather than the organization.
62
+ *
63
+ * @enum
64
+ */
65
+ export declare enum OrganizationAnalysisDomainResolution {
66
+ Registrable = "REGISTRABLE",
67
+ Exact = "EXACT"
68
+ }
@@ -18,6 +18,8 @@
18
18
  * @property {Date} lastScannedAt Date for when the virtual presence was last scanned.
19
19
  * @property {string} lastScanFailureReason Reason the most recent completed scan failed (an error/exception name).
20
20
  * Undefined when the most recent completed scan succeeded (or none has completed).
21
+ * @property {DataHolderCount} dataHolderCount Counts of this virtual presence's data holders,
22
+ * broken down by protection state.
21
23
  * @property {Date} createdAt Date for when the virtual presence was created.
22
24
  * @property {Date} updatedAt Date for when the virtual presence was last updated.
23
25
  */
@@ -30,9 +32,32 @@ export interface VirtualPresence {
30
32
  state: VirtualPresenceState;
31
33
  lastScannedAt: Date;
32
34
  lastScanFailureReason?: string;
35
+ dataHolderCount: DataHolderCount;
33
36
  createdAt: Date;
34
37
  updatedAt: Date;
35
38
  }
39
+ /**
40
+ * Counts of a virtual presence's data holders, broken down by protection state.
41
+ *
42
+ * @interface DataHolderCount
43
+ * @property {number} count Active (non-archived) data holders: the sum of monitored,
44
+ * initiatedActions, and completedActions. Excludes archived.
45
+ * @property {number} monitored Data holders the system has identified
46
+ * (protection state Monitored).
47
+ * @property {number} initiatedActions Data holders with an action in progress
48
+ * (protection state ActionRequested).
49
+ * @property {number} completedActions Data holders whose action has completed
50
+ * (protection state Resolved).
51
+ * @property {number} archived Data holders the user has archived
52
+ * (protection state Archived).
53
+ */
54
+ export interface DataHolderCount {
55
+ count: number;
56
+ monitored: number;
57
+ initiatedActions: number;
58
+ completedActions: number;
59
+ archived: number;
60
+ }
36
61
  /**
37
62
  * Enumeration that defines the provider type of the virtual presence.
38
63
  *