@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
@@ -0,0 +1,521 @@
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
+ updatedAtEpochMs: Scalars['Float']['output'];
96
+ version: Scalars['Int']['output'];
97
+ virtualPresenceId: Scalars['ID']['output'];
98
+ };
99
+ export type AnalysisResultConnection = {
100
+ items: Array<AnalysisResult>;
101
+ nextToken?: Maybe<Scalars['String']['output']>;
102
+ };
103
+ export type AnalysisResultData = {
104
+ attribution: Array<Scalars['String']['output']>;
105
+ capabilities: CapabilitySignals;
106
+ categories: Array<CategorySignals>;
107
+ organizationIdentity?: Maybe<OrganizationIdentity>;
108
+ privacyScore?: Maybe<PrivacyScore>;
109
+ privacySummary: PrivacySummary;
110
+ riskIndicators: RiskIndicators;
111
+ };
112
+ export type AnalysisResultStatus = 'COMPLETE' | 'FAILED' | 'PARTIAL' | 'PENDING' | 'UNAVAILABLE' | '%future added value';
113
+ export type AnalysisResultUpdate = {
114
+ createdAtEpochMs: Scalars['Float']['output'];
115
+ dataHolderIdentifier: Scalars['String']['output'];
116
+ id: Scalars['ID']['output'];
117
+ lastAnalyzedAtEpochMs: Scalars['Float']['output'];
118
+ owner: Scalars['ID']['output'];
119
+ status: AnalysisResultStatus;
120
+ updatedAtEpochMs: Scalars['Float']['output'];
121
+ version: Scalars['Int']['output'];
122
+ virtualPresenceId: Scalars['ID']['output'];
123
+ };
124
+ export type AssistedEmailTemplate = {
125
+ body: Scalars['String']['output'];
126
+ subject?: Maybe<Scalars['String']['output']>;
127
+ };
128
+ export type AssistedPayload = {
129
+ contact?: Maybe<ActionContact>;
130
+ emailTemplate?: Maybe<AssistedEmailTemplate>;
131
+ instructions?: Maybe<Scalars['String']['output']>;
132
+ jurisdiction?: Maybe<Scalars['String']['output']>;
133
+ toAddress?: Maybe<Scalars['String']['output']>;
134
+ unsubscribeMailto?: Maybe<Scalars['String']['output']>;
135
+ unsubscribeUrl?: Maybe<Scalars['String']['output']>;
136
+ };
137
+ export type AuthCodeInput = {
138
+ authCode: Scalars['String']['input'];
139
+ redirectUri?: InputMaybe<Scalars['String']['input']>;
140
+ };
141
+ export type AvailableAction = {
142
+ additionalInfo?: Maybe<Scalars['String']['output']>;
143
+ description?: Maybe<Scalars['String']['output']>;
144
+ fulfilmentMethod: ActionFulfilmentMethod;
145
+ intent: ActionIntent;
146
+ origin: ActionOrigin;
147
+ title?: Maybe<Scalars['String']['output']>;
148
+ };
149
+ export type AvailableActionConnection = {
150
+ items: Array<AvailableAction>;
151
+ nextToken?: Maybe<Scalars['String']['output']>;
152
+ };
153
+ export type CapabilitySignals = {
154
+ supportsAccountCreation: SignalValue;
155
+ supportsAccountDeletion: SignalValue;
156
+ supportsDataDeletionRequests: SignalValue;
157
+ supportsDataExport: SignalValue;
158
+ supportsOptOutOfSale: SignalValue;
159
+ supportsSubscriptions: SignalValue;
160
+ supportsTwoFactorAuth: SignalValue;
161
+ usesCookiesOrTracking: SignalValue;
162
+ };
163
+ export type CategorySignals = {
164
+ category: DataCategory;
165
+ collected: SignalValue;
166
+ dataLabels: Array<Scalars['String']['output']>;
167
+ monetized: SignalValue;
168
+ requiredForLaw?: Maybe<SignalValue>;
169
+ requiredForService?: Maybe<SignalValue>;
170
+ retained: SignalValue;
171
+ retention?: Maybe<RetentionInfo>;
172
+ sharedWithThirdParties: ShareStyle;
173
+ userCanOptOut: SignalValue;
174
+ };
175
+ export type ConnectVirtualPresenceInput = {
176
+ authCode?: InputMaybe<AuthCodeInput>;
177
+ refreshToken?: InputMaybe<RefreshTokenInput>;
178
+ relationshipProvider?: InputMaybe<RelationshipProvider>;
179
+ };
180
+ 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';
181
+ export type DataHolder = {
182
+ complianceConcern: Scalars['Boolean']['output'];
183
+ createdAtEpochMs: Scalars['Float']['output'];
184
+ domainName: Scalars['String']['output'];
185
+ id: Scalars['ID']['output'];
186
+ mostRecentInteractionEpochMs: Scalars['Float']['output'];
187
+ name: Scalars['String']['output'];
188
+ owner: Scalars['ID']['output'];
189
+ protectionState: DataHolderProtectionState;
190
+ updatedAtEpochMs: Scalars['Float']['output'];
191
+ version: Scalars['Int']['output'];
192
+ virtualPresenceId: Scalars['ID']['output'];
193
+ };
194
+ export type DataHolderChangeType = 'METADATA_UPDATE' | 'NEW' | 'SIGNIFICANT_UPDATE' | '%future added value';
195
+ export type DataHolderConnection = {
196
+ items: Array<DataHolder>;
197
+ nextToken?: Maybe<Scalars['String']['output']>;
198
+ };
199
+ export type DataHolderCount = {
200
+ archived: Scalars['Int']['output'];
201
+ completedActions: Scalars['Int']['output'];
202
+ count: Scalars['Int']['output'];
203
+ initiatedActions: Scalars['Int']['output'];
204
+ monitored: Scalars['Int']['output'];
205
+ };
206
+ export type DataHolderProtectionState = 'ACTION_REQUESTED' | 'ARCHIVED' | 'MONITORED' | 'RESOLVED' | '%future added value';
207
+ export type DataHolderScanSummary = {
208
+ categoryBreakdown: Scalars['AWSJSON']['output'];
209
+ dataHolderId: Scalars['ID']['output'];
210
+ emailCount: Scalars['Int']['output'];
211
+ marketingEmailCount: Scalars['Int']['output'];
212
+ marketingEmailOpened: Scalars['Int']['output'];
213
+ marketingOpenRate: Scalars['Float']['output'];
214
+ owner: Scalars['ID']['output'];
215
+ readCount: Scalars['Int']['output'];
216
+ readRate: Scalars['Float']['output'];
217
+ scanRangeFromEpochMs: Scalars['Float']['output'];
218
+ scanRangeToEpochMs: Scalars['Float']['output'];
219
+ scannedAtEpochMs: Scalars['Float']['output'];
220
+ uncategorizedCount: Scalars['Int']['output'];
221
+ };
222
+ export type DataHolderScanSummaryConnection = {
223
+ items: Array<DataHolderScanSummary>;
224
+ nextToken?: Maybe<Scalars['String']['output']>;
225
+ };
226
+ export type DataHolderUpdateItem = {
227
+ complianceConcern: Scalars['Boolean']['output'];
228
+ createdAtEpochMs: Scalars['Float']['output'];
229
+ domainName: Scalars['String']['output'];
230
+ id: Scalars['ID']['output'];
231
+ mostRecentInteractionEpochMs: Scalars['Float']['output'];
232
+ name: Scalars['String']['output'];
233
+ owner: Scalars['ID']['output'];
234
+ protectionState: DataHolderProtectionState;
235
+ updatedAtEpochMs: Scalars['Float']['output'];
236
+ version: Scalars['Int']['output'];
237
+ virtualPresenceId: Scalars['ID']['output'];
238
+ };
239
+ /**
240
+ * A batch of data holder updates emitted during discovery.
241
+ * Contains all data holders discovered in a single page with their change types.
242
+ */
243
+ export type DataHoldersUpdate = {
244
+ items: Array<DataHolderUpdateItem>;
245
+ owner: Scalars['ID']['output'];
246
+ };
247
+ export type InitiateActionInput = {
248
+ dataHolderId: Scalars['ID']['input'];
249
+ fulfilmentMethod: ActionFulfilmentMethod;
250
+ intent: ActionIntent;
251
+ };
252
+ export type ListVirtualPresencesInput = {
253
+ limit?: InputMaybe<Scalars['Int']['input']>;
254
+ nextToken?: InputMaybe<Scalars['String']['input']>;
255
+ };
256
+ export type Mutation = {
257
+ /** Archive a data holder, removing it from the user's active list. */
258
+ archiveDataHolder: DataHolder;
259
+ /**
260
+ * Confirm that an assisted or delegated action was completed, transitioning it
261
+ * from COMPLETED_UNVERIFIED to COMPLETED_VERIFIED.
262
+ */
263
+ confirmActionOutcome: Action;
264
+ /** Connect a virtual presence. */
265
+ connectVirtualPresence: VirtualPresence;
266
+ /** Disconnect a virtual presence. */
267
+ disconnectVirtualPresence: VirtualPresence;
268
+ /**
269
+ * Initiate an action against a data holder relationship. Delegated actions are
270
+ * performed on the user's behalf; assisted actions return structured materials
271
+ * for the client to complete.
272
+ */
273
+ initiateAction: Action;
274
+ /**
275
+ * Rescan an existing virtual presence for new data holders.
276
+ * Scans from the last scan date forward.
277
+ */
278
+ rescanVirtualPresence: VirtualPresence;
279
+ /**
280
+ * Unarchive a previously archived data holder, clearing the user's archive
281
+ * setting and returning it to the MONITORED state. Only a data holder in the
282
+ * ARCHIVED state may be unarchived.
283
+ */
284
+ unarchiveDataHolder: DataHolder;
285
+ };
286
+ export type MutationArchiveDataHolderArgs = {
287
+ id: Scalars['ID']['input'];
288
+ };
289
+ export type MutationConfirmActionOutcomeArgs = {
290
+ id: Scalars['ID']['input'];
291
+ };
292
+ export type MutationConnectVirtualPresenceArgs = {
293
+ input?: InputMaybe<ConnectVirtualPresenceInput>;
294
+ };
295
+ export type MutationDisconnectVirtualPresenceArgs = {
296
+ id: Scalars['String']['input'];
297
+ };
298
+ export type MutationInitiateActionArgs = {
299
+ input: InitiateActionInput;
300
+ };
301
+ export type MutationRescanVirtualPresenceArgs = {
302
+ id: Scalars['String']['input'];
303
+ options?: InputMaybe<ScanOptionsInput>;
304
+ };
305
+ export type MutationUnarchiveDataHolderArgs = {
306
+ id: Scalars['ID']['input'];
307
+ };
308
+ export type OrganizationAnalysis = {
309
+ createdAtEpochMs: Scalars['Float']['output'];
310
+ data?: Maybe<AnalysisResultData>;
311
+ domain: Scalars['String']['output'];
312
+ id: Scalars['ID']['output'];
313
+ lastAnalyzedAtEpochMs: Scalars['Float']['output'];
314
+ owner: Scalars['ID']['output'];
315
+ status: AnalysisResultStatus;
316
+ updatedAtEpochMs: Scalars['Float']['output'];
317
+ version: Scalars['Int']['output'];
318
+ };
319
+ export type OrganizationAnalysisDomainResolution = 'EXACT' | 'REGISTRABLE' | '%future added value';
320
+ export type OrganizationAnalysisMode = 'ANALYZE' | 'FETCH' | '%future added value';
321
+ export type OrganizationAnalysisOptions = {
322
+ mode?: InputMaybe<OrganizationAnalysisMode>;
323
+ resolution?: InputMaybe<OrganizationAnalysisDomainResolution>;
324
+ };
325
+ 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';
326
+ export type OrganizationIdentity = {
327
+ brandName?: Maybe<Scalars['String']['output']>;
328
+ categories: Array<OrganizationCategory>;
329
+ companyName?: Maybe<Scalars['String']['output']>;
330
+ primaryCategory?: Maybe<OrganizationCategory>;
331
+ };
332
+ export type PrivacyScore = {
333
+ breakdown: Array<ScoreContribution>;
334
+ coverage: ScoreCoverage;
335
+ score: Scalars['Float']['output'];
336
+ };
337
+ export type PrivacySummary = {
338
+ bulletPoints: Array<Scalars['String']['output']>;
339
+ sourceLastUpdated?: Maybe<Scalars['String']['output']>;
340
+ sourceUrl: Scalars['String']['output'];
341
+ };
342
+ export type ProviderConfiguration = {
343
+ data: Scalars['ID']['output'];
344
+ };
345
+ export type ProviderType = 'EMAIL' | '%future added value';
346
+ export type Query = {
347
+ /**
348
+ * Read a single initiated action by id. Resolves an in-flight delegated action
349
+ * on read: if the action is still in progress, its outcome is polled and, once
350
+ * terminal, the action is updated to its verified result before being returned.
351
+ * Returns null when no action with the given id exists for the user.
352
+ */
353
+ getAction?: Maybe<Action>;
354
+ /** Get a full analysis result by ID, including typed data. */
355
+ getAnalysisResult?: Maybe<AnalysisResult>;
356
+ /** Get a single data holder by ID */
357
+ getDataHolder?: Maybe<DataHolder>;
358
+ /**
359
+ * Analyze (read-through) and return the shared, organization-generic analysis
360
+ * for a domain. Returns PENDING when an asynchronous source is still resolving;
361
+ * re-query for the terminal result.
362
+ *
363
+ * Pass `options` to control the analysis mode and domain resolution. When no
364
+ * mode is supplied the behaviour is ANALYZE, and resolution defaults to
365
+ * REGISTRABLE.
366
+ *
367
+ * Pass `name` to analyze by organization name (e.g. "amazon", "stripe"). The
368
+ * name is resolved to a domain and takes precedence over `domain` when it
369
+ * resolves; `domain` remains required and is used as the fallback when the name
370
+ * cannot be resolved (including when name resolution is unavailable).
371
+ */
372
+ getOrganizationAnalysis?: Maybe<OrganizationAnalysis>;
373
+ /**
374
+ * Get the opaque provider configuration required by consumers to support
375
+ * the provider OAuth flow.
376
+ */
377
+ getProviderConfiguration: ProviderConfiguration;
378
+ /** List analysis results for a virtual presence. */
379
+ listAnalysisResults: AnalysisResultConnection;
380
+ /**
381
+ * List the actions currently available for a data holder relationship. Derived
382
+ * at query time by merging static, analysis, and discovery sources; not
383
+ * persisted. The owning virtual presence is derived from the data holder.
384
+ */
385
+ listAvailableActions: AvailableActionConnection;
386
+ /** List scan summaries for a data holder (most recent first) */
387
+ listDataHolderScanSummaries: DataHolderScanSummaryConnection;
388
+ /** List data holders by virtual presence */
389
+ listDataHolders: DataHolderConnection;
390
+ /** List virtual presences for the authenticated user */
391
+ listVirtualPresences: VirtualPresenceConnection;
392
+ };
393
+ export type QueryGetActionArgs = {
394
+ id: Scalars['ID']['input'];
395
+ };
396
+ export type QueryGetAnalysisResultArgs = {
397
+ id: Scalars['ID']['input'];
398
+ };
399
+ export type QueryGetDataHolderArgs = {
400
+ id: Scalars['ID']['input'];
401
+ };
402
+ export type QueryGetOrganizationAnalysisArgs = {
403
+ domain: Scalars['String']['input'];
404
+ name?: InputMaybe<Scalars['String']['input']>;
405
+ options?: InputMaybe<OrganizationAnalysisOptions>;
406
+ };
407
+ export type QueryListAnalysisResultsArgs = {
408
+ limit?: InputMaybe<Scalars['Int']['input']>;
409
+ nextToken?: InputMaybe<Scalars['String']['input']>;
410
+ virtualPresenceId: Scalars['ID']['input'];
411
+ };
412
+ export type QueryListAvailableActionsArgs = {
413
+ dataHolderId: Scalars['ID']['input'];
414
+ };
415
+ export type QueryListDataHolderScanSummariesArgs = {
416
+ dataHolderId: Scalars['ID']['input'];
417
+ limit?: InputMaybe<Scalars['Int']['input']>;
418
+ nextToken?: InputMaybe<Scalars['String']['input']>;
419
+ };
420
+ export type QueryListDataHoldersArgs = {
421
+ limit?: InputMaybe<Scalars['Int']['input']>;
422
+ nextToken?: InputMaybe<Scalars['String']['input']>;
423
+ virtualPresenceId: Scalars['ID']['input'];
424
+ };
425
+ export type QueryListVirtualPresencesArgs = {
426
+ input?: InputMaybe<ListVirtualPresencesInput>;
427
+ };
428
+ export type RefreshTokenInput = {
429
+ expiresInEpochMs?: InputMaybe<Scalars['Float']['input']>;
430
+ providerIdentity: Scalars['String']['input'];
431
+ refreshToken: Scalars['String']['input'];
432
+ scopes?: InputMaybe<Array<Scalars['String']['input']>>;
433
+ };
434
+ export type RelationshipProvider = 'GMAIL_PROVIDER' | 'TEST_PROVIDER' | '%future added value';
435
+ export type RetentionInfo = {
436
+ additionalInfo?: Maybe<Scalars['String']['output']>;
437
+ style: RetentionStyle;
438
+ timeInDays?: Maybe<Scalars['Int']['output']>;
439
+ };
440
+ export type RetentionStyle = 'INDEFINITE' | 'OTHER' | 'RELATIVE_TO_ACCOUNT_CLOSURE_TIME' | 'RELATIVE_TO_DATA_STORAGE_TIME' | '%future added value';
441
+ export type RiskIndicators = {
442
+ breachRisk: SignalValue;
443
+ collectsSensitiveDataForNonEssentialPurposes: SignalValue;
444
+ dataCollectionBreadth: Scalars['Int']['output'];
445
+ encryptionPractices: SignalValue;
446
+ hasIndefiniteRetention: SignalValue;
447
+ maxRetentionDays?: Maybe<Scalars['Int']['output']>;
448
+ sellsPersonalInformation: SignalValue;
449
+ };
450
+ export type ScanOptionsInput = {
451
+ earliestScanDate?: InputMaybe<Scalars['String']['input']>;
452
+ excludeCategories?: InputMaybe<Array<Scalars['String']['input']>>;
453
+ excludeDomains?: InputMaybe<Array<Scalars['String']['input']>>;
454
+ latestScanDate?: InputMaybe<Scalars['String']['input']>;
455
+ maximumItemsProcessed?: InputMaybe<Scalars['Int']['input']>;
456
+ };
457
+ export type ScoreContribution = {
458
+ aspect: Scalars['String']['output'];
459
+ contribution: Scalars['Float']['output'];
460
+ };
461
+ export type ScoreCoverage = {
462
+ evaluated: Scalars['Int']['output'];
463
+ total: Scalars['Int']['output'];
464
+ };
465
+ export type ShareStyle = 'INFERENCE_SHARED' | 'NONE' | 'SHARED' | 'SHARED_WITH_CONSENT' | '%future added value';
466
+ export type SignalValue = 'NO' | 'UNKNOWN' | 'YES' | '%future added value';
467
+ export type Subscription = {
468
+ /**
469
+ * Subscribe to action status updates for the authenticated user.
470
+ * Emitted each time an action's status changes. Carries the scalar fields of the
471
+ * action; re-query the action to fetch the full assistedPayload.
472
+ */
473
+ onActionStatusUpdate?: Maybe<Action>;
474
+ /**
475
+ * Subscribe to analysis result updates for the authenticated user.
476
+ * Emitted each time an analysis result is created or updated.
477
+ * Use getAnalysisResult to fetch the full typed data.
478
+ */
479
+ onAnalysisResultUpdate?: Maybe<AnalysisResultUpdate>;
480
+ /**
481
+ * Subscribe to batch data holder updates during discovery.
482
+ * Emitted once per discovery page with all data holders found in that page.
483
+ */
484
+ onDataHoldersUpdate?: Maybe<DataHoldersUpdate>;
485
+ /**
486
+ * Subscribe to virtual presence state updates for the authenticated user.
487
+ * Emitted when a virtual presence changes state (e.g. to NEEDS_REAUTH).
488
+ */
489
+ onVirtualPresenceUpdate?: Maybe<VirtualPresence>;
490
+ };
491
+ export type SubscriptionOnActionStatusUpdateArgs = {
492
+ owner: Scalars['ID']['input'];
493
+ };
494
+ export type SubscriptionOnAnalysisResultUpdateArgs = {
495
+ owner: Scalars['ID']['input'];
496
+ };
497
+ export type SubscriptionOnDataHoldersUpdateArgs = {
498
+ owner: Scalars['ID']['input'];
499
+ };
500
+ export type SubscriptionOnVirtualPresenceUpdateArgs = {
501
+ owner: Scalars['ID']['input'];
502
+ };
503
+ export type VirtualPresence = {
504
+ createdAtEpochMs: Scalars['Float']['output'];
505
+ dataHolderCount: DataHolderCount;
506
+ id: Scalars['ID']['output'];
507
+ identifier: Scalars['String']['output'];
508
+ lastScanFailureReason?: Maybe<Scalars['String']['output']>;
509
+ lastScannedAtEpochMs: Scalars['Float']['output'];
510
+ owner: Scalars['ID']['output'];
511
+ providerType: ProviderType;
512
+ relationshipProvider?: Maybe<RelationshipProvider>;
513
+ state: VirtualPresenceState;
514
+ updatedAtEpochMs: Scalars['Float']['output'];
515
+ version: Scalars['Int']['output'];
516
+ };
517
+ export type VirtualPresenceConnection = {
518
+ items: Array<VirtualPresence>;
519
+ nextToken?: Maybe<Scalars['String']['output']>;
520
+ };
521
+ 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>;
@@ -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
+ }
@@ -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`.
@@ -235,7 +235,7 @@ export interface CategorySignalsEntity {
235
235
  * @property {SignalValueEntity} supportsDataDeletionRequests Whether the organization supports data deletion requests.
236
236
  * @property {SignalValueEntity} supportsDataExport Whether the organization supports data export.
237
237
  * @property {SignalValueEntity} supportsSubscriptions Whether the organization supports subscription management.
238
- * @property {SignalValueEntity} sellsPersonalInformation Whether the organization sells personal information.
238
+ * @property {SignalValueEntity} supportsOptOutOfSale Whether the organization exposes an opt-out-of-sale control to users.
239
239
  * @property {SignalValueEntity} usesCookiesOrTracking Whether the organization uses cookies or tracking.
240
240
  * @property {SignalValueEntity} supportsTwoFactorAuth Whether the organization supports two-factor auth for logins.
241
241
  */
@@ -245,7 +245,7 @@ export interface CapabilitySignalsEntity {
245
245
  supportsDataDeletionRequests: SignalValueEntity;
246
246
  supportsDataExport: SignalValueEntity;
247
247
  supportsSubscriptions: SignalValueEntity;
248
- sellsPersonalInformation: SignalValueEntity;
248
+ supportsOptOutOfSale: SignalValueEntity;
249
249
  usesCookiesOrTracking: SignalValueEntity;
250
250
  supportsTwoFactorAuth: SignalValueEntity;
251
251
  }
@@ -277,6 +277,7 @@ export interface RiskIndicatorsEntity {
277
277
  * @enum
278
278
  */
279
279
  export declare enum OrganizationCategoryEntity {
280
+ AdultEntertainment = "AdultEntertainment",
280
281
  Automotive = "Automotive",
281
282
  Communications = "Communications",
282
283
  CommunityAndCharity = "CommunityAndCharity",
@@ -40,6 +40,7 @@ export interface DataHolderEntity {
40
40
  * @property MONITORED The data holder is being monitored.
41
41
  * @property ACTION_REQUESTED An action has been requested against this data holder.
42
42
  * @property RESOLVED The data holder has been resolved.
43
+ * @property ARCHIVED The data holder has been archived by the user.
43
44
  *
44
45
  * @enum
45
46
  */
@@ -47,6 +48,7 @@ export declare enum DataHolderProtectionStateEntity {
47
48
  Monitored = "MONITORED",
48
49
  ActionRequested = "ACTION_REQUESTED",
49
50
  Resolved = "RESOLVED",
51
+ Archived = "ARCHIVED",
50
52
  Unknown = "UNKNOWN"
51
53
  }
52
54
  /**