@sudoplatform/sudo-privacy-interaction 2.2.0 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (121) hide show
  1. package/cjs/gen/graphqlTypes.js +443 -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/defaultAnalysisResultService.js +6 -0
  5. package/cjs/private/data/analysis-result/transformer/analysisResultStatusReasonTransformer.js +45 -0
  6. package/cjs/private/data/analysis-result/transformer/analysisResultTransformer.js +6 -0
  7. package/cjs/private/data/analysis-result/transformer/capabilitySignalsTransformer.js +5 -2
  8. package/cjs/private/data/analysis-result/transformer/organizationCategoryTransformer.js +4 -0
  9. package/cjs/private/data/common/apiClient.js +29 -1
  10. package/cjs/private/data/data-holder/defaultDataHolderService.js +8 -0
  11. package/cjs/private/data/data-holder/transformer/dataHolderProtectionStateTransformer.js +4 -0
  12. package/cjs/private/data/organization-analysis/defaultOrganizationAnalysisService.js +6 -0
  13. package/cjs/private/data/organization-analysis/transformer/organizationAnalysisDomainResolutionTransformer.js +29 -0
  14. package/cjs/private/data/organization-analysis/transformer/organizationAnalysisTransformer.js +6 -0
  15. package/cjs/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +8 -0
  16. package/cjs/private/domain/entities/analysis-result/analysisResultEntity.js +21 -1
  17. package/cjs/private/domain/entities/data-holder/dataHolderEntity.js +2 -0
  18. package/cjs/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +17 -1
  19. package/cjs/private/domain/use-cases/action/getActionUseCase.js +25 -0
  20. package/cjs/private/domain/use-cases/data-holder/archiveDataHolderUseCase.js +25 -0
  21. package/cjs/private/domain/use-cases/data-holder/unarchiveDataHolderUseCase.js +25 -0
  22. package/cjs/public/defaultSudoPrivacyInteractionClient.js +31 -0
  23. package/cjs/public/typings/analysisResult.js +21 -1
  24. package/cjs/public/typings/dataHolder.js +2 -0
  25. package/cjs/public/typings/organizationAnalysis.js +17 -1
  26. package/docs/assets/hierarchy.js +1 -1
  27. package/docs/assets/navigation.js +1 -1
  28. package/docs/assets/search.js +1 -1
  29. package/docs/classes/DefaultSudoPrivacyInteractionClient.html +93 -27
  30. package/docs/enums/AnalysisResultStatus.html +6 -6
  31. package/docs/enums/AnalysisResultStatusReason.html +81 -0
  32. package/docs/enums/DataCategory.html +18 -18
  33. package/docs/enums/DataHolderProtectionState.html +12 -6
  34. package/docs/enums/OrganizationAnalysisDomainResolution.html +70 -0
  35. package/docs/enums/OrganizationAnalysisMode.html +3 -3
  36. package/docs/enums/OrganizationCategory.html +38 -32
  37. package/docs/enums/ProviderType.html +3 -3
  38. package/docs/enums/RetentionStyle.html +5 -5
  39. package/docs/enums/ShareStyle.html +6 -6
  40. package/docs/enums/SignalValue.html +4 -4
  41. package/docs/enums/VirtualPresenceState.html +7 -7
  42. package/docs/hierarchy.html +6 -6
  43. package/docs/interfaces/AnalysisResult.html +21 -13
  44. package/docs/interfaces/AnalysisResultData.html +8 -8
  45. package/docs/interfaces/AnalysisResultUpdate.html +20 -12
  46. package/docs/interfaces/CapabilitySignals.html +41 -29
  47. package/docs/interfaces/CategorySignals.html +11 -11
  48. package/docs/interfaces/DataHolderCount.html +98 -0
  49. package/docs/interfaces/DataHolderScanSummary.html +14 -14
  50. package/docs/interfaces/GetOrganizationAnalysisInput.html +24 -5
  51. package/docs/interfaces/ListAnalysisResultsInput.html +1 -1
  52. package/docs/interfaces/ListDataHolderScanSummariesInput.html +1 -1
  53. package/docs/interfaces/ListDataHoldersInput.html +1 -1
  54. package/docs/interfaces/ListVirtualPresencesInput.html +1 -1
  55. package/docs/interfaces/OrganizationAnalysis.html +20 -12
  56. package/docs/interfaces/OrganizationIdentity.html +5 -5
  57. package/docs/interfaces/Pagination.html +1 -1
  58. package/docs/interfaces/PrivacyScore.html +4 -4
  59. package/docs/interfaces/PrivacySummary.html +4 -4
  60. package/docs/interfaces/RetentionInfo.html +4 -4
  61. package/docs/interfaces/RiskIndicators.html +8 -8
  62. package/docs/interfaces/ScoreContribution.html +3 -3
  63. package/docs/interfaces/ScoreCoverage.html +3 -3
  64. package/docs/interfaces/SudoPrivacyInteractionClient.html +78 -15
  65. package/docs/interfaces/VirtualPresence.html +22 -13
  66. package/docs/modules.html +4 -4
  67. package/docs/types/SudoPrivacyInteractionClientOptions.html +2 -2
  68. package/lib/gen/graphqlTypes.js +441 -10
  69. package/lib/gen/schema-types.js +1 -0
  70. package/lib/private/data/action/defaultActionService.js +7 -0
  71. package/lib/private/data/analysis-result/defaultAnalysisResultService.js +6 -0
  72. package/lib/private/data/analysis-result/transformer/analysisResultStatusReasonTransformer.js +41 -0
  73. package/lib/private/data/analysis-result/transformer/analysisResultTransformer.js +6 -0
  74. package/lib/private/data/analysis-result/transformer/capabilitySignalsTransformer.js +5 -2
  75. package/lib/private/data/analysis-result/transformer/organizationCategoryTransformer.js +4 -0
  76. package/lib/private/data/common/apiClient.js +30 -2
  77. package/lib/private/data/data-holder/defaultDataHolderService.js +8 -0
  78. package/lib/private/data/data-holder/transformer/dataHolderProtectionStateTransformer.js +4 -0
  79. package/lib/private/data/organization-analysis/defaultOrganizationAnalysisService.js +6 -0
  80. package/lib/private/data/organization-analysis/transformer/organizationAnalysisDomainResolutionTransformer.js +25 -0
  81. package/lib/private/data/organization-analysis/transformer/organizationAnalysisTransformer.js +6 -0
  82. package/lib/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +8 -0
  83. package/lib/private/domain/entities/analysis-result/analysisResultEntity.js +20 -0
  84. package/lib/private/domain/entities/data-holder/dataHolderEntity.js +2 -0
  85. package/lib/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +16 -0
  86. package/lib/private/domain/use-cases/action/getActionUseCase.js +21 -0
  87. package/lib/private/domain/use-cases/data-holder/archiveDataHolderUseCase.js +21 -0
  88. package/lib/private/domain/use-cases/data-holder/unarchiveDataHolderUseCase.js +21 -0
  89. package/lib/public/defaultSudoPrivacyInteractionClient.js +31 -0
  90. package/lib/public/typings/analysisResult.js +20 -0
  91. package/lib/public/typings/dataHolder.js +2 -0
  92. package/lib/public/typings/organizationAnalysis.js +16 -0
  93. package/package.json +19 -23
  94. package/types/gen/graphqlTypes.d.ts +338 -645
  95. package/types/gen/schema-types.d.ts +525 -0
  96. package/types/private/data/action/defaultActionService.d.ts +1 -0
  97. package/types/private/data/analysis-result/defaultAnalysisResultService.d.ts +1 -0
  98. package/types/private/data/analysis-result/transformer/analysisResultStatusReasonTransformer.d.ts +12 -0
  99. package/types/private/data/analysis-result/transformer/analysisResultTransformer.d.ts +1 -0
  100. package/types/private/data/common/apiClient.d.ts +6 -1
  101. package/types/private/data/data-holder/defaultDataHolderService.d.ts +2 -0
  102. package/types/private/data/organization-analysis/defaultOrganizationAnalysisService.d.ts +1 -0
  103. package/types/private/data/organization-analysis/transformer/organizationAnalysisDomainResolutionTransformer.d.ts +12 -0
  104. package/types/private/data/organization-analysis/transformer/organizationAnalysisTransformer.d.ts +1 -0
  105. package/types/private/domain/entities/action/actionService.d.ts +11 -0
  106. package/types/private/domain/entities/analysis-result/analysisResultEntity.d.ts +23 -2
  107. package/types/private/domain/entities/data-holder/dataHolderEntity.d.ts +2 -0
  108. package/types/private/domain/entities/data-holder/dataHolderService.d.ts +16 -0
  109. package/types/private/domain/entities/organization-analysis/organizationAnalysisEntity.d.ts +18 -1
  110. package/types/private/domain/entities/organization-analysis/organizationAnalysisService.d.ts +8 -1
  111. package/types/private/domain/entities/virtual-presence/virtualPresenceEntity.d.ts +24 -0
  112. package/types/private/domain/use-cases/action/getActionUseCase.d.ts +16 -0
  113. package/types/private/domain/use-cases/data-holder/archiveDataHolderUseCase.d.ts +16 -0
  114. package/types/private/domain/use-cases/data-holder/unarchiveDataHolderUseCase.d.ts +16 -0
  115. package/types/public/defaultSudoPrivacyInteractionClient.d.ts +4 -0
  116. package/types/public/inputs/organizationAnalysis.d.ts +8 -1
  117. package/types/public/sudoPrivacyInteractionClient.d.ts +27 -0
  118. package/types/public/typings/analysisResult.d.ts +30 -0
  119. package/types/public/typings/dataHolder.d.ts +2 -0
  120. package/types/public/typings/organizationAnalysis.d.ts +18 -1
  121. package/types/public/typings/virtualPresence.d.ts +25 -0
@@ -0,0 +1,525 @@
1
+ export type Maybe<T> = T | null;
2
+ export type InputMaybe<T> = Maybe<T>;
3
+ /** All built-in and custom scalars, mapped to their actual values */
4
+ export type Scalars = {
5
+ ID: {
6
+ input: string;
7
+ output: string;
8
+ };
9
+ String: {
10
+ input: string;
11
+ output: string;
12
+ };
13
+ Boolean: {
14
+ input: boolean;
15
+ output: boolean;
16
+ };
17
+ Int: {
18
+ input: number;
19
+ output: number;
20
+ };
21
+ Float: {
22
+ input: number;
23
+ output: number;
24
+ };
25
+ AWSDate: {
26
+ input: unknown;
27
+ output: unknown;
28
+ };
29
+ AWSDateTime: {
30
+ input: unknown;
31
+ output: unknown;
32
+ };
33
+ AWSEmail: {
34
+ input: unknown;
35
+ output: unknown;
36
+ };
37
+ AWSIPAddress: {
38
+ input: unknown;
39
+ output: unknown;
40
+ };
41
+ AWSJSON: {
42
+ input: unknown;
43
+ output: unknown;
44
+ };
45
+ AWSPhone: {
46
+ input: unknown;
47
+ output: unknown;
48
+ };
49
+ AWSTime: {
50
+ input: unknown;
51
+ output: unknown;
52
+ };
53
+ AWSTimestamp: {
54
+ input: unknown;
55
+ output: unknown;
56
+ };
57
+ AWSURL: {
58
+ input: unknown;
59
+ output: unknown;
60
+ };
61
+ };
62
+ export type Action = {
63
+ additionalInfo?: Maybe<Scalars['String']['output']>;
64
+ assistedPayload?: Maybe<AssistedPayload>;
65
+ completedAtEpochMs?: Maybe<Scalars['Float']['output']>;
66
+ createdAtEpochMs: Scalars['Float']['output'];
67
+ dataHolderId?: Maybe<Scalars['ID']['output']>;
68
+ fulfilmentMethod: ActionFulfilmentMethod;
69
+ id: Scalars['ID']['output'];
70
+ initiatedAtEpochMs?: Maybe<Scalars['Float']['output']>;
71
+ intent: ActionIntent;
72
+ owner: Scalars['ID']['output'];
73
+ status: ActionStatus;
74
+ updatedAtEpochMs: Scalars['Float']['output'];
75
+ version: Scalars['Int']['output'];
76
+ virtualPresenceId: Scalars['ID']['output'];
77
+ };
78
+ export type ActionContact = {
79
+ address?: Maybe<Scalars['String']['output']>;
80
+ email?: Maybe<Scalars['String']['output']>;
81
+ phone?: Maybe<Scalars['String']['output']>;
82
+ };
83
+ export type ActionFulfilmentMethod = 'ASSISTED' | 'DELEGATED' | '%future added value';
84
+ export type ActionIntent = 'ACCESS_MY_DATA' | 'DELETE_MY_DATA' | 'LIMIT_DATA_USE' | 'OTHER' | 'STOP_CONTACT' | '%future added value';
85
+ export type ActionOrigin = 'ANALYSIS' | 'DISCOVERY' | 'STATIC' | '%future added value';
86
+ export type ActionStatus = 'COMPLETED_UNVERIFIED' | 'COMPLETED_VERIFIED' | 'CONTRADICTED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING' | 'REQUIRES_USER_INPUT' | '%future added value';
87
+ export type AnalysisResult = {
88
+ createdAtEpochMs: Scalars['Float']['output'];
89
+ data?: Maybe<AnalysisResultData>;
90
+ dataHolderIdentifier: Scalars['String']['output'];
91
+ id: Scalars['ID']['output'];
92
+ lastAnalyzedAtEpochMs: Scalars['Float']['output'];
93
+ owner: Scalars['ID']['output'];
94
+ status: AnalysisResultStatus;
95
+ statusReason?: Maybe<AnalysisResultStatusReason>;
96
+ updatedAtEpochMs: Scalars['Float']['output'];
97
+ version: Scalars['Int']['output'];
98
+ virtualPresenceId: Scalars['ID']['output'];
99
+ };
100
+ export type AnalysisResultConnection = {
101
+ items: Array<AnalysisResult>;
102
+ nextToken?: Maybe<Scalars['String']['output']>;
103
+ };
104
+ export type AnalysisResultData = {
105
+ attribution: Array<Scalars['String']['output']>;
106
+ capabilities: CapabilitySignals;
107
+ categories: Array<CategorySignals>;
108
+ organizationIdentity?: Maybe<OrganizationIdentity>;
109
+ privacyScore?: Maybe<PrivacyScore>;
110
+ privacySummary: PrivacySummary;
111
+ riskIndicators: RiskIndicators;
112
+ };
113
+ export type AnalysisResultStatus = 'COMPLETE' | 'FAILED' | 'PARTIAL' | 'PENDING' | 'UNAVAILABLE' | '%future added value';
114
+ export type AnalysisResultStatusReason = 'INVALID_DOMAIN' | 'MALICIOUS' | 'NOT_ATTEMPTED' | 'OTHER' | 'POLICY_UNAVAILABLE' | '%future added value';
115
+ export type AnalysisResultUpdate = {
116
+ createdAtEpochMs: Scalars['Float']['output'];
117
+ dataHolderIdentifier: Scalars['String']['output'];
118
+ id: Scalars['ID']['output'];
119
+ lastAnalyzedAtEpochMs: Scalars['Float']['output'];
120
+ owner: Scalars['ID']['output'];
121
+ status: AnalysisResultStatus;
122
+ statusReason?: Maybe<AnalysisResultStatusReason>;
123
+ updatedAtEpochMs: Scalars['Float']['output'];
124
+ version: Scalars['Int']['output'];
125
+ virtualPresenceId: Scalars['ID']['output'];
126
+ };
127
+ export type AssistedEmailTemplate = {
128
+ body: Scalars['String']['output'];
129
+ subject?: Maybe<Scalars['String']['output']>;
130
+ };
131
+ export type AssistedPayload = {
132
+ contact?: Maybe<ActionContact>;
133
+ emailTemplate?: Maybe<AssistedEmailTemplate>;
134
+ instructions?: Maybe<Scalars['String']['output']>;
135
+ jurisdiction?: Maybe<Scalars['String']['output']>;
136
+ toAddress?: Maybe<Scalars['String']['output']>;
137
+ unsubscribeMailto?: Maybe<Scalars['String']['output']>;
138
+ unsubscribeUrl?: Maybe<Scalars['String']['output']>;
139
+ };
140
+ export type AuthCodeInput = {
141
+ authCode: Scalars['String']['input'];
142
+ redirectUri?: InputMaybe<Scalars['String']['input']>;
143
+ };
144
+ export type AvailableAction = {
145
+ additionalInfo?: Maybe<Scalars['String']['output']>;
146
+ description?: Maybe<Scalars['String']['output']>;
147
+ fulfilmentMethod: ActionFulfilmentMethod;
148
+ intent: ActionIntent;
149
+ origin: ActionOrigin;
150
+ title?: Maybe<Scalars['String']['output']>;
151
+ };
152
+ export type AvailableActionConnection = {
153
+ items: Array<AvailableAction>;
154
+ nextToken?: Maybe<Scalars['String']['output']>;
155
+ };
156
+ export type CapabilitySignals = {
157
+ supportsAccountCreation: SignalValue;
158
+ supportsAccountDeletion: SignalValue;
159
+ supportsDataDeletionRequests: SignalValue;
160
+ supportsDataExport: SignalValue;
161
+ supportsOptOutOfSale: SignalValue;
162
+ supportsSubscriptions: SignalValue;
163
+ supportsTwoFactorAuth: SignalValue;
164
+ usesCookiesOrTracking: SignalValue;
165
+ };
166
+ export type CategorySignals = {
167
+ category: DataCategory;
168
+ collected: SignalValue;
169
+ dataLabels: Array<Scalars['String']['output']>;
170
+ monetized: SignalValue;
171
+ requiredForLaw?: Maybe<SignalValue>;
172
+ requiredForService?: Maybe<SignalValue>;
173
+ retained: SignalValue;
174
+ retention?: Maybe<RetentionInfo>;
175
+ sharedWithThirdParties: ShareStyle;
176
+ userCanOptOut: SignalValue;
177
+ };
178
+ export type ConnectVirtualPresenceInput = {
179
+ authCode?: InputMaybe<AuthCodeInput>;
180
+ refreshToken?: InputMaybe<RefreshTokenInput>;
181
+ relationshipProvider?: InputMaybe<RelationshipProvider>;
182
+ };
183
+ export type DataCategory = 'ACCOUNT_PROFILE' | 'AUTHENTICATION' | 'BACKGROUND' | 'BIOMETRIC' | 'COMMUNICATION' | 'CONTACTS' | 'DEMOGRAPHIC' | 'DEVICE_IDENTIFIER' | 'FINANCIAL' | 'GOVERNMENT_ISSUED' | 'HEALTH' | 'INFERENCES' | 'LOCATION' | 'OTHER' | 'PII' | 'THIRD_PARTY_DATA' | 'USAGE' | '%future added value';
184
+ export type DataHolder = {
185
+ complianceConcern: Scalars['Boolean']['output'];
186
+ createdAtEpochMs: Scalars['Float']['output'];
187
+ domainName: Scalars['String']['output'];
188
+ id: Scalars['ID']['output'];
189
+ mostRecentInteractionEpochMs: Scalars['Float']['output'];
190
+ name: Scalars['String']['output'];
191
+ owner: Scalars['ID']['output'];
192
+ protectionState: DataHolderProtectionState;
193
+ updatedAtEpochMs: Scalars['Float']['output'];
194
+ version: Scalars['Int']['output'];
195
+ virtualPresenceId: Scalars['ID']['output'];
196
+ };
197
+ export type DataHolderChangeType = 'METADATA_UPDATE' | 'NEW' | 'SIGNIFICANT_UPDATE' | '%future added value';
198
+ export type DataHolderConnection = {
199
+ items: Array<DataHolder>;
200
+ nextToken?: Maybe<Scalars['String']['output']>;
201
+ };
202
+ export type DataHolderCount = {
203
+ archived: Scalars['Int']['output'];
204
+ completedActions: Scalars['Int']['output'];
205
+ count: Scalars['Int']['output'];
206
+ initiatedActions: Scalars['Int']['output'];
207
+ monitored: Scalars['Int']['output'];
208
+ };
209
+ export type DataHolderProtectionState = 'ACTION_REQUESTED' | 'ARCHIVED' | 'MONITORED' | 'RESOLVED' | '%future added value';
210
+ export type DataHolderScanSummary = {
211
+ categoryBreakdown: Scalars['AWSJSON']['output'];
212
+ dataHolderId: Scalars['ID']['output'];
213
+ emailCount: Scalars['Int']['output'];
214
+ marketingEmailCount: Scalars['Int']['output'];
215
+ marketingEmailOpened: Scalars['Int']['output'];
216
+ marketingOpenRate: Scalars['Float']['output'];
217
+ owner: Scalars['ID']['output'];
218
+ readCount: Scalars['Int']['output'];
219
+ readRate: Scalars['Float']['output'];
220
+ scanRangeFromEpochMs: Scalars['Float']['output'];
221
+ scanRangeToEpochMs: Scalars['Float']['output'];
222
+ scannedAtEpochMs: Scalars['Float']['output'];
223
+ uncategorizedCount: Scalars['Int']['output'];
224
+ };
225
+ export type DataHolderScanSummaryConnection = {
226
+ items: Array<DataHolderScanSummary>;
227
+ nextToken?: Maybe<Scalars['String']['output']>;
228
+ };
229
+ export type DataHolderUpdateItem = {
230
+ complianceConcern: Scalars['Boolean']['output'];
231
+ createdAtEpochMs: Scalars['Float']['output'];
232
+ domainName: Scalars['String']['output'];
233
+ id: Scalars['ID']['output'];
234
+ mostRecentInteractionEpochMs: Scalars['Float']['output'];
235
+ name: Scalars['String']['output'];
236
+ owner: Scalars['ID']['output'];
237
+ protectionState: DataHolderProtectionState;
238
+ updatedAtEpochMs: Scalars['Float']['output'];
239
+ version: Scalars['Int']['output'];
240
+ virtualPresenceId: Scalars['ID']['output'];
241
+ };
242
+ /**
243
+ * A batch of data holder updates emitted during discovery.
244
+ * Contains all data holders discovered in a single page with their change types.
245
+ */
246
+ export type DataHoldersUpdate = {
247
+ items: Array<DataHolderUpdateItem>;
248
+ owner: Scalars['ID']['output'];
249
+ };
250
+ export type InitiateActionInput = {
251
+ dataHolderId: Scalars['ID']['input'];
252
+ fulfilmentMethod: ActionFulfilmentMethod;
253
+ intent: ActionIntent;
254
+ };
255
+ export type ListVirtualPresencesInput = {
256
+ limit?: InputMaybe<Scalars['Int']['input']>;
257
+ nextToken?: InputMaybe<Scalars['String']['input']>;
258
+ };
259
+ export type Mutation = {
260
+ /** Archive a data holder, removing it from the user's active list. */
261
+ archiveDataHolder: DataHolder;
262
+ /**
263
+ * Confirm that an assisted or delegated action was completed, transitioning it
264
+ * from COMPLETED_UNVERIFIED to COMPLETED_VERIFIED.
265
+ */
266
+ confirmActionOutcome: Action;
267
+ /** Connect a virtual presence. */
268
+ connectVirtualPresence: VirtualPresence;
269
+ /** Disconnect a virtual presence. */
270
+ disconnectVirtualPresence: VirtualPresence;
271
+ /**
272
+ * Initiate an action against a data holder relationship. Delegated actions are
273
+ * performed on the user's behalf; assisted actions return structured materials
274
+ * for the client to complete.
275
+ */
276
+ initiateAction: Action;
277
+ /**
278
+ * Rescan an existing virtual presence for new data holders.
279
+ * Scans from the last scan date forward.
280
+ */
281
+ rescanVirtualPresence: VirtualPresence;
282
+ /**
283
+ * Unarchive a previously archived data holder, clearing the user's archive
284
+ * setting and returning it to the MONITORED state. Only a data holder in the
285
+ * ARCHIVED state may be unarchived.
286
+ */
287
+ unarchiveDataHolder: DataHolder;
288
+ };
289
+ export type MutationArchiveDataHolderArgs = {
290
+ id: Scalars['ID']['input'];
291
+ };
292
+ export type MutationConfirmActionOutcomeArgs = {
293
+ id: Scalars['ID']['input'];
294
+ };
295
+ export type MutationConnectVirtualPresenceArgs = {
296
+ input?: InputMaybe<ConnectVirtualPresenceInput>;
297
+ };
298
+ export type MutationDisconnectVirtualPresenceArgs = {
299
+ id: Scalars['String']['input'];
300
+ };
301
+ export type MutationInitiateActionArgs = {
302
+ input: InitiateActionInput;
303
+ };
304
+ export type MutationRescanVirtualPresenceArgs = {
305
+ id: Scalars['String']['input'];
306
+ options?: InputMaybe<ScanOptionsInput>;
307
+ };
308
+ export type MutationUnarchiveDataHolderArgs = {
309
+ id: Scalars['ID']['input'];
310
+ };
311
+ export type OrganizationAnalysis = {
312
+ createdAtEpochMs: Scalars['Float']['output'];
313
+ data?: Maybe<AnalysisResultData>;
314
+ domain: Scalars['String']['output'];
315
+ id: Scalars['ID']['output'];
316
+ lastAnalyzedAtEpochMs: Scalars['Float']['output'];
317
+ owner: Scalars['ID']['output'];
318
+ status: AnalysisResultStatus;
319
+ statusReason?: Maybe<AnalysisResultStatusReason>;
320
+ updatedAtEpochMs: Scalars['Float']['output'];
321
+ version: Scalars['Int']['output'];
322
+ };
323
+ export type OrganizationAnalysisDomainResolution = 'EXACT' | 'REGISTRABLE' | '%future added value';
324
+ export type OrganizationAnalysisMode = 'ANALYZE' | 'FETCH' | '%future added value';
325
+ export type OrganizationAnalysisOptions = {
326
+ mode?: InputMaybe<OrganizationAnalysisMode>;
327
+ resolution?: InputMaybe<OrganizationAnalysisDomainResolution>;
328
+ };
329
+ export type OrganizationCategory = 'AdTechAndMarketing' | 'AdultEntertainment' | 'Automotive' | 'Communications' | 'CommunityAndCharity' | 'Cryptocurrency' | 'DataBroker' | 'Dating' | 'Education' | 'Employment' | 'EnergyAndUtilities' | 'Entertainment' | 'Finance' | 'FoodAndDining' | 'Gambling' | 'Government' | 'Health' | 'Insurance' | 'Military' | 'News' | 'Other' | 'PersonalEmail' | 'PrivacyAndSecurity' | 'RealEstate' | 'ShippingAndDelivery' | 'Shopping' | 'SocialMedia' | 'SportsAndFitness' | 'Technology' | 'Transportation' | 'Travel' | 'VideoGames' | '%future added value';
330
+ export type OrganizationIdentity = {
331
+ brandName?: Maybe<Scalars['String']['output']>;
332
+ categories: Array<OrganizationCategory>;
333
+ companyName?: Maybe<Scalars['String']['output']>;
334
+ primaryCategory?: Maybe<OrganizationCategory>;
335
+ };
336
+ export type PrivacyScore = {
337
+ breakdown: Array<ScoreContribution>;
338
+ coverage: ScoreCoverage;
339
+ score: Scalars['Float']['output'];
340
+ };
341
+ export type PrivacySummary = {
342
+ bulletPoints: Array<Scalars['String']['output']>;
343
+ sourceLastUpdated?: Maybe<Scalars['String']['output']>;
344
+ sourceUrl: Scalars['String']['output'];
345
+ };
346
+ export type ProviderConfiguration = {
347
+ data: Scalars['ID']['output'];
348
+ };
349
+ export type ProviderType = 'EMAIL' | '%future added value';
350
+ export type Query = {
351
+ /**
352
+ * Read a single initiated action by id. Resolves an in-flight delegated action
353
+ * on read: if the action is still in progress, its outcome is polled and, once
354
+ * terminal, the action is updated to its verified result before being returned.
355
+ * Returns null when no action with the given id exists for the user.
356
+ */
357
+ getAction?: Maybe<Action>;
358
+ /** Get a full analysis result by ID, including typed data. */
359
+ getAnalysisResult?: Maybe<AnalysisResult>;
360
+ /** Get a single data holder by ID */
361
+ getDataHolder?: Maybe<DataHolder>;
362
+ /**
363
+ * Analyze (read-through) and return the shared, organization-generic analysis
364
+ * for a domain. Returns PENDING when an asynchronous source is still resolving;
365
+ * re-query for the terminal result.
366
+ *
367
+ * Pass `options` to control the analysis mode and domain resolution. When no
368
+ * mode is supplied the behaviour is ANALYZE, and resolution defaults to
369
+ * REGISTRABLE.
370
+ *
371
+ * Pass `name` to analyze by organization name (e.g. "amazon", "stripe"). The
372
+ * name is resolved to a domain and takes precedence over `domain` when it
373
+ * resolves; `domain` remains required and is used as the fallback when the name
374
+ * cannot be resolved (including when name resolution is unavailable).
375
+ */
376
+ getOrganizationAnalysis?: Maybe<OrganizationAnalysis>;
377
+ /**
378
+ * Get the opaque provider configuration required by consumers to support
379
+ * the provider OAuth flow.
380
+ */
381
+ getProviderConfiguration: ProviderConfiguration;
382
+ /** List analysis results for a virtual presence. */
383
+ listAnalysisResults: AnalysisResultConnection;
384
+ /**
385
+ * List the actions currently available for a data holder relationship. Derived
386
+ * at query time by merging static, analysis, and discovery sources; not
387
+ * persisted. The owning virtual presence is derived from the data holder.
388
+ */
389
+ listAvailableActions: AvailableActionConnection;
390
+ /** List scan summaries for a data holder (most recent first) */
391
+ listDataHolderScanSummaries: DataHolderScanSummaryConnection;
392
+ /** List data holders by virtual presence */
393
+ listDataHolders: DataHolderConnection;
394
+ /** List virtual presences for the authenticated user */
395
+ listVirtualPresences: VirtualPresenceConnection;
396
+ };
397
+ export type QueryGetActionArgs = {
398
+ id: Scalars['ID']['input'];
399
+ };
400
+ export type QueryGetAnalysisResultArgs = {
401
+ id: Scalars['ID']['input'];
402
+ };
403
+ export type QueryGetDataHolderArgs = {
404
+ id: Scalars['ID']['input'];
405
+ };
406
+ export type QueryGetOrganizationAnalysisArgs = {
407
+ domain: Scalars['String']['input'];
408
+ name?: InputMaybe<Scalars['String']['input']>;
409
+ options?: InputMaybe<OrganizationAnalysisOptions>;
410
+ };
411
+ export type QueryListAnalysisResultsArgs = {
412
+ limit?: InputMaybe<Scalars['Int']['input']>;
413
+ nextToken?: InputMaybe<Scalars['String']['input']>;
414
+ virtualPresenceId: Scalars['ID']['input'];
415
+ };
416
+ export type QueryListAvailableActionsArgs = {
417
+ dataHolderId: Scalars['ID']['input'];
418
+ };
419
+ export type QueryListDataHolderScanSummariesArgs = {
420
+ dataHolderId: Scalars['ID']['input'];
421
+ limit?: InputMaybe<Scalars['Int']['input']>;
422
+ nextToken?: InputMaybe<Scalars['String']['input']>;
423
+ };
424
+ export type QueryListDataHoldersArgs = {
425
+ limit?: InputMaybe<Scalars['Int']['input']>;
426
+ nextToken?: InputMaybe<Scalars['String']['input']>;
427
+ virtualPresenceId: Scalars['ID']['input'];
428
+ };
429
+ export type QueryListVirtualPresencesArgs = {
430
+ input?: InputMaybe<ListVirtualPresencesInput>;
431
+ };
432
+ export type RefreshTokenInput = {
433
+ expiresInEpochMs?: InputMaybe<Scalars['Float']['input']>;
434
+ providerIdentity: Scalars['String']['input'];
435
+ refreshToken: Scalars['String']['input'];
436
+ scopes?: InputMaybe<Array<Scalars['String']['input']>>;
437
+ };
438
+ export type RelationshipProvider = 'GMAIL_PROVIDER' | 'TEST_PROVIDER' | '%future added value';
439
+ export type RetentionInfo = {
440
+ additionalInfo?: Maybe<Scalars['String']['output']>;
441
+ style: RetentionStyle;
442
+ timeInDays?: Maybe<Scalars['Int']['output']>;
443
+ };
444
+ export type RetentionStyle = 'INDEFINITE' | 'OTHER' | 'RELATIVE_TO_ACCOUNT_CLOSURE_TIME' | 'RELATIVE_TO_DATA_STORAGE_TIME' | '%future added value';
445
+ export type RiskIndicators = {
446
+ breachRisk: SignalValue;
447
+ collectsSensitiveDataForNonEssentialPurposes: SignalValue;
448
+ dataCollectionBreadth: Scalars['Int']['output'];
449
+ encryptionPractices: SignalValue;
450
+ hasIndefiniteRetention: SignalValue;
451
+ maxRetentionDays?: Maybe<Scalars['Int']['output']>;
452
+ sellsPersonalInformation: SignalValue;
453
+ };
454
+ export type ScanOptionsInput = {
455
+ earliestScanDate?: InputMaybe<Scalars['String']['input']>;
456
+ excludeCategories?: InputMaybe<Array<Scalars['String']['input']>>;
457
+ excludeDomains?: InputMaybe<Array<Scalars['String']['input']>>;
458
+ latestScanDate?: InputMaybe<Scalars['String']['input']>;
459
+ maximumItemsProcessed?: InputMaybe<Scalars['Int']['input']>;
460
+ };
461
+ export type ScoreContribution = {
462
+ aspect: Scalars['String']['output'];
463
+ contribution: Scalars['Float']['output'];
464
+ };
465
+ export type ScoreCoverage = {
466
+ evaluated: Scalars['Int']['output'];
467
+ total: Scalars['Int']['output'];
468
+ };
469
+ export type ShareStyle = 'INFERENCE_SHARED' | 'NONE' | 'SHARED' | 'SHARED_WITH_CONSENT' | '%future added value';
470
+ export type SignalValue = 'NO' | 'UNKNOWN' | 'YES' | '%future added value';
471
+ export type Subscription = {
472
+ /**
473
+ * Subscribe to action status updates for the authenticated user.
474
+ * Emitted each time an action's status changes. Carries the scalar fields of the
475
+ * action; re-query the action to fetch the full assistedPayload.
476
+ */
477
+ onActionStatusUpdate?: Maybe<Action>;
478
+ /**
479
+ * Subscribe to analysis result updates for the authenticated user.
480
+ * Emitted each time an analysis result is created or updated.
481
+ * Use getAnalysisResult to fetch the full typed data.
482
+ */
483
+ onAnalysisResultUpdate?: Maybe<AnalysisResultUpdate>;
484
+ /**
485
+ * Subscribe to batch data holder updates during discovery.
486
+ * Emitted once per discovery page with all data holders found in that page.
487
+ */
488
+ onDataHoldersUpdate?: Maybe<DataHoldersUpdate>;
489
+ /**
490
+ * Subscribe to virtual presence state updates for the authenticated user.
491
+ * Emitted when a virtual presence changes state (e.g. to NEEDS_REAUTH).
492
+ */
493
+ onVirtualPresenceUpdate?: Maybe<VirtualPresence>;
494
+ };
495
+ export type SubscriptionOnActionStatusUpdateArgs = {
496
+ owner: Scalars['ID']['input'];
497
+ };
498
+ export type SubscriptionOnAnalysisResultUpdateArgs = {
499
+ owner: Scalars['ID']['input'];
500
+ };
501
+ export type SubscriptionOnDataHoldersUpdateArgs = {
502
+ owner: Scalars['ID']['input'];
503
+ };
504
+ export type SubscriptionOnVirtualPresenceUpdateArgs = {
505
+ owner: Scalars['ID']['input'];
506
+ };
507
+ export type VirtualPresence = {
508
+ createdAtEpochMs: Scalars['Float']['output'];
509
+ dataHolderCount: DataHolderCount;
510
+ id: Scalars['ID']['output'];
511
+ identifier: Scalars['String']['output'];
512
+ lastScanFailureReason?: Maybe<Scalars['String']['output']>;
513
+ lastScannedAtEpochMs: Scalars['Float']['output'];
514
+ owner: Scalars['ID']['output'];
515
+ providerType: ProviderType;
516
+ relationshipProvider?: Maybe<RelationshipProvider>;
517
+ state: VirtualPresenceState;
518
+ updatedAtEpochMs: Scalars['Float']['output'];
519
+ version: Scalars['Int']['output'];
520
+ };
521
+ export type VirtualPresenceConnection = {
522
+ items: Array<VirtualPresence>;
523
+ nextToken?: Maybe<Scalars['String']['output']>;
524
+ };
525
+ export type VirtualPresenceState = 'CONNECTED' | 'ERROR' | 'INACTIVE' | 'NEEDS_REAUTH' | 'SCANNING' | '%future added value';
@@ -15,6 +15,7 @@ export declare class DefaultActionService implements ActionService {
15
15
  private readonly subscriptionManager;
16
16
  constructor(appSync: ApiClient);
17
17
  initiate(input: InitiateActionInput): Promise<ActionEntity>;
18
+ get(id: string): Promise<ActionEntity | undefined>;
18
19
  confirmOutcome(id: string): Promise<ActionEntity>;
19
20
  listAvailable(input: ListAvailableActionsInput): Promise<ListAvailableActionsOutput>;
20
21
  subscribe(input: SubscribeToActionsInput): Promise<void>;
@@ -10,6 +10,7 @@ export declare class DefaultAnalysisResultService implements AnalysisResultServi
10
10
  private readonly appSync;
11
11
  private readonly analysisResultTransformer;
12
12
  private readonly analysisResultStatusTransformer;
13
+ private readonly analysisResultStatusReasonTransformer;
13
14
  private readonly subscriptionManager;
14
15
  constructor(appSync: ApiClient);
15
16
  get(id: string): Promise<AnalysisResultEntity | undefined>;
@@ -0,0 +1,12 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { AnalysisResultStatusReason as AnalysisResultStatusReasonGraphQL } from '../../../../gen/graphqlTypes';
7
+ import { AnalysisResultStatusReason } from '../../../../public/typings/analysisResult';
8
+ import { AnalysisResultStatusReasonEntity } from '../../../domain/entities/analysis-result/analysisResultEntity';
9
+ export declare class AnalysisResultStatusReasonTransformer {
10
+ fromGraphQLToEntity(data: AnalysisResultStatusReasonGraphQL | null | undefined): AnalysisResultStatusReasonEntity | undefined;
11
+ fromEntityToAPI(entity: AnalysisResultStatusReasonEntity | undefined): AnalysisResultStatusReason | undefined;
12
+ }
@@ -8,6 +8,7 @@ import { AnalysisResult } from '../../../../public/typings/analysisResult';
8
8
  import { AnalysisResultEntity } from '../../../domain/entities/analysis-result/analysisResultEntity';
9
9
  export declare class AnalysisResultTransformer {
10
10
  private readonly statusTransformer;
11
+ private readonly statusReasonTransformer;
11
12
  private readonly dataTransformer;
12
13
  fromGraphQLToEntity(data: AnalysisResultGraphQL): AnalysisResultEntity;
13
14
  fromEntityToAPI(entity: AnalysisResultEntity): AnalysisResult;
@@ -5,7 +5,7 @@
5
5
  */
6
6
  import { ApiClientManager } from '@sudoplatform/sudo-api-client';
7
7
  import Observable from 'zen-observable';
8
- import { AnalysisResult, AnalysisResultConnection, Action, AvailableActionConnection, ConnectVirtualPresenceInput, DataHolder, DataHolderConnection, DataHolderScanSummaryConnection, InitiateActionInput, OrganizationAnalysis, OrganizationAnalysisMode, ProviderConfiguration, ListVirtualPresencesInput, OnActionStatusUpdateSubscription, OnAnalysisResultUpdateSubscription, OnDataHoldersUpdateSubscription, OnVirtualPresenceUpdateSubscription, ScanOptionsInput, VirtualPresence, VirtualPresenceConnection } from '../../../gen/graphqlTypes';
8
+ import { AnalysisResult, AnalysisResultConnection, Action, AvailableActionConnection, ConnectVirtualPresenceInput, DataHolder, DataHolderConnection, DataHolderScanSummaryConnection, InitiateActionInput, OrganizationAnalysis, OrganizationAnalysisDomainResolution, OrganizationAnalysisMode, ProviderConfiguration, ListVirtualPresencesInput, OnActionStatusUpdateSubscription, OnAnalysisResultUpdateSubscription, OnDataHoldersUpdateSubscription, OnVirtualPresenceUpdateSubscription, ScanOptionsInput, VirtualPresence, VirtualPresenceConnection } from '../../../gen/graphqlTypes';
9
9
  import { SubscriptionResult } from './baseSubscriptionManager';
10
10
  export declare class ApiClient {
11
11
  private readonly log;
@@ -28,10 +28,14 @@ export declare class ApiClient {
28
28
  limit?: number;
29
29
  nextToken?: string;
30
30
  }): Promise<DataHolderScanSummaryConnection>;
31
+ archiveDataHolder(id: string): Promise<DataHolder>;
32
+ unarchiveDataHolder(id: string): Promise<DataHolder>;
31
33
  getAnalysisResult(id: string): Promise<AnalysisResult | undefined>;
32
34
  getOrganizationAnalysis(input: {
33
35
  domain: string;
36
+ name?: string;
34
37
  mode?: OrganizationAnalysisMode;
38
+ resolution?: OrganizationAnalysisDomainResolution;
35
39
  }): Promise<OrganizationAnalysis | undefined>;
36
40
  listAnalysisResults(input: {
37
41
  virtualPresenceId: string;
@@ -40,6 +44,7 @@ export declare class ApiClient {
40
44
  }): Promise<AnalysisResultConnection>;
41
45
  initiateAction(input: InitiateActionInput): Promise<Action>;
42
46
  confirmActionOutcome(id: string): Promise<Action>;
47
+ getAction(id: string): Promise<Action | undefined>;
43
48
  listAvailableActions(input: {
44
49
  dataHolderId: string;
45
50
  }): Promise<AvailableActionConnection>;
@@ -15,6 +15,8 @@ export declare class DefaultDataHolderService implements DataHolderService {
15
15
  get(id: string): Promise<DataHolderEntity | undefined>;
16
16
  list(input: ListDataHoldersInput): Promise<ListDataHoldersOutput>;
17
17
  listScanSummaries(input: ListDataHolderScanSummariesInput): Promise<ListDataHolderScanSummariesOutput>;
18
+ archive(id: string): Promise<DataHolderEntity>;
19
+ unarchive(id: string): Promise<DataHolderEntity>;
18
20
  subscribe(input: SubscribeToDataHoldersInput): Promise<void>;
19
21
  unsubscribe(subscriptionId: string): void;
20
22
  private setupUpdateSubscription;
@@ -10,6 +10,7 @@ export declare class DefaultOrganizationAnalysisService implements OrganizationA
10
10
  private readonly appSync;
11
11
  private readonly organizationAnalysisTransformer;
12
12
  private readonly modeTransformer;
13
+ private readonly resolutionTransformer;
13
14
  constructor(appSync: ApiClient);
14
15
  getOrganizationAnalysis(input: GetOrganizationAnalysisInput): Promise<OrganizationAnalysisEntity | undefined>;
15
16
  }
@@ -0,0 +1,12 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { OrganizationAnalysisDomainResolution as OrganizationAnalysisDomainResolutionGraphQL } from '../../../../gen/graphqlTypes';
7
+ import { OrganizationAnalysisDomainResolution } from '../../../../public/typings/organizationAnalysis';
8
+ import { OrganizationAnalysisDomainResolutionEntity } from '../../../domain/entities/organization-analysis/organizationAnalysisEntity';
9
+ export declare class OrganizationAnalysisDomainResolutionTransformer {
10
+ fromAPIToEntity(resolution: OrganizationAnalysisDomainResolution): OrganizationAnalysisDomainResolutionEntity;
11
+ fromEntityToGraphQL(resolution: OrganizationAnalysisDomainResolutionEntity): OrganizationAnalysisDomainResolutionGraphQL;
12
+ }
@@ -8,6 +8,7 @@ import { OrganizationAnalysis } from '../../../../public/typings/organizationAna
8
8
  import { OrganizationAnalysisEntity } from '../../../domain/entities/organization-analysis/organizationAnalysisEntity';
9
9
  export declare class OrganizationAnalysisTransformer {
10
10
  private readonly statusTransformer;
11
+ private readonly statusReasonTransformer;
11
12
  private readonly dataTransformer;
12
13
  fromGraphQLToEntity(data: OrganizationAnalysisGraphQL): OrganizationAnalysisEntity;
13
14
  fromEntityToAPI(entity: OrganizationAnalysisEntity): OrganizationAnalysis;
@@ -67,6 +67,17 @@ export interface ActionService {
67
67
  * @returns {ActionEntity} The initiated action.
68
68
  */
69
69
  initiate(input: InitiateActionInput): Promise<ActionEntity>;
70
+ /**
71
+ * Read a single initiated action by id. Resolves an in-flight delegated
72
+ * action on read: if the action is still in progress, its outcome is polled
73
+ * and, once terminal, the action is updated to its verified result before
74
+ * being returned.
75
+ *
76
+ * @param {string} id The unique identifier of the action.
77
+ * @returns {ActionEntity | undefined} The action, or undefined if no action
78
+ * with the given id exists for the user.
79
+ */
80
+ get(id: string): Promise<ActionEntity | undefined>;
70
81
  /**
71
82
  * Confirm that an assisted or delegated action was completed, transitioning it
72
83
  * from `CompletedUnverified` to `CompletedVerified`.