@transcend-io/privacy-types 5.2.4 → 5.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.
package/dist/index.mjs CHANGED
@@ -195,22 +195,34 @@ let ActionItemPriorityOverride = /* @__PURE__ */ function(ActionItemPriorityOver
195
195
  * The type of requests that allow for opt-out
196
196
  */
197
197
  const RequestActionOptOut = makeEnum({
198
+ /** Opt out of automated decision making */
198
199
  AutomatedDecisionMakingOptOut: "AUTOMATED_DECISION_MAKING_OPT_OUT",
200
+ /** Ability to opt out of the use of sensitive information. A requirement under the CPRA and similar laws. */
199
201
  UseOfSensitiveInformationOptOut: "USE_OF_SENSITIVE_INFORMATION_OPT_OUT",
202
+ /** Opt out of all communication */
200
203
  ContactOptOut: "CONTACT_OPT_OUT",
204
+ /** Opt-out of the sale of personal data */
201
205
  SaleOptOut: "SALE_OPT_OUT",
206
+ /** Opt out of tracking */
202
207
  TrackingOptOut: "TRACKING_OPT_OUT",
208
+ /** Opt out custom */
203
209
  CustomOptOut: "CUSTOM_OPT_OUT"
204
210
  });
205
211
  /**
206
212
  * The type of requests that allow for opt-in
207
213
  */
208
214
  const RequestActionOptIn = makeEnum({
215
+ /** Opt in to automated decision making */
209
216
  AutomatedDecisionMakingOptIn: "AUTOMATED_DECISION_MAKING_OPT_IN",
217
+ /** Ability to opt in to the use of sensitive information. A requirement under the CPRA and similar laws. */
210
218
  UseOfSensitiveInformationOptIn: "USE_OF_SENSITIVE_INFORMATION_OPT_IN",
219
+ /** Opt-in to the sale of personal data */
211
220
  SaleOptIn: "SALE_OPT_IN",
221
+ /** Opt in to tracking */
212
222
  TrackingOptIn: "TRACKING_OPT_IN",
223
+ /** Opt in to contact */
213
224
  ContactOptIn: "CONTACT_OPT_IN",
225
+ /** Opt in custom */
214
226
  CustomOptIn: "CUSTOM_OPT_IN"
215
227
  });
216
228
  /**
@@ -230,12 +242,19 @@ const REQUEST_ACTION_OPT_IN_TO_OPT_OUT = invert(REQUEST_ACTION_OPT_OUT_TO_OPT_IN
230
242
  * An request action resolve types that can be run at the object level
231
243
  */
232
244
  const RequestActionObjectResolver = makeEnum({
245
+ /** Data Download request */
233
246
  Access: "ACCESS",
247
+ /** Erase the file completely */
234
248
  Erasure: "ERASURE",
249
+ /** Make an update to an inaccurate record */
235
250
  Rectification: "RECTIFICATION",
251
+ /** A restriction of processing request */
236
252
  Restriction: "RESTRICTION",
253
+ /** Business Purpose Report */
237
254
  BusinessPurpose: "BUSINESS_PURPOSE",
255
+ /** Add user to a legal hold */
238
256
  PlaceOnLegalHold: "PLACE_ON_LEGAL_HOLD",
257
+ /** Remove a user from a legal hold */
239
258
  RemoveFromLegalHold: "REMOVE_FROM_LEGAL_HOLD",
240
259
  ...RequestActionOptOut,
241
260
  ...RequestActionOptIn
@@ -248,19 +267,28 @@ const RequestActionObjectResolver = makeEnum({
248
267
  * webhook service to implement. The individual objects can still be
249
268
  * labeled for whether they should be included in data access requests.
250
269
  */
251
- const InternalDataSiloObjectResolver = makeEnum({ Access: "ACCESS" });
270
+ const InternalDataSiloObjectResolver = makeEnum({
271
+ /** Data Download request */
272
+ Access: "ACCESS" });
252
273
  /**
253
274
  * The types of requests that Data Subject can make
254
275
  */
255
276
  const RequestAction = makeEnum({
256
277
  ...RequestActionOptOut,
257
278
  ...RequestActionOptIn,
279
+ /** Data Download request */
258
280
  Access: "ACCESS",
281
+ /** Erase the profile from the system */
259
282
  Erasure: "ERASURE",
283
+ /** Make an update to an inaccurate record */
260
284
  Rectification: "RECTIFICATION",
285
+ /** Restrict processing */
261
286
  Restriction: "RESTRICTION",
287
+ /** Business Purpose Report */
262
288
  BusinessPurpose: "BUSINESS_PURPOSE",
289
+ /** Add user to a legal hold */
263
290
  PlaceOnLegalHold: "PLACE_ON_LEGAL_HOLD",
291
+ /** Remove a user from a legal hold */
264
292
  RemoveFromLegalHold: "REMOVE_FROM_LEGAL_HOLD"
265
293
  });
266
294
  //#endregion
@@ -296,19 +324,30 @@ let AssessmentFormTemplateStatus = /* @__PURE__ */ function(AssessmentFormTempla
296
324
  }({});
297
325
  /** How an assessment form template was created */
298
326
  const AssessmentFormTemplateSource = makeEnum({
327
+ /** The template was created manually by a user creating sections, questions, etc in the AD or via API */
299
328
  Manual: "MANUAL",
329
+ /** The template was auto-generated as a side effect of kicking off assessments from the Data Inventory */
300
330
  DataInventory: "DATA_INVENTORY",
331
+ /** The template was auto-generated as a side effect of importing OneTrust assessments */
301
332
  Import: "IMPORT"
302
333
  });
303
334
  /** The types of the assessment question */
304
335
  const AssessmentQuestionType = makeEnum({
336
+ /** A long-answer text question */
305
337
  LongAnswer: "LONG_ANSWER_TEXT",
338
+ /** A short-answer text question */
306
339
  ShortAnswer: "SHORT_ANSWER_TEXT",
340
+ /** A text question that accepts well-formatted URLs */
307
341
  Url: "URL",
342
+ /** A question that accepts one or more email addresses */
308
343
  Email: "EMAIL",
344
+ /** A single-select question */
309
345
  SingleSelect: "SINGLE_SELECT",
346
+ /** A multi-select question */
310
347
  MultiSelect: "MULTI_SELECT",
348
+ /** A file question */
311
349
  File: "FILE",
350
+ /** A static text field that has no answer field */
312
351
  Description: "DESCRIPTION"
313
352
  });
314
353
  /**
@@ -317,50 +356,86 @@ const AssessmentQuestionType = makeEnum({
317
356
  * StaticAssessmentQuestionSubType and DynamicAssessmentQuestionSubType
318
357
  */
319
358
  const AssessmentQuestionSubType = makeEnum({
359
+ /** A None subType for types that do not accept subTypes */
320
360
  None: "NONE",
361
+ /** A Custom subType for user-defined select types */
321
362
  Custom: "CUSTOM",
363
+ /** A user */
322
364
  User: "USER",
365
+ /** A team */
323
366
  Team: "TEAM",
367
+ /** A Data SubCategory */
324
368
  DataSubCategory: "DATA_SUB_CATEGORY",
369
+ /** A Processing Purpose SubCategory */
325
370
  ProcessingPurposeSubCategory: "PROCESSING_PURPOSE_SUB_CATEGORY",
371
+ /** A Processing Activity */
326
372
  ProcessingActivity: "PROCESSING_ACTIVITY",
373
+ /** A vendor */
327
374
  Vendor: "VENDOR",
375
+ /** A Region question */
328
376
  Region: "REGION",
377
+ /** A Business Entity */
329
378
  BusinessEntity: "BUSINESS_ENTITY",
379
+ /** The category of the recipient */
330
380
  SaaSCategory: "SAA_S_CATEGORY",
381
+ /** The Data Processing Agreement Status */
331
382
  DataProcessingAgreementStatus: "DATA_PROCESSING_AGREEMENT_STATUS",
383
+ /** The Data Protection Impact Assessment Status */
332
384
  DataProtectionImpactAssessmentStatus: "DATA_PROTECTION_IMPACT_ASSESSMENT_STATUS",
385
+ /** The deprecation state */
333
386
  DeprecationState: "DEPRECATION_STATE",
387
+ /** The identifier */
334
388
  Identifier: "IDENTIFIER",
389
+ /** A Data Silo */
335
390
  DataSilo: "DATA_SILO",
391
+ /** Whether the data silo is recommended for consent manager purposes */
336
392
  RecommendedForConsent: "RECOMMENDED_FOR_CONSENT",
393
+ /** Whether the data silo is recommended for privacy request purposes */
337
394
  RecommendedForPrivacy: "RECOMMENDED_FOR_PRIVACY",
395
+ /** The subject */
338
396
  Subject: "SUBJECT",
397
+ /** The type of retention schedule */
339
398
  RetentionType: "RETENTION_TYPE",
399
+ /** The controllership */
340
400
  Controllership: "CONTROLLERSHIP",
401
+ /** Whether the data silo has personal data */
341
402
  HasPersonalData: "HAS_PERSONAL_DATA",
403
+ /** The Attribute Key referring to a custom field */
342
404
  AttributeKey: "ATTRIBUTE_KEY",
405
+ /** A sensitive category */
343
406
  SensitiveCategory: "SENSITIVE_CATEGORY"
344
407
  });
345
408
  /** The possible actions within an assessment question's display logic */
346
409
  const AssessmentsDisplayLogicAction = makeEnum({
410
+ /** Display the question */
347
411
  Show: "SHOW",
412
+ /** Skip the question */
348
413
  Skip: "SKIP"
349
414
  });
350
415
  /** The comparison operators to use in an assessment question's display logic */
351
416
  const ComparisonOperator = makeEnum({
417
+ /** is equal to */
352
418
  IsEqualTo: "IS_EQUAL_TO",
419
+ /** is not equal to */
353
420
  IsNotEqualTo: "IS_NOT_EQUAL_TO",
421
+ /** is one of */
354
422
  IsOneOf: "IS_ONE_OF",
423
+ /** is not one of */
355
424
  IsNotOneOf: "IS_NOT_ONE_OF",
425
+ /** contains */
356
426
  Contains: "CONTAINS",
427
+ /** is shown */
357
428
  IsShown: "IS_SHOWN",
429
+ /** is not shown */
358
430
  IsNotShown: "IS_NOT_SHOWN",
431
+ /** does not contain */
359
432
  DoesNotContain: "DOES_NOT_CONTAIN"
360
433
  });
361
434
  /** The logic operators to use in an assessment question's display logic */
362
435
  const LogicOperator = makeEnum({
436
+ /** and */
363
437
  And: "AND",
438
+ /** or */
364
439
  Or: "OR"
365
440
  });
366
441
  /**
@@ -764,12 +839,19 @@ const AssessmentSyncColumn = makeEnum({
764
839
  });
765
840
  /** The data inventory models that can be synced from an Assessment Form */
766
841
  const AssessmentSyncModel = makeEnum({
842
+ /** DataSilo model */
767
843
  DataSilo: "dataSilo",
844
+ /** SubDataPoint model */
768
845
  SubDataPoint: "subDataPoint",
846
+ /** Vendor model */
769
847
  Vendor: "vendor",
848
+ /** DataSubCategory model */
770
849
  DataSubCategory: "dataSubCategory",
850
+ /** ProcessingPurposeSubCategory model */
771
851
  ProcessingPurposeSubCategory: "processingPurposeSubCategory",
852
+ /** BusinessEntity model */
772
853
  BusinessEntity: "businessEntity",
854
+ /** ProcessingActivity model */
773
855
  ProcessingActivity: "processingActivity"
774
856
  });
775
857
  //#endregion
@@ -1341,7 +1423,9 @@ const DataFlowScope = makeEnum({
1341
1423
  CSP: "CSP"
1342
1424
  });
1343
1425
  const ConsentBundleType = makeEnum({
1426
+ /** Bundle hosted at /cm path */
1344
1427
  Production: "PRODUCTION",
1428
+ /** Bundle hosted at /cm-test path */
1345
1429
  Test: "TEST"
1346
1430
  });
1347
1431
  const UnknownRequestPolicy = makeEnum({
@@ -1350,8 +1434,11 @@ const UnknownRequestPolicy = makeEnum({
1350
1434
  Block: "BLOCK"
1351
1435
  });
1352
1436
  const TelemetryPartitionStrategy = makeEnum({
1437
+ /** Partition telemetry data by the origin (default) */
1353
1438
  Origin: "origin",
1439
+ /** Partition telemetry data by the origin + path */
1354
1440
  Path: "path",
1441
+ /** Partition telemetry data by the full URL */
1355
1442
  Url: "url"
1356
1443
  });
1357
1444
  /**
@@ -1410,7 +1497,9 @@ const SignedIabAgreementOption = makeEnum({
1410
1497
  * Describes whether listed countries/country subdivisions are included in an experience
1411
1498
  */
1412
1499
  const RegionsOperator = makeEnum({
1500
+ /** The listed countries/country subdivisions, time zones, and languages are included in this experience */
1413
1501
  In: "IN",
1502
+ /** The listed countries/country subdivisions, time zones, and languages are NOT included in this experience */
1414
1503
  NotIn: "NOT_IN"
1415
1504
  });
1416
1505
  /**
@@ -1429,9 +1518,13 @@ const BackendSyncOption = makeEnum({
1429
1518
  * default: 'on'
1430
1519
  */
1431
1520
  const LocalSyncOption = makeEnum({
1521
+ /** use private sync only */
1432
1522
  Private: "private",
1523
+ /** allow network-observable sync when private sync is unavailable */
1433
1524
  AllowNetworkObservable: "allow-network-observable",
1525
+ /** comparable to 'allow-network-observable' -- allow network-observable sync when private sync is unavailble */
1434
1526
  On: "on",
1527
+ /** disable local sync */
1435
1528
  Off: "off"
1436
1529
  });
1437
1530
  /**
@@ -1457,83 +1550,166 @@ const DefaultConsentOption = makeEnum({
1457
1550
  * Fields by which you can order cookies
1458
1551
  */
1459
1552
  const CookieOrderField = makeEnum({
1553
+ /** The name of this cookie */
1460
1554
  Name: "name",
1555
+ /** When the cookie was created */
1461
1556
  CreatedAt: "createdAt",
1557
+ /** The time the cookie was updated */
1462
1558
  UpdatedAt: "updatedAt"
1463
1559
  });
1464
1560
  /**
1465
1561
  * Fields by which you can order data flows
1466
1562
  */
1467
1563
  const DataFlowOrderField = makeEnum({
1564
+ /** The value of this data flow */
1468
1565
  Value: "value",
1566
+ /** When the data flow was created */
1469
1567
  CreatedAt: "createdAt",
1568
+ /** The time the data flow was updated */
1470
1569
  UpdatedAt: "updatedAt",
1570
+ /** The number of occurrences of this data flow */
1471
1571
  Occurrences: "occurrences",
1572
+ /** The SaaS tool associated with these data flows */
1472
1573
  Service: "service"
1473
1574
  });
1474
1575
  /**
1475
1576
  * Types of data flows
1476
1577
  */
1477
1578
  const DataFlowType = makeEnum({
1579
+ /** URL-based data flow */
1478
1580
  Url: "URL",
1581
+ /** Query parameter-based data flow */
1479
1582
  QueryParam: "QUERY_PARAM",
1583
+ /** Regular expression-based data flow */
1480
1584
  RegExp: "REGEX"
1481
1585
  });
1482
1586
  /**
1483
1587
  * Triage actions for consent bulk operations
1484
1588
  */
1485
1589
  const TriageAction = makeEnum({
1590
+ /** Approve the tracker */
1486
1591
  Approve: "APPROVE",
1592
+ /** Mark the tracker as junk */
1487
1593
  Junk: "JUNK"
1488
1594
  });
1489
1595
  /**
1490
1596
  * Discriminator for cookie vs data flow
1491
1597
  */
1492
1598
  const ConsentTrackerType = makeEnum({
1599
+ /** Cookie tracker */
1493
1600
  Cookie: "cookie",
1601
+ /** Data flow tracker */
1494
1602
  DataFlow: "data_flow"
1495
1603
  });
1496
1604
  /**
1497
1605
  * Metrics supported by airgap bundle aggregate/timeseries analytics
1498
1606
  */
1499
1607
  const AirgapBundleAnalyticsMetric = makeEnum({
1608
+ /** User opt-in or opt-out for a consent purpose */
1500
1609
  ConsentChanged: "CONSENT_CHANGED",
1610
+ /** Privacy signal detected (e.g. GPC, DNT) */
1501
1611
  SignalDetected: "SIGNAL_DETECTED",
1612
+ /** Site session recorded */
1502
1613
  SiteSessions: "SITE_SESSIONS",
1614
+ /** Page view recorded */
1503
1615
  PageViews: "PAGE_VIEWS"
1504
1616
  });
1505
1617
  /**
1506
1618
  * Dimensions available for aggregate consent analytics breakdowns
1507
1619
  */
1508
1620
  const AirgapBundleAnalyticsDimension = makeEnum({
1621
+ /** Consent value after change (true = opted in, false = opted out) */
1509
1622
  NewValue: "NEW_VALUE",
1623
+ /** Privacy regime active when the event was recorded */
1510
1624
  Regime: "REGIME",
1625
+ /** Tracking purpose the event relates to */
1511
1626
  Purpose: "PURPOSE"
1512
1627
  });
1513
1628
  /**
1514
1629
  * Bin sizes for airgap bundle timeseries analytics
1515
1630
  */
1516
1631
  const AirgapBundleAnalyticsBinInterval = makeEnum({
1632
+ /** One minute bins */
1517
1633
  Minute: "1m",
1634
+ /** One hour bins */
1518
1635
  Hourly: "1h",
1636
+ /** One day bins */
1519
1637
  Daily: "1d"
1520
1638
  });
1521
1639
  /**
1522
1640
  * analyticsData sources for consent manager metrics
1523
1641
  */
1524
1642
  const ConsentManagerAnalyticsDataSource = makeEnum({
1643
+ /** DNT/GPC and other privacy signal counts over time */
1525
1644
  PrivacySignalTimeseries: "PRIVACY_SIGNAL_TIMESERIES",
1645
+ /** Explicit opt-in/opt-out events over time */
1526
1646
  ConsentChangesTimeseries: "CONSENT_CHANGES_TIMESERIES",
1647
+ /** Session counts grouped by privacy regime */
1527
1648
  ConsentSessionsByRegime: "CONSENT_SESSIONS_BY_REGIME"
1528
1649
  });
1529
1650
  /**
1530
1651
  * Allowed bin sizes for consent manager analyticsData queries
1531
1652
  */
1532
1653
  const ConsentManagerMetricBin = makeEnum({
1654
+ /** One hour bins */
1533
1655
  Hourly: "1h",
1656
+ /** One day bins */
1534
1657
  Daily: "1d"
1535
1658
  });
1536
1659
  //#endregion
1660
+ //#region src/consentUiInventory.ts
1661
+ /** Status of a consent UI variant */
1662
+ const UiVariantStatus = makeEnum({
1663
+ /** Variant is in draft */
1664
+ Draft: "DRAFT",
1665
+ /** Variant is active */
1666
+ Active: "ACTIVE",
1667
+ /** Variant is published */
1668
+ Published: "PUBLISHED"
1669
+ });
1670
+ /** User flow for a consent UI variant */
1671
+ const ConsentUiUserFlow = makeEnum({
1672
+ /** Banner-only flow */
1673
+ Banner: "BANNER",
1674
+ /** Modal-only flow */
1675
+ Modal: "MODAL",
1676
+ /** Banner and modal flow */
1677
+ BannerAndModal: "BANNER_AND_MODAL"
1678
+ });
1679
+ /** Consent UI variant input from transcend.yml */
1680
+ const ConsentVariantInput = t.intersection([t.type({
1681
+ /** ID of consent variant */
1682
+ id: t.string,
1683
+ /** Name of consent variant */
1684
+ name: t.string,
1685
+ /** Slug of consent variant */
1686
+ slug: t.string,
1687
+ /** Status of variant */
1688
+ status: valuesOf(UiVariantStatus),
1689
+ /** Locales of variant */
1690
+ locales: t.array(valuesOf(LOCALE_KEY)),
1691
+ /** Configuration of variant */
1692
+ configuration: t.string
1693
+ }), t.partial({
1694
+ /** Description of variant */
1695
+ description: t.string,
1696
+ /** User flow of variant */
1697
+ userFlow: valuesOf(ConsentUiUserFlow),
1698
+ /** Slug of the consent UI theme associated with this variant */
1699
+ themeSlug: t.string
1700
+ })]);
1701
+ /** Consent UI theme input from transcend.yml */
1702
+ const ConsentThemeInput = t.type({
1703
+ /** ID of consent theme */
1704
+ id: t.string,
1705
+ /** Name of consent theme */
1706
+ name: t.string,
1707
+ /** Slug of consent theme */
1708
+ slug: t.string,
1709
+ /** Configuration of theme */
1710
+ configuration: t.string
1711
+ });
1712
+ //#endregion
1537
1713
  //#region src/consentUiConfiguration.ts
1538
1714
  /** Actions for buttons in modals */
1539
1715
  const ModalButtonActions = makeEnum({
@@ -1555,8 +1731,11 @@ const ButtonType = makeEnum({
1555
1731
  const AbsoluteUrlString = t.string;
1556
1732
  /** Top-level configuration shared between the UI layers */
1557
1733
  const SharedTopLevelConfig = t.type({
1734
+ /** Supported locales */
1558
1735
  locales: t.array(valuesOf(LOCALE_KEY)),
1736
+ /** The transcend URL where the transcend logo links to */
1559
1737
  transcendUrl: AbsoluteUrlString,
1738
+ /** The default locale to use - must be one of the supported locales */
1560
1739
  defaultLocale: valuesOf(LOCALE_KEY)
1561
1740
  });
1562
1741
  /** Button configuration */
@@ -1633,38 +1812,51 @@ const UIConfiguration = t.union([
1633
1812
  * Vertical alignment options for the consent UI content
1634
1813
  */
1635
1814
  const VerticalAlign = makeEnum({
1815
+ /** Aligns the UI content at the top */
1636
1816
  Top: "top",
1817
+ /** Aligns the UI content at the bottom */
1637
1818
  Bottom: "bottom",
1819
+ /** Aligns the UI content in the center */
1638
1820
  Center: "center"
1639
1821
  });
1640
1822
  /**
1641
1823
  * Horizontal alignment options for the consent UI content
1642
1824
  */
1643
1825
  const HorizontalAlign = makeEnum({
1826
+ /** Aligns the UI content on the left */
1644
1827
  Left: "left",
1828
+ /** Aligns the UI content in the center */
1645
1829
  Center: "center",
1830
+ /** Aligns the UI content on the right */
1646
1831
  Right: "right"
1647
1832
  });
1648
1833
  /**
1649
1834
  * Position options for the logo in the consent UI
1650
1835
  */
1651
1836
  const LogoPosition = makeEnum({
1837
+ /** Logo is positioned above the content */
1652
1838
  Above: "above",
1839
+ /** Logo is positioned to the left of the content */
1653
1840
  Left: "left"
1654
1841
  });
1655
1842
  /**
1656
1843
  * Defines how content can flow in a layout
1657
1844
  */
1658
1845
  const ContentFlows = makeEnum({
1846
+ /** Items are stacked vertically, top to bottom */
1659
1847
  Vertical: "vertical",
1848
+ /** Items are stacked horizontally, often wrapping if space runs out */
1660
1849
  HorizontalStacked: "horizontal-stacked",
1850
+ /** Items are laid out horizontally, in a single row */
1661
1851
  HorizontalFlat: "horizontal-flat"
1662
1852
  });
1663
1853
  /**
1664
1854
  * Units available for responsive breakpoints.
1665
1855
  */
1666
1856
  const BreakpointType = makeEnum({
1857
+ /** Breakpoint defined in pixels */
1667
1858
  Px: "px",
1859
+ /** Breakpoint defined as a percentage */
1668
1860
  Percent: "percent"
1669
1861
  });
1670
1862
  /** String that represents a CSS unit eg. px, em, etc. */
@@ -1682,7 +1874,9 @@ const RgbHexString = t.string;
1682
1874
  /** Index of a button's theme */
1683
1875
  const ButtonThemeIndex = t.number;
1684
1876
  /** Represents background color configuration */
1685
- const Background = t.type({ backgroundColor: RgbaHexString });
1877
+ const Background = t.type({
1878
+ /** Background color as an RGBA hex string */
1879
+ backgroundColor: RgbaHexString });
1686
1880
  /**
1687
1881
  * Represents border configuration
1688
1882
  */
@@ -1707,7 +1901,9 @@ const Link = t.type({
1707
1901
  const Icon = t.type({ iconColor: RgbHexString });
1708
1902
  /** Represents a responsive breakpoint with value and unit */
1709
1903
  const Breakpoint = t.type({
1904
+ /** The numeric value of the breakpoint */
1710
1905
  value: t.number,
1906
+ /** The unit of the breakpoint (px or percent) */
1711
1907
  unit: valuesOf(BreakpointType)
1712
1908
  });
1713
1909
  /**
@@ -1864,7 +2060,9 @@ const SemicolonDelimitedRegimeKeyString = t.string;
1864
2060
  * Autofocus toggle values ("on" / "off").
1865
2061
  */
1866
2062
  const AutofocusToggle = makeEnum({
2063
+ /** Enable autofocus */
1867
2064
  On: "on",
2065
+ /** Disable autofocus */
1868
2066
  Off: "off"
1869
2067
  });
1870
2068
  /**
@@ -1877,8 +2075,11 @@ const AutofocusValues = t.union([valuesOf(AutofocusToggle), DOMElementId]);
1877
2075
  * Shadow root options ("open" / "closed" / "none").
1878
2076
  */
1879
2077
  const ShadowRootOptions = makeEnum({
2078
+ /** Enable shadow root */
1880
2079
  Open: "open",
2080
+ /** Disable shadow root */
1881
2081
  Closed: "closed",
2082
+ /** Disable shadow root */
1882
2083
  None: "none"
1883
2084
  });
1884
2085
  /** The top-level configuration for the consent UI */
@@ -1970,15 +2171,23 @@ const ConfidenceLabel = makeEnum({
1970
2171
  });
1971
2172
  /** The approval status of the category guess for a subdatapoint */
1972
2173
  const SubDataPointDataSubCategoryGuessStatus = makeEnum({
2174
+ /** The guess has been approved as valid */
1973
2175
  Approved: "APPROVED",
2176
+ /** The guess is pending review */
1974
2177
  Pending: "PENDING",
2178
+ /** The guess has been marked as wrong */
1975
2179
  Rejected: "REJECTED"
1976
2180
  });
1977
2181
  const UnstructuredSubDataPointRecommendationStatus = makeEnum({
2182
+ /** The category was manually applied */
1978
2183
  ManuallyAdded: "MANUALLY_ADDED",
2184
+ /** The recommendation has been corrected */
1979
2185
  Corrected: "CORRECTED",
2186
+ /** The recommendation has been approved as valid */
1980
2187
  Validated: "VALIDATED",
2188
+ /** The recommendation is has been made but not validated */
1981
2189
  Classified: "CLASSIFIED",
2190
+ /** The recommendation has been marked as wrong */
1982
2191
  Rejected: "REJECTED"
1983
2192
  });
1984
2193
  /**
@@ -1990,16 +2199,24 @@ const TableEncryptionType = makeEnum({
1990
2199
  EncryptedByDataAtRest: "ENCRYPTED_DATA_AT_REST"
1991
2200
  });
1992
2201
  const Controllership = makeEnum({
2202
+ /** The current organization is a controller of the data */
1993
2203
  Controller: "CONTROLLER",
2204
+ /** The current organization is a processor of the data */
1994
2205
  Processor: "PROCESSOR",
2206
+ /** The current organization is a joint controller of the data */
1995
2207
  JointController: "JOINT_CONTROLLER"
1996
2208
  });
1997
2209
  /** The type of retention schedule for personal data */
1998
2210
  const RetentionType = makeEnum({
2211
+ /** Collected user information is deleted, anonymized or aggregated after a specific time period */
1999
2212
  StatedPeriod: "STATED_PERIOD",
2213
+ /** Data is deleted, anonymized, or aggregated at some point, but no specific retention period is stated */
2000
2214
  Limited: "LIMITED",
2215
+ /** Collected user information is retained indefinitely */
2001
2216
  Indefinite: "INDEFINITE",
2217
+ /** A specific retention type not covered above */
2002
2218
  Other: "OTHER",
2219
+ /** Retention period is not stated or unclear */
2003
2220
  Unspecified: "UNSPECIFIED"
2004
2221
  });
2005
2222
  //#endregion
@@ -2008,7 +2225,9 @@ const RetentionType = makeEnum({
2008
2225
  * An identifier that can be used to communication with the data subject, also implies that the identifier is transcend supported
2009
2226
  */
2010
2227
  const CommunicationIdentifierType = makeEnum({
2228
+ /** An email address */
2011
2229
  Email: "email",
2230
+ /** A phone number */
2012
2231
  Phone: "phone"
2013
2232
  });
2014
2233
  /**
@@ -2016,35 +2235,84 @@ const CommunicationIdentifierType = makeEnum({
2016
2235
  */
2017
2236
  const IdentifierType = makeEnum({
2018
2237
  ...CommunicationIdentifierType,
2238
+ /** The core id of the organization (usually provided through login) */
2019
2239
  CoreIdentifier: "coreIdentifier",
2240
+ /** A custom identifier */
2020
2241
  Custom: "custom",
2242
+ /**
2243
+ * Google/Android mobile identifier
2244
+ *
2245
+ * @see https://www.singular.net/blog/google-advertising-id-gaid/
2246
+ * AKA adid - android advertising id
2247
+ */
2021
2248
  Gaid: "gaid",
2249
+ /** Apple ios mobile identifier */
2022
2250
  Idfa: "idfa",
2251
+ /**
2252
+ * The Identifier for Vendors
2253
+ *
2254
+ * @see https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor
2255
+ */
2023
2256
  Idfv: "idfv",
2024
2257
  BrowserId: "browserId",
2258
+ /** Microsoft Advertising Id */
2025
2259
  MicrosoftAdvertisingId: "microsoftAdvertisingId",
2260
+ /** Amazon fire Advertising Id */
2026
2261
  AmazonFireAdvertisingId: "amazonFireAdvertisingId",
2262
+ /**
2263
+ * Roku Advertising Id
2264
+ *
2265
+ * @see https://developer.roku.com/docs/developer-program/advertising/integrating-roku-advertising-framework.md
2266
+ */
2027
2267
  Rida: "rida",
2268
+ /** The handle for the filestack file */
2028
2269
  FilestackHandle: "filestackHandle",
2270
+ /** An ID for a stripe user */
2029
2271
  StripeId: "stripeId",
2272
+ /** The ID used to key braintree customer */
2030
2273
  BraintreeCustomerId: "braintreeCustomerId",
2274
+ /** An ID for a chargebee user */
2031
2275
  ChargebeeId: "chargebeeId",
2276
+ /** An ID for a Thrive TRM contact */
2032
2277
  thriveTrmContactId: "thriveTrmContactId",
2278
+ /** Talkable uuid */
2033
2279
  TalkableUUID: "talkableUUID",
2280
+ /** Recurly site account ID */
2034
2281
  RecurlyId: "recurlyId",
2282
+ /** The customer.io ID - also known as cio_id */
2035
2283
  customerIoId: "customerIoId",
2284
+ /** The visitorId for the Sprig integration */
2036
2285
  sprigVisitorId: "sprigVisitorId",
2286
+ /** URL of a LinkedIn profile */
2037
2287
  linkedInURL: "linkedInURL",
2288
+ /**
2289
+ * An advertising ID (for a mobile device)
2290
+ * TODO: https://transcend.height.app/T-13657 - remove this in favor of idfa and gpadvid
2291
+ */
2038
2292
  AdvertisingId: "advertisingId",
2293
+ /** An ID for a Persona account */
2039
2294
  PersonaReferenceId: "personaReferenceId",
2295
+ /** An ID for a Stream user */
2040
2296
  StreamUserId: "streamUserId",
2297
+ /** A token used to make API calls on behalf of a Plaid account. */
2041
2298
  PlaidProcessorToken: "plaidProcessorToken",
2299
+ /** An ID for an applicant on Onfido */
2042
2300
  OnfidoApplicantId: "onfidoApplicantId",
2301
+ /** Custom ID for a Vero user */
2043
2302
  VeroUserId: "veroUserId",
2303
+ /**
2304
+ * Adobe Privacy API ID's
2305
+ * https://experienceleague.adobe.com/en/docs/experience-platform/privacy/api/appendix#standard-namespaces
2306
+ */
2307
+ /** Adobe Advertising Cloud ID */
2044
2308
  AdobeAdvertisingCloudId: "adobeAdvertisingCloudId",
2309
+ /** Adobe Audience Manager UUID */
2045
2310
  AdobeAudienceManagerId: "adobeAudienceManagerId",
2311
+ /** Adobe Experience Cloud ID */
2046
2312
  AdobeExperienceCloudId: "adobeExperienceCloudId",
2313
+ /** Adobe Target ID */
2047
2314
  AdobeTargetID: "adobeTargetId",
2315
+ /** The special Transcend identifier on consent preference records */
2048
2316
  Transcend: "transcend"
2049
2317
  });
2050
2318
  //#endregion
@@ -2054,22 +2322,35 @@ const IdentifierType = makeEnum({
2054
2322
  * and return arbitrary outputs
2055
2323
  */
2056
2324
  const CustomEnricherType = makeEnum({
2325
+ /** Notify a server to enrich the variable */
2057
2326
  Server: "SERVER",
2327
+ /** Notify a person to enrich the value */
2058
2328
  Person: "PERSON",
2329
+ /** Check the legal hold list for that enricher type */
2059
2330
  LegalHold: "LEGAL_HOLD",
2331
+ /** Auto approve a specific identifier in a specific situation */
2060
2332
  AutoApprove: "AUTO_APPROVE",
2333
+ /** Test an identifier using a regex */
2061
2334
  RegexMatch: "REGEX_MATCH",
2335
+ /** Perform conditional logic based on region */
2062
2336
  RegionMatcher: "REGION_MATCH",
2337
+ /** Execute an SQL query against a database */
2063
2338
  Database: "DATABASE",
2339
+ /** Execute a look in looker to map identifiers */
2064
2340
  Looker: "LOOKER",
2341
+ /** Adds an enricher dependency */
2065
2342
  WaitPeriod: "WAIT_PERIOD",
2343
+ /** Verify a government ID */
2066
2344
  GovernmentId: "GOVERNMENT_ID",
2345
+ /** Custom Function enricher type. */
2067
2346
  CustomFunction: "CUSTOM_FUNCTION"
2068
2347
  });
2069
2348
  /**
2070
2349
  * Enrichers that can only be used to initialize the beginning of a DSR
2071
2350
  */
2072
- const InitEnricherType = makeEnum({ Sombra: "SOMBRA" });
2351
+ const InitEnricherType = makeEnum({
2352
+ /** Sombra has the capability */
2353
+ Sombra: "SOMBRA" });
2073
2354
  /**
2074
2355
  * The various types of identity enrichers supported by transcend
2075
2356
  */
@@ -28049,20 +28330,35 @@ const DatabaseVariables = t.record(t.string, t.union([
28049
28330
  * e.g. INSERT INTO table (id, type) VALUES ('{{requestId}}', '{{requestType}}');
28050
28331
  */
28051
28332
  const DatabaseSqlVariablesForPrivacyRequest = t.intersection([t.type({
28333
+ /** The unique UUID for the privacy request */
28052
28334
  requestId: t.string,
28335
+ /** The action type of the privacy request */
28053
28336
  requestType: valuesOf(RequestAction),
28337
+ /** The time that the privacy request was created */
28054
28338
  requestCreatedAt: t.string,
28339
+ /** The language key for the privacy request */
28055
28340
  requestLocale: valuesOf(LOCALE_KEY),
28341
+ /** Additional details provided about the request */
28056
28342
  requestDetails: t.string,
28343
+ /** Whether the request is a test request */
28057
28344
  requestIsTest: t.boolean,
28345
+ /** Origin in which request was made */
28058
28346
  requestOrigin: t.union([t.string, t.null]),
28347
+ /** Slug for type of data subject that made the request */
28059
28348
  requestDataSubjectType: t.string,
28349
+ /** The country code of person that made the request */
28060
28350
  requestCountry: t.union([t.string, t.null]),
28351
+ /** The country sub division code of person that made the request */
28061
28352
  requestCountrySubDivision: t.union([t.string, t.null]),
28353
+ /** Primary email value on request */
28062
28354
  requestPrimaryEmailValue: t.union([t.string, t.null]),
28355
+ /** Slug of consent purpose that triggered the request */
28063
28356
  consentPurposeTriggerSlug: t.union([t.string, t.null]),
28357
+ /** True/false consent value that triggered the request */
28064
28358
  consentPurposeTriggerValue: t.union([t.boolean, t.null]),
28359
+ /** The unique ID of partition that request was for */
28065
28360
  partitionId: t.union([t.string, t.null]),
28361
+ /** The name of partition that request was for */
28066
28362
  partitionName: t.union([t.string, t.null])
28067
28363
  }), DatabaseVariables]);
28068
28364
  //#endregion
@@ -28188,38 +28484,71 @@ const DEFAULT_MACROREGIONS_MAP = { [MacroRegion.EU]: [
28188
28484
  //#region src/objects.ts
28189
28485
  /** The purpose of processing data */
28190
28486
  const ProcessingPurpose = makeEnum({
28487
+ /** Provide a service that the user explicitly requests and that is part of the product's basic service or functionality */
28191
28488
  Essential: "ESSENTIAL",
28489
+ /** Provide a service that the user explicitly requests but that is not a necessary part of the product's basic service */
28192
28490
  AdditionalFunctionality: "ADDITIONAL_FUNCTIONALITY",
28491
+ /** To show ads that are either targeted to the specific user or not targeted */
28193
28492
  Advertising: "ADVERTISING",
28493
+ /** To contact the user to offer products, services, or other promotions */
28194
28494
  Marketing: "MARKETING",
28495
+ /** For understanding the product’s audience, improving the product, inform company strategy, or general research */
28195
28496
  Analytics: "ANALYTICS",
28497
+ /** For providing user with a personalized experience */
28196
28498
  Personalization: "PERSONALIZATION",
28499
+ /** For product operation and security, enforcement of terms of service, fraud prevention, protecting users and property, etc. */
28197
28500
  OperationSecurity: "OPERATION_SECURITY",
28501
+ /** For compliance with legal obligations */
28198
28502
  Legal: "LEGAL",
28503
+ /** For data that was transferred as part of a change in circumstance (e.g. a merger or acquisition) */
28199
28504
  Transfer: "TRANSFER",
28505
+ /** For selling the data to third parties */
28200
28506
  Sale: "SALE",
28507
+ /** For personnel training, recruitment, payroll, management, etc. */
28201
28508
  HR: "HR",
28509
+ /** Other specific purpose not covered above */
28202
28510
  Other: "OTHER",
28511
+ /** The purpose is not explicitly stated or is unclear */
28203
28512
  Unspecified: "UNSPECIFIED"
28204
28513
  });
28205
28514
  /** The category of personal data that is processed */
28206
28515
  const DataCategoryType = makeEnum({
28516
+ /** Financial information */
28207
28517
  Financial: "FINANCIAL",
28518
+ /** Health information */
28208
28519
  Health: "HEALTH",
28520
+ /** Contact information */
28209
28521
  Contact: "CONTACT",
28522
+ /** Geo-location information */
28210
28523
  Location: "LOCATION",
28524
+ /** Demographic Information */
28211
28525
  Demographic: "DEMOGRAPHIC",
28526
+ /** Identifiers that uniquely identify a person */
28212
28527
  Id: "ID",
28528
+ /** The user's online activities on the first party website/app or other websites/apps */
28213
28529
  OnlineActivity: "ONLINE_ACTIVITY",
28530
+ /** The user’s profile on the first-party website/app and its contents */
28214
28531
  UserProfile: "USER_PROFILE",
28532
+ /** User profile and data from a social media website/app or other third party service */
28215
28533
  SocialMedia: "SOCIAL_MEDIA",
28534
+ /** Connection information for the current browsing session, e.g. device IDs, MAC addresses, IP addresses, etc. */
28216
28535
  Connection: "CONNECTION",
28536
+ /** Cookies and tracking elements */
28217
28537
  Tracking: "TRACKING",
28538
+ /** Computer or device information */
28218
28539
  Device: "DEVICE",
28540
+ /** Any data that is collected through surveys */
28219
28541
  Survey: "SURVEY",
28542
+ /** A specific type of information not covered by the above categories */
28220
28543
  Other: "OTHER",
28544
+ /** The type of information is not explicitly stated or unclear */
28221
28545
  Unspecified: "UNSPECIFIED",
28546
+ /** Information that is NOT personal data */
28222
28547
  NotPersonalData: "NOT_PERSONAL_DATA",
28548
+ /**
28549
+ * Information identifying an object associated with a particular integration.
28550
+ * For example, Salesforce Object Ids.
28551
+ */
28223
28552
  IntegrationIdentifier: "INTEGRATION_IDENTIFIER"
28224
28553
  });
28225
28554
  //#endregion
@@ -28636,210 +28965,210 @@ let OneTrustAssessmentCsvHeader = /* @__PURE__ */ function(OneTrustAssessmentCsv
28636
28965
  const OneTrustAssessmentCsvRecord = t.record(
28637
28966
  /** The keys found in the OneTrust CSV header */
28638
28967
  t.keyof({
28639
- [OneTrustAssessmentCsvHeader.AssessmentId]: null,
28640
- [OneTrustAssessmentCsvHeader.CreateDt]: null,
28641
- [OneTrustAssessmentCsvHeader.InherentRiskScore]: null,
28642
- [OneTrustAssessmentCsvHeader.LastUpdated]: null,
28643
- [OneTrustAssessmentCsvHeader.Name]: null,
28644
- [OneTrustAssessmentCsvHeader.Number]: null,
28645
- [OneTrustAssessmentCsvHeader.OpenRiskCount]: null,
28646
- [OneTrustAssessmentCsvHeader.OrgGroupName]: null,
28647
- [OneTrustAssessmentCsvHeader.PrimaryInventoryDetails_PrimaryInventoryId]: null,
28648
- [OneTrustAssessmentCsvHeader.PrimaryInventoryDetails_PrimaryInventoryName]: null,
28649
- [OneTrustAssessmentCsvHeader.PrimaryInventoryDetails_PrimaryInventoryNumber]: null,
28650
- [OneTrustAssessmentCsvHeader.ResidualRiskScore]: null,
28651
- [OneTrustAssessmentCsvHeader.Result]: null,
28652
- [OneTrustAssessmentCsvHeader.ResultId]: null,
28653
- [OneTrustAssessmentCsvHeader.ResultName]: null,
28654
- [OneTrustAssessmentCsvHeader.State]: null,
28655
- [OneTrustAssessmentCsvHeader.Tags]: null,
28656
- [OneTrustAssessmentCsvHeader.TargetRiskScore]: null,
28657
- [OneTrustAssessmentCsvHeader.TemplateId]: null,
28658
- [OneTrustAssessmentCsvHeader.TemplateName]: null,
28659
- [OneTrustAssessmentCsvHeader.TemplateRootVersionId]: null,
28660
- [OneTrustAssessmentCsvHeader.AssessmentNumber]: null,
28661
- [OneTrustAssessmentCsvHeader.CompletedOn]: null,
28662
- [OneTrustAssessmentCsvHeader.Status]: null,
28663
- [OneTrustAssessmentCsvHeader.CreatedBy_Id]: null,
28664
- [OneTrustAssessmentCsvHeader.CreatedBy_Name]: null,
28665
- [OneTrustAssessmentCsvHeader.CreatedBy_NameKey]: null,
28666
- [OneTrustAssessmentCsvHeader.CreatedDT]: null,
28667
- [OneTrustAssessmentCsvHeader.Deadline]: null,
28668
- [OneTrustAssessmentCsvHeader.Description]: null,
28669
- [OneTrustAssessmentCsvHeader.LowRisk]: null,
28670
- [OneTrustAssessmentCsvHeader.MediumRisk]: null,
28671
- [OneTrustAssessmentCsvHeader.HighRisk]: null,
28672
- [OneTrustAssessmentCsvHeader.OrgGroup_Id]: null,
28673
- [OneTrustAssessmentCsvHeader.OrgGroup_Name]: null,
28674
- [OneTrustAssessmentCsvHeader.OrgGroup_NameKey]: null,
28675
- [OneTrustAssessmentCsvHeader.PrimaryRecordType]: null,
28676
- [OneTrustAssessmentCsvHeader.RiskLevel]: null,
28677
- [OneTrustAssessmentCsvHeader.SubmittedOn]: null,
28678
- [OneTrustAssessmentCsvHeader.Template_Id]: null,
28679
- [OneTrustAssessmentCsvHeader.Template_Name]: null,
28680
- [OneTrustAssessmentCsvHeader.Template_NameKey]: null,
28681
- [OneTrustAssessmentCsvHeader.TotalRiskCount]: null,
28682
- [OneTrustAssessmentCsvHeader.VeryHighRisk]: null,
28683
- [OneTrustAssessmentCsvHeader.WelcomeText]: null,
28684
- [OneTrustAssessmentCsvHeader.Approvers_Id]: null,
28685
- [OneTrustAssessmentCsvHeader.Approvers_WorkflowStageId]: null,
28686
- [OneTrustAssessmentCsvHeader.Approvers_Name]: null,
28687
- [OneTrustAssessmentCsvHeader.Approvers_Approver_Id]: null,
28688
- [OneTrustAssessmentCsvHeader.Approvers_Approver_FullName]: null,
28689
- [OneTrustAssessmentCsvHeader.Approvers_Approver_Email]: null,
28690
- [OneTrustAssessmentCsvHeader.Approvers_Approver_Deleted]: null,
28691
- [OneTrustAssessmentCsvHeader.Approvers_Approver_AssigneeType]: null,
28692
- [OneTrustAssessmentCsvHeader.Approvers_ApprovalState]: null,
28693
- [OneTrustAssessmentCsvHeader.Approvers_ApprovedOn]: null,
28694
- [OneTrustAssessmentCsvHeader.Approvers_ResultId]: null,
28695
- [OneTrustAssessmentCsvHeader.Approvers_ResultName]: null,
28696
- [OneTrustAssessmentCsvHeader.Approvers_ResultNameKey]: null,
28697
- [OneTrustAssessmentCsvHeader.Respondents_Id]: null,
28698
- [OneTrustAssessmentCsvHeader.Respondents_Name]: null,
28699
- [OneTrustAssessmentCsvHeader.Respondents_NameKey]: null,
28700
- [OneTrustAssessmentCsvHeader.PrimaryEntityDetails_Id]: null,
28701
- [OneTrustAssessmentCsvHeader.PrimaryEntityDetails_Name]: null,
28702
- [OneTrustAssessmentCsvHeader.PrimaryEntityDetails_Number]: null,
28703
- [OneTrustAssessmentCsvHeader.PrimaryEntityDetails_DisplayName]: null,
28704
- [OneTrustAssessmentCsvHeader.PrimaryEntityDetails_RelationshipResponseDetails]: null,
28705
- [OneTrustAssessmentCsvHeader.PrimaryEntityDetails_EntityBusinessKey]: null,
28706
- [OneTrustAssessmentCsvHeader.Sections_HasNavigationRules]: null,
28707
- [OneTrustAssessmentCsvHeader.Sections_SubmittedBy_Id]: null,
28708
- [OneTrustAssessmentCsvHeader.Sections_SubmittedBy_Name]: null,
28709
- [OneTrustAssessmentCsvHeader.Sections_SubmittedBy_NameKey]: null,
28710
- [OneTrustAssessmentCsvHeader.Sections_SubmittedDt]: null,
28711
- [OneTrustAssessmentCsvHeader.Sections_Name]: null,
28712
- [OneTrustAssessmentCsvHeader.Sections_Hidden]: null,
28713
- [OneTrustAssessmentCsvHeader.Sections_Valid]: null,
28714
- [OneTrustAssessmentCsvHeader.Sections_SectionId]: null,
28715
- [OneTrustAssessmentCsvHeader.Sections_Sequence]: null,
28716
- [OneTrustAssessmentCsvHeader.Sections_Submitted]: null,
28717
- [OneTrustAssessmentCsvHeader.Sections_Description]: null,
28718
- [OneTrustAssessmentCsvHeader.Sections_Status]: null,
28719
- [OneTrustAssessmentCsvHeader.Sections_OpenNMIQuestionIds]: null,
28720
- [OneTrustAssessmentCsvHeader.Sections_InvalidQuestionIds]: null,
28721
- [OneTrustAssessmentCsvHeader.Sections_RequiredUnansweredQuestionIds]: null,
28722
- [OneTrustAssessmentCsvHeader.Sections_RequiredQuestionIds]: null,
28723
- [OneTrustAssessmentCsvHeader.Sections_UnansweredQuestionIds]: null,
28724
- [OneTrustAssessmentCsvHeader.Sections_EffectivenessQuestionIds]: null,
28725
- [OneTrustAssessmentCsvHeader.Sections_NameKey]: null,
28726
- [OneTrustAssessmentCsvHeader.Sections_RiskStatistics_MaxRiskLevel]: null,
28727
- [OneTrustAssessmentCsvHeader.Sections_RiskStatistics_RiskCount]: null,
28728
- [OneTrustAssessmentCsvHeader.Sections_RiskStatistics_SectionId]: null,
28729
- [OneTrustAssessmentCsvHeader.Sections_Questions_Hidden]: null,
28730
- [OneTrustAssessmentCsvHeader.Sections_Questions_LockReason]: null,
28731
- [OneTrustAssessmentCsvHeader.Sections_Questions_CopyErrors]: null,
28732
- [OneTrustAssessmentCsvHeader.Sections_Questions_HasNavigationRules]: null,
28733
- [OneTrustAssessmentCsvHeader.Sections_Questions_RootRequestInformationIds]: null,
28734
- [OneTrustAssessmentCsvHeader.Sections_Questions_TotalAttachments]: null,
28735
- [OneTrustAssessmentCsvHeader.Sections_Questions_AttachmentIds]: null,
28736
- [OneTrustAssessmentCsvHeader.Sections_Questions_CanReopenWithAllowEditOption]: null,
28737
- [OneTrustAssessmentCsvHeader.Sections_Questions_RiskCreationAllowed]: null,
28738
- [OneTrustAssessmentCsvHeader.Sections_Questions_RiskDeletionPopupAllowed]: null,
28739
- [OneTrustAssessmentCsvHeader.Sections_Questions_AllowMaturityScaleOnQuestions]: null,
28740
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionAssociations]: null,
28741
- [OneTrustAssessmentCsvHeader.Sections_Questions_Issues]: null,
28742
- [OneTrustAssessmentCsvHeader.Sections_Questions_ResponseEditableWhileUnderReview]: null,
28743
- [OneTrustAssessmentCsvHeader.Sections_Questions_BusinessKeyReference]: null,
28744
- [OneTrustAssessmentCsvHeader.Sections_Questions_Topic]: null,
28745
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionLaws]: null,
28746
- [OneTrustAssessmentCsvHeader.Sections_Questions_AttachmentRequired]: null,
28747
- [OneTrustAssessmentCsvHeader.Sections_Questions_ResponseFilter]: null,
28748
- [OneTrustAssessmentCsvHeader.Sections_Questions_LinkAssessmentToResponseEntity]: null,
28749
- [OneTrustAssessmentCsvHeader.Sections_Questions_TranslationIdentifier]: null,
28750
- [OneTrustAssessmentCsvHeader.Sections_Questions_ReadOnly]: null,
28751
- [OneTrustAssessmentCsvHeader.Sections_Questions_Schema]: null,
28752
- [OneTrustAssessmentCsvHeader.Sections_Questions_AttributeId]: null,
28753
- [OneTrustAssessmentCsvHeader.Sections_Questions_VendorQuestion]: null,
28754
- [OneTrustAssessmentCsvHeader.Sections_Questions_Seeded]: null,
28755
- [OneTrustAssessmentCsvHeader.Sections_Questions_AllowJustification]: null,
28756
- [OneTrustAssessmentCsvHeader.Sections_Questions_AssetQuestion]: null,
28757
- [OneTrustAssessmentCsvHeader.Sections_Questions_EntityQuestion]: null,
28758
- [OneTrustAssessmentCsvHeader.Sections_Questions_Paquestion]: null,
28759
- [OneTrustAssessmentCsvHeader.Sections_Questions_InventoryTypeEnum]: null,
28760
- [OneTrustAssessmentCsvHeader.Sections_Questions_ForceOther]: null,
28761
- [OneTrustAssessmentCsvHeader.Sections_Questions_IsParentQuestionMultiSelect]: null,
28762
- [OneTrustAssessmentCsvHeader.Sections_Questions_Id]: null,
28763
- [OneTrustAssessmentCsvHeader.Sections_Questions_RootVersionId]: null,
28764
- [OneTrustAssessmentCsvHeader.Sections_Questions_Sequence]: null,
28765
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionType]: null,
28766
- [OneTrustAssessmentCsvHeader.Sections_Questions_Required]: null,
28767
- [OneTrustAssessmentCsvHeader.Sections_Questions_Attributes]: null,
28768
- [OneTrustAssessmentCsvHeader.Sections_Questions_FriendlyName]: null,
28769
- [OneTrustAssessmentCsvHeader.Sections_Questions_Description]: null,
28770
- [OneTrustAssessmentCsvHeader.Sections_Questions_Hint]: null,
28771
- [OneTrustAssessmentCsvHeader.Sections_Questions_ParentQuestionId]: null,
28772
- [OneTrustAssessmentCsvHeader.Sections_Questions_PrePopulateResponse]: null,
28773
- [OneTrustAssessmentCsvHeader.Sections_Questions_LinkAssessmentToInventory]: null,
28774
- [OneTrustAssessmentCsvHeader.Sections_Questions_Valid]: null,
28775
- [OneTrustAssessmentCsvHeader.Sections_Questions_Type]: null,
28776
- [OneTrustAssessmentCsvHeader.Sections_Questions_AllowMultiSelect]: null,
28777
- [OneTrustAssessmentCsvHeader.Sections_Questions_Content]: null,
28778
- [OneTrustAssessmentCsvHeader.Sections_Questions_RequireJustification]: null,
28779
- [OneTrustAssessmentCsvHeader.Sections_Questions_Options_TranslationIdentifier]: null,
28780
- [OneTrustAssessmentCsvHeader.Sections_Questions_Options_Id]: null,
28781
- [OneTrustAssessmentCsvHeader.Sections_Questions_Options_Option]: null,
28782
- [OneTrustAssessmentCsvHeader.Sections_Questions_Options_OptionKey]: null,
28783
- [OneTrustAssessmentCsvHeader.Sections_Questions_Options_Hint]: null,
28784
- [OneTrustAssessmentCsvHeader.Sections_Questions_Options_HintKey]: null,
28785
- [OneTrustAssessmentCsvHeader.Sections_Questions_Options_Score]: null,
28786
- [OneTrustAssessmentCsvHeader.Sections_Questions_Options_PreSelectedOption]: null,
28787
- [OneTrustAssessmentCsvHeader.Sections_Questions_Options_Sequence]: null,
28788
- [OneTrustAssessmentCsvHeader.Sections_Questions_Options_Attributes]: null,
28789
- [OneTrustAssessmentCsvHeader.Sections_Questions_Options_OptionType]: null,
28790
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_QuestionId]: null,
28791
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_RiskId]: null,
28792
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Level]: null,
28793
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Score]: null,
28794
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Probability]: null,
28795
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_ImpactLevel]: null,
28796
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Description]: null,
28797
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Name]: null,
28798
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Treatment]: null,
28799
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_TreatmentStatus]: null,
28800
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Type]: null,
28801
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Stage_CurrentStageApprovers]: null,
28802
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Stage_BadgeColor]: null,
28803
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Stage_Id]: null,
28804
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Stage_Name]: null,
28805
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Stage_NameKey]: null,
28806
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_State]: null,
28807
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Result]: null,
28808
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Categories_Seeded]: null,
28809
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Categories_Id]: null,
28810
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Categories_Name]: null,
28811
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Categories_NameKey]: null,
28812
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_MaturityScale]: null,
28813
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_EffectivenessScale]: null,
28814
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_ParentAssessmentDetailId]: null,
28815
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_DisplayLabel]: null,
28816
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_ParentQuestionType]: null,
28817
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_ParentResponseId]: null,
28818
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_IsLocalVersion]: null,
28819
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_RelationshipDisplayInformation]: null,
28820
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_LockReason]: null,
28821
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_ControlResponse]: null,
28822
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_RelationshipResponseDetails]: null,
28823
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_TextRedacted]: null,
28824
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_ResponseMap]: null,
28825
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_ResponseId]: null,
28826
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_Response]: null,
28827
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_ResponseKey]: null,
28828
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_ContractResponse]: null,
28829
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_Type]: null,
28830
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_ResponseSourceType]: null,
28831
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_ErrorCode]: null,
28832
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_Valid]: null,
28833
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_DataSubject_Id]: null,
28834
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_DataSubject_Name]: null,
28835
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_DataSubject_NameKey]: null,
28836
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_DataCategory_Id]: null,
28837
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_DataCategory_Name]: null,
28838
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_DataCategory_NameKey]: null,
28839
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_DataElement_Id]: null,
28840
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_DataElement_Name]: null,
28841
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_DataElement_NameKey]: null,
28842
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_Justification]: null
28968
+ ["assessmentId"]: null,
28969
+ ["createDt"]: null,
28970
+ ["inherentRiskScore"]: null,
28971
+ ["lastUpdated"]: null,
28972
+ ["name"]: null,
28973
+ ["number"]: null,
28974
+ ["openRiskCount"]: null,
28975
+ ["orgGroupName"]: null,
28976
+ ["primaryInventoryDetails_primaryInventoryId"]: null,
28977
+ ["primaryInventoryDetails_primaryInventoryName"]: null,
28978
+ ["primaryInventoryDetails_primaryInventoryNumber"]: null,
28979
+ ["residualRiskScore"]: null,
28980
+ ["result"]: null,
28981
+ ["resultId"]: null,
28982
+ ["resultName"]: null,
28983
+ ["state"]: null,
28984
+ ["tags"]: null,
28985
+ ["targetRiskScore"]: null,
28986
+ ["templateId"]: null,
28987
+ ["templateName"]: null,
28988
+ ["templateRootVersionId"]: null,
28989
+ ["assessmentNumber"]: null,
28990
+ ["completedOn"]: null,
28991
+ ["status"]: null,
28992
+ ["createdBy_id"]: null,
28993
+ ["createdBy_name"]: null,
28994
+ ["createdBy_nameKey"]: null,
28995
+ ["createdDT"]: null,
28996
+ ["deadline"]: null,
28997
+ ["description"]: null,
28998
+ ["lowRisk"]: null,
28999
+ ["mediumRisk"]: null,
29000
+ ["highRisk"]: null,
29001
+ ["orgGroup_id"]: null,
29002
+ ["orgGroup_name"]: null,
29003
+ ["orgGroup_nameKey"]: null,
29004
+ ["primaryRecordType"]: null,
29005
+ ["riskLevel"]: null,
29006
+ ["submittedOn"]: null,
29007
+ ["template_id"]: null,
29008
+ ["template_name"]: null,
29009
+ ["template_nameKey"]: null,
29010
+ ["totalRiskCount"]: null,
29011
+ ["veryHighRisk"]: null,
29012
+ ["welcomeText"]: null,
29013
+ ["approvers_id"]: null,
29014
+ ["approvers_workflowStageId"]: null,
29015
+ ["approvers_name"]: null,
29016
+ ["approvers_approver_id"]: null,
29017
+ ["approvers_approver_fullName"]: null,
29018
+ ["approvers_approver_email"]: null,
29019
+ ["approvers_approver_deleted"]: null,
29020
+ ["approvers_approver_assigneeType"]: null,
29021
+ ["approvers_approvalState"]: null,
29022
+ ["approvers_approvedOn"]: null,
29023
+ ["approvers_resultId"]: null,
29024
+ ["approvers_resultName"]: null,
29025
+ ["approvers_resultNameKey"]: null,
29026
+ ["respondents_id"]: null,
29027
+ ["respondents_name"]: null,
29028
+ ["respondents_nameKey"]: null,
29029
+ ["primaryEntityDetails_id"]: null,
29030
+ ["primaryEntityDetails_name"]: null,
29031
+ ["primaryEntityDetails_number"]: null,
29032
+ ["primaryEntityDetails_displayName"]: null,
29033
+ ["primaryEntityDetails_relationshipResponseDetails"]: null,
29034
+ ["primaryEntityDetails_entityBusinessKey"]: null,
29035
+ ["sections_hasNavigationRules"]: null,
29036
+ ["sections_submittedBy_id"]: null,
29037
+ ["sections_submittedBy_name"]: null,
29038
+ ["sections_submittedBy_nameKey"]: null,
29039
+ ["sections_submittedDt"]: null,
29040
+ ["sections_name"]: null,
29041
+ ["sections_hidden"]: null,
29042
+ ["sections_valid"]: null,
29043
+ ["sections_sectionId"]: null,
29044
+ ["sections_sequence"]: null,
29045
+ ["sections_submitted"]: null,
29046
+ ["sections_description"]: null,
29047
+ ["sections_status"]: null,
29048
+ ["sections_openNMIQuestionIds"]: null,
29049
+ ["sections_invalidQuestionIds"]: null,
29050
+ ["sections_requiredUnansweredQuestionIds"]: null,
29051
+ ["sections_requiredQuestionIds"]: null,
29052
+ ["sections_unansweredQuestionIds"]: null,
29053
+ ["sections_effectivenessQuestionIds"]: null,
29054
+ ["sections_nameKey"]: null,
29055
+ ["sections_riskStatistics_maxRiskLevel"]: null,
29056
+ ["sections_riskStatistics_riskCount"]: null,
29057
+ ["sections_riskStatistics_sectionId"]: null,
29058
+ ["sections_questions_hidden"]: null,
29059
+ ["sections_questions_lockReason"]: null,
29060
+ ["sections_questions_copyErrors"]: null,
29061
+ ["sections_questions_hasNavigationRules"]: null,
29062
+ ["sections_questions_rootRequestInformationIds"]: null,
29063
+ ["sections_questions_totalAttachments"]: null,
29064
+ ["sections_questions_attachmentIds"]: null,
29065
+ ["sections_questions_canReopenWithAllowEditOption"]: null,
29066
+ ["sections_questions_riskCreationAllowed"]: null,
29067
+ ["sections_questions_riskDeletionPopupAllowed"]: null,
29068
+ ["sections_questions_allowMaturityScaleOnQuestions"]: null,
29069
+ ["sections_questions_questionAssociations"]: null,
29070
+ ["sections_questions_issues"]: null,
29071
+ ["sections_questions_responseEditableWhileUnderReview"]: null,
29072
+ ["sections_questions_businessKeyReference"]: null,
29073
+ ["sections_questions_topic"]: null,
29074
+ ["sections_questions_questionLaws"]: null,
29075
+ ["sections_questions_attachmentRequired"]: null,
29076
+ ["sections_questions_responseFilter"]: null,
29077
+ ["sections_questions_linkAssessmentToResponseEntity"]: null,
29078
+ ["sections_questions_translationIdentifier"]: null,
29079
+ ["sections_questions_readOnly"]: null,
29080
+ ["sections_questions_schema"]: null,
29081
+ ["sections_questions_attributeId"]: null,
29082
+ ["sections_questions_vendorQuestion"]: null,
29083
+ ["sections_questions_seeded"]: null,
29084
+ ["sections_questions_allowJustification"]: null,
29085
+ ["sections_questions_assetQuestion"]: null,
29086
+ ["sections_questions_entityQuestion"]: null,
29087
+ ["sections_questions_paquestion"]: null,
29088
+ ["sections_questions_inventoryTypeEnum"]: null,
29089
+ ["sections_questions_forceOther"]: null,
29090
+ ["sections_questions_isParentQuestionMultiSelect"]: null,
29091
+ ["sections_questions_id"]: null,
29092
+ ["sections_questions_rootVersionId"]: null,
29093
+ ["sections_questions_sequence"]: null,
29094
+ ["sections_questions_questionType"]: null,
29095
+ ["sections_questions_required"]: null,
29096
+ ["sections_questions_attributes"]: null,
29097
+ ["sections_questions_friendlyName"]: null,
29098
+ ["sections_questions_description"]: null,
29099
+ ["sections_questions_hint"]: null,
29100
+ ["sections_questions_parentQuestionId"]: null,
29101
+ ["sections_questions_prePopulateResponse"]: null,
29102
+ ["sections_questions_linkAssessmentToInventory"]: null,
29103
+ ["sections_questions_valid"]: null,
29104
+ ["sections_questions_type"]: null,
29105
+ ["sections_questions_allowMultiSelect"]: null,
29106
+ ["sections_questions_content"]: null,
29107
+ ["sections_questions_requireJustification"]: null,
29108
+ ["sections_questions_options_translationIdentifier"]: null,
29109
+ ["sections_questions_options_id"]: null,
29110
+ ["sections_questions_options_option"]: null,
29111
+ ["sections_questions_options_optionKey"]: null,
29112
+ ["sections_questions_options_hint"]: null,
29113
+ ["sections_questions_options_hintKey"]: null,
29114
+ ["sections_questions_options_score"]: null,
29115
+ ["sections_questions_options_preSelectedOption"]: null,
29116
+ ["sections_questions_options_sequence"]: null,
29117
+ ["sections_questions_options_attributes"]: null,
29118
+ ["sections_questions_options_optionType"]: null,
29119
+ ["sections_questions_risks_questionId"]: null,
29120
+ ["sections_questions_risks_riskId"]: null,
29121
+ ["sections_questions_risks_level"]: null,
29122
+ ["sections_questions_risks_score"]: null,
29123
+ ["sections_questions_risks_probability"]: null,
29124
+ ["sections_questions_risks_impactLevel"]: null,
29125
+ ["sections_questions_risks_description"]: null,
29126
+ ["sections_questions_risks_name"]: null,
29127
+ ["sections_questions_risks_treatment"]: null,
29128
+ ["sections_questions_risks_treatmentStatus"]: null,
29129
+ ["sections_questions_risks_type"]: null,
29130
+ ["sections_questions_risks_stage_currentStageApprovers"]: null,
29131
+ ["sections_questions_risks_stage_badgeColor"]: null,
29132
+ ["sections_questions_risks_stage_id"]: null,
29133
+ ["sections_questions_risks_stage_name"]: null,
29134
+ ["sections_questions_risks_stage_nameKey"]: null,
29135
+ ["sections_questions_risks_state"]: null,
29136
+ ["sections_questions_risks_result"]: null,
29137
+ ["sections_questions_risks_categories_seeded"]: null,
29138
+ ["sections_questions_risks_categories_id"]: null,
29139
+ ["sections_questions_risks_categories_name"]: null,
29140
+ ["sections_questions_risks_categories_nameKey"]: null,
29141
+ ["sections_questions_questionResponses_maturityScale"]: null,
29142
+ ["sections_questions_questionResponses_effectivenessScale"]: null,
29143
+ ["sections_questions_questionResponses_parentAssessmentDetailId"]: null,
29144
+ ["sections_questions_questionResponses_displayLabel"]: null,
29145
+ ["sections_questions_questionResponses_parentQuestionType"]: null,
29146
+ ["sections_questions_questionResponses_parentResponseId"]: null,
29147
+ ["sections_questions_questionResponses_isLocalVersion"]: null,
29148
+ ["sections_questions_questionResponses_relationshipDisplayInformation"]: null,
29149
+ ["sections_questions_questionResponses_lockReason"]: null,
29150
+ ["sections_questions_questionResponses_controlResponse"]: null,
29151
+ ["sections_questions_questionResponses_relationshipResponseDetails"]: null,
29152
+ ["sections_questions_questionResponses_textRedacted"]: null,
29153
+ ["sections_questions_questionResponses_responseMap"]: null,
29154
+ ["sections_questions_questionResponses_responseId"]: null,
29155
+ ["sections_questions_questionResponses_response"]: null,
29156
+ ["sections_questions_questionResponses_responseKey"]: null,
29157
+ ["sections_questions_questionResponses_contractResponse"]: null,
29158
+ ["sections_questions_questionResponses_type"]: null,
29159
+ ["sections_questions_questionResponses_responseSourceType"]: null,
29160
+ ["sections_questions_questionResponses_errorCode"]: null,
29161
+ ["sections_questions_questionResponses_valid"]: null,
29162
+ ["sections_questions_questionResponses_dataSubject_id"]: null,
29163
+ ["sections_questions_questionResponses_dataSubject_name"]: null,
29164
+ ["sections_questions_questionResponses_dataSubject_nameKey"]: null,
29165
+ ["sections_questions_questionResponses_dataCategory_id"]: null,
29166
+ ["sections_questions_questionResponses_dataCategory_name"]: null,
29167
+ ["sections_questions_questionResponses_dataCategory_nameKey"]: null,
29168
+ ["sections_questions_questionResponses_dataElement_id"]: null,
29169
+ ["sections_questions_questionResponses_dataElement_name"]: null,
29170
+ ["sections_questions_questionResponses_dataElement_nameKey"]: null,
29171
+ ["sections_questions_questionResponses_justification"]: null
28843
29172
  }),
28844
29173
  /** The values of the header */
28845
29174
  t.string
@@ -28851,20 +29180,34 @@ const OneTrustAssessmentCsvRecord = t.record(
28851
29180
  * Return types of the "Get List of Assessments" endpoint
28852
29181
  */
28853
29182
  const OneTrustAssessment = t.type({
29183
+ /** ID of the assessment. */
28854
29184
  assessmentId: t.string,
29185
+ /** Date that the assessment was created. */
28855
29186
  createDt: t.string,
29187
+ /** Overall risk score without considering existing controls. */
28856
29188
  inherentRiskScore: t.union([t.number, t.null]),
29189
+ /** Date and time that the assessment was last updated. */
28857
29190
  lastUpdated: t.string,
29191
+ /** Name of the assessment. */
28858
29192
  name: t.string,
29193
+ /** Number assigned to the assessment. */
28859
29194
  number: t.number,
29195
+ /** Number of risks that are open on the assessment. */
28860
29196
  openRiskCount: t.number,
29197
+ /** Name of the organization group assigned to the assessment. */
28861
29198
  orgGroupName: t.string,
29199
+ /** Details about the inventory record which is the primary record of the assessment. */
28862
29200
  primaryInventoryDetails: t.union([t.type({
29201
+ /** GUID of the inventory record. */
28863
29202
  primaryInventoryId: t.string,
29203
+ /** Name of the inventory record. */
28864
29204
  primaryInventoryName: t.string,
29205
+ /** Integer ID of the inventory record. */
28865
29206
  primaryInventoryNumber: t.number
28866
29207
  }), t.null]),
29208
+ /** Overall risk score after considering existing controls. */
28867
29209
  residualRiskScore: t.union([t.number, t.null]),
29210
+ /** Result of the assessment. NOTE: This field will be deprecated soon. Please reference the 'resultName' field instead. */
28868
29211
  result: t.union([
28869
29212
  t.literal("Approved"),
28870
29213
  t.literal("AutoClosed"),
@@ -28872,7 +29215,9 @@ const OneTrustAssessment = t.type({
28872
29215
  t.string,
28873
29216
  t.null
28874
29217
  ]),
29218
+ /** ID of the result. */
28875
29219
  resultId: t.union([t.string, t.null]),
29220
+ /** Name of the result. */
28876
29221
  resultName: t.union([
28877
29222
  t.literal("Approved - Remediation required"),
28878
29223
  t.literal("Approved"),
@@ -28881,7 +29226,9 @@ const OneTrustAssessment = t.type({
28881
29226
  t.string,
28882
29227
  t.null
28883
29228
  ]),
29229
+ /** State of the assessment. */
28884
29230
  state: t.union([t.literal("ARCHIVE"), t.literal("ACTIVE")]),
29231
+ /** Status of the assessment. */
28885
29232
  status: t.union([
28886
29233
  t.literal("Not Started"),
28887
29234
  t.literal("In Progress"),
@@ -28889,18 +29236,29 @@ const OneTrustAssessment = t.type({
28889
29236
  t.literal("Completed"),
28890
29237
  t.null
28891
29238
  ]),
29239
+ /** Name of the tag attached to the assessment. */
28892
29240
  tags: t.array(t.string),
29241
+ /** The desired risk score. */
28893
29242
  targetRiskScore: t.union([t.number, t.null]),
29243
+ /** ID used to launch an assessment using a specific version of a template. */
28894
29244
  templateId: t.string,
29245
+ /** Name of the template that is being used on the assessment. */
28895
29246
  templateName: t.string,
29247
+ /** ID used to launch an assessment using the latest published version of a template. */
28896
29248
  templateRootVersionId: t.string
28897
29249
  });
28898
29250
  const OneTrustGetListOfAssessmentsResponse = t.partial({
29251
+ /** The list of assessments in the current page. */
28899
29252
  content: t.array(OneTrustAssessment),
29253
+ /** Details about the pages being fetched */
28900
29254
  page: t.type({
29255
+ /** Page number of the results list (0…N). */
28901
29256
  number: t.number,
29257
+ /** Number of records per page (0…N). */
28902
29258
  size: t.number,
29259
+ /** Total number of elements. */
28903
29260
  totalElements: t.number,
29261
+ /** Total number of pages. */
28904
29262
  totalPages: t.number
28905
29263
  })
28906
29264
  });
@@ -28911,23 +29269,36 @@ const OneTrustGetListOfAssessmentsResponse = t.partial({
28911
29269
  * Return types of the "Get Assessments" endpoint
28912
29270
  */
28913
29271
  const OneTrustApprover = t.type({
29272
+ /** ID of the user assigned as an approver. */
28914
29273
  id: t.string,
29274
+ /** ID of the workflow stage */
28915
29275
  workflowStageId: t.string,
29276
+ /** Name of the user assigned as an approver. */
28916
29277
  name: t.string,
29278
+ /** More details about the approver */
28917
29279
  approver: t.type({
29280
+ /** ID of the user assigned as an approver. */
28918
29281
  id: t.string,
29282
+ /** Full name of the user assigned as an approver. */
28919
29283
  fullName: t.string,
29284
+ /** Email of the user assigned as an approver. */
28920
29285
  email: t.union([t.string, t.null]),
29286
+ /** Whether the user assigned as an approver was deleted. */
28921
29287
  deleted: t.boolean,
29288
+ /** The assignee type */
28922
29289
  assigneeType: t.union([t.string, t.null])
28923
29290
  }),
29291
+ /** Assessment approval status. */
28924
29292
  approvalState: t.union([
28925
29293
  t.literal("OPEN"),
28926
29294
  t.literal("APPROVED"),
28927
29295
  t.literal("REJECTED")
28928
29296
  ]),
29297
+ /** Date and time at which the assessment was approved. */
28929
29298
  approvedOn: t.union([t.string, t.null]),
29299
+ /** ID of the assessment result. */
28930
29300
  resultId: t.union([t.string, t.null]),
29301
+ /** Name of the assessment result. */
28931
29302
  resultName: t.union([
28932
29303
  t.literal("Approved - Remediation required"),
28933
29304
  t.literal("Approved"),
@@ -28936,6 +29307,7 @@ const OneTrustApprover = t.type({
28936
29307
  t.string,
28937
29308
  t.null
28938
29309
  ]),
29310
+ /** Name key of the assessment result. */
28939
29311
  resultNameKey: t.union([t.string, t.null])
28940
29312
  });
28941
29313
  const OneTrustAssessmentStatus = t.union([
@@ -28945,27 +29317,49 @@ const OneTrustAssessmentStatus = t.union([
28945
29317
  t.literal("COMPLETED")
28946
29318
  ]);
28947
29319
  const OneTrustPrimaryEntityDetails = t.array(t.type({
29320
+ /** Unique ID for the primary record. */
28948
29321
  id: t.string,
29322
+ /** Name of the primary record. */
28949
29323
  name: t.string,
29324
+ /** The number associated with the primary record. */
28950
29325
  number: t.number,
29326
+ /** Name and number of the primary record. */
28951
29327
  displayName: t.string,
29328
+ /** The relationshipResponseDetails */
28952
29329
  relationshipResponseDetails: t.union([t.string, t.null]),
29330
+ /** The entity business key */
28953
29331
  entityBusinessKey: t.union([t.string, t.null])
28954
29332
  }));
28955
29333
  const OneTrustAssessmentSectionSubmittedBy = t.union([t.intersection([t.type({
29334
+ /** The ID of the user who submitted the section */
28956
29335
  id: t.string,
29336
+ /** THe name or email of the user who submitted the section */
28957
29337
  name: t.string
28958
- }), t.partial({ nameKey: t.union([t.string, t.null]) })]), t.null]);
28959
- const OneTrustAssessmentQuestionOption = t.intersection([t.partial({ translationIdentifier: t.string }), t.type({
29338
+ }), t.partial({
29339
+ /** The name key of the user who submitted the section */
29340
+ nameKey: t.union([t.string, t.null]) })]), t.null]);
29341
+ const OneTrustAssessmentQuestionOption = t.intersection([t.partial({
29342
+ /** The translationIdentifier */
29343
+ translationIdentifier: t.string }), t.type({
29344
+ /** ID of the option. */
28960
29345
  id: t.string,
29346
+ /** Name of the option. */
28961
29347
  option: t.string,
29348
+ /** The key of the option */
28962
29349
  optionKey: t.union([t.string, t.null]),
29350
+ /** The hint */
28963
29351
  hint: t.union([t.string, t.null]),
29352
+ /** The hint key */
28964
29353
  hintKey: t.union([t.string, t.null]),
29354
+ /** The score */
28965
29355
  score: t.union([t.number, t.null]),
29356
+ /** If the option was pre-selected */
28966
29357
  preSelectedOption: t.boolean,
29358
+ /** Order in which the option appears. */
28967
29359
  sequence: t.union([t.number, t.null]),
29360
+ /** Attribute for which the option is available. */
28968
29361
  attributes: t.union([t.string, t.null]),
29362
+ /** Type of option. */
28969
29363
  optionType: t.union([
28970
29364
  t.literal("NOT_SURE"),
28971
29365
  t.literal("NOT_APPLICABLE"),
@@ -28974,49 +29368,86 @@ const OneTrustAssessmentQuestionOption = t.intersection([t.partial({ translation
28974
29368
  ])
28975
29369
  })]);
28976
29370
  const OneTrustAssessmentNestedQuestion = t.type({
29371
+ /** ID of the question. */
28977
29372
  id: t.string,
29373
+ /** ID of the root version of the question. */
28978
29374
  rootVersionId: t.string,
29375
+ /** Order in which the question appears in the assessment. */
28979
29376
  sequence: t.number,
29377
+ /** Type of question in the assessment. */
28980
29378
  questionType: t.union([t.string, t.null]),
29379
+ /** Indicates whether a response to the question is required. */
28981
29380
  required: t.boolean,
29381
+ /** Data element attributes that are directly updated by the question. */
28982
29382
  attributes: t.string,
29383
+ /** Short, descriptive name for the question. */
28983
29384
  friendlyName: t.union([t.string, t.null]),
29385
+ /** Description of the question. */
28984
29386
  description: t.union([t.string, t.null]),
29387
+ /** Tooltip text within a hint for the question. */
28985
29388
  hint: t.union([t.string, t.null]),
29389
+ /** ID of the parent question. */
28986
29390
  parentQuestionId: t.union([t.string, t.null]),
29391
+ /** Indicates whether the response to the question is prepopulated. */
28987
29392
  prePopulateResponse: t.boolean,
29393
+ /** Indicates whether the assessment is linked to inventory records. */
28988
29394
  linkAssessmentToInventory: t.boolean,
29395
+ /** The question options */
28989
29396
  options: t.union([t.array(OneTrustAssessmentQuestionOption), t.null]),
29397
+ /** Indicates whether the question is valid. */
28990
29398
  valid: t.boolean,
29399
+ /** Type of question in the assessment. */
28991
29400
  type: t.union([t.string, t.null]),
29401
+ /** Whether the response can be multi select */
28992
29402
  allowMultiSelect: t.boolean,
29403
+ /** The text of a question. */
28993
29404
  content: t.string,
29405
+ /** Indicates whether justification comments are required for the question. */
28994
29406
  requireJustification: t.boolean,
29407
+ /** The attachmentRequired */
28995
29408
  attachmentRequired: t.boolean
28996
29409
  });
28997
29410
  const OneTrustAssessmentResponses = t.array(t.intersection([t.partial({
29411
+ /** The response maturityScale */
28998
29412
  maturityScale: t.union([t.string, t.null]),
29413
+ /** The response effectivenessScale */
28999
29414
  effectivenessScale: t.union([t.string, t.null]),
29415
+ /** The response parentAssessmentDetailId */
29000
29416
  parentAssessmentDetailId: t.union([t.string, t.null]),
29417
+ /** The response display label */
29001
29418
  displayLabel: t.string,
29419
+ /** The response type of the parent question */
29002
29420
  parentQuestionType: t.string,
29421
+ /** The response ID of the parent response */
29003
29422
  parentResponseId: t.string,
29423
+ /** Whether it's local version */
29004
29424
  isLocalVersion: t.string,
29425
+ /** Whether relationshipDisplayInformation */
29005
29426
  relationshipDisplayInformation: t.union([t.string, t.null]),
29427
+ /** The response lock reason */
29006
29428
  lockReason: t.union([t.string, t.null])
29007
29429
  }), t.type({
29430
+ /** The controlResponse */
29008
29431
  controlResponse: t.union([
29009
29432
  t.string,
29010
29433
  t.object,
29011
29434
  t.null
29012
29435
  ]),
29436
+ /** The relationshipResponseDetails */
29013
29437
  relationshipResponseDetails: t.array(t.string),
29438
+ /** The textRedacted */
29014
29439
  textRedacted: t.boolean,
29440
+ /** The responseMap */
29015
29441
  responseMap: t.object,
29442
+ /** ID of the response. */
29016
29443
  responseId: t.string,
29444
+ /** Content of the response. */
29017
29445
  response: t.union([t.string, t.null]),
29446
+ /** The response key */
29018
29447
  responseKey: t.union([t.string, t.null]),
29448
+ /** The response key */
29019
29449
  contractResponse: t.union([t.string, t.null]),
29450
+ /** Type of response. */
29020
29451
  type: t.union([
29021
29452
  t.literal("NOT_SURE"),
29022
29453
  t.literal("JUSTIFICATION"),
@@ -29024,7 +29455,9 @@ const OneTrustAssessmentResponses = t.array(t.intersection([t.partial({
29024
29455
  t.literal("DEFAULT"),
29025
29456
  t.literal("OTHERS")
29026
29457
  ]),
29458
+ /** Source from which the assessment is launched. */
29027
29459
  responseSourceType: t.union([t.string, t.null]),
29460
+ /** Error associated with the response. */
29028
29461
  errorCode: t.union([
29029
29462
  t.literal("ATTRIBUTE_DISABLED"),
29030
29463
  t.literal("ATTRIBUTE_OPTION_DISABLED"),
@@ -29034,149 +29467,273 @@ const OneTrustAssessmentResponses = t.array(t.intersection([t.partial({
29034
29467
  t.literal("DUPLICATE_INVENTORY"),
29035
29468
  t.null
29036
29469
  ]),
29470
+ /** Indicates whether the response is valid. */
29037
29471
  valid: t.boolean,
29472
+ /** The data subject */
29038
29473
  dataSubject: t.union([t.type({
29474
+ /** The ID of the data subject */
29039
29475
  id: t.union([t.string, t.null]),
29476
+ /** The ID of the data subject */
29040
29477
  name: t.union([t.string, t.null]),
29478
+ /** The nameKey of the data category */
29041
29479
  nameKey: t.union([t.string, t.null])
29042
29480
  }), t.null]),
29481
+ /** The data category */
29043
29482
  dataCategory: t.union([t.type({
29483
+ /** The ID of the data category */
29044
29484
  id: t.union([t.string, t.null]),
29485
+ /** The name of the data category */
29045
29486
  name: t.union([t.string, t.null]),
29487
+ /** The nameKey of the data category */
29046
29488
  nameKey: t.union([t.string, t.null])
29047
29489
  }), t.null]),
29490
+ /** The data element */
29048
29491
  dataElement: t.union([t.type({
29492
+ /** The ID of the data element */
29049
29493
  id: t.union([t.string, t.null]),
29494
+ /** The name of the data element */
29050
29495
  name: t.union([t.string, t.null]),
29496
+ /** The name key of the data element */
29051
29497
  nameKey: t.union([t.string, t.null])
29052
29498
  }), t.null])
29053
29499
  })]));
29054
29500
  const OneTrustAssessmentQuestionResponses = t.array(t.type({
29501
+ /** The responses */
29055
29502
  responses: OneTrustAssessmentResponses,
29503
+ /** Justification comments for the given response. */
29056
29504
  justification: t.union([t.string, t.null])
29057
29505
  }));
29058
29506
  const OneTrustAssessmentQuestionRisk = t.intersection([t.type({
29507
+ /** ID of the question for which the risk was flagged. */
29059
29508
  questionId: t.string,
29509
+ /** ID of the flagged risk. */
29060
29510
  riskId: t.string
29061
29511
  }), t.partial({
29512
+ /** Level of risk flagged on the question. */
29062
29513
  level: t.union([t.number, t.null]),
29514
+ /** Score of risk flagged on the question. */
29063
29515
  score: t.union([t.number, t.null]),
29516
+ /** Probability of risk flagged on the question. */
29064
29517
  probability: t.union([t.number, t.undefined]),
29518
+ /** Impact Level of risk flagged on the question. */
29065
29519
  impactLevel: t.union([t.number, t.undefined])
29066
29520
  })]);
29067
29521
  const OneTrustAssessmentQuestion = t.intersection([t.type({
29522
+ /** The question */
29068
29523
  question: OneTrustAssessmentNestedQuestion,
29524
+ /** Indicates whether the question is hidden on the assessment. */
29069
29525
  hidden: t.boolean,
29526
+ /** Reason for locking the question in the assessment. */
29070
29527
  lockReason: t.union([t.string, t.null]),
29528
+ /** The copy errors */
29071
29529
  copyErrors: t.union([t.string, t.null]),
29530
+ /** Indicates whether navigation rules are enabled for the question. */
29072
29531
  hasNavigationRules: t.boolean,
29532
+ /** The responses to this question */
29073
29533
  questionResponses: OneTrustAssessmentQuestionResponses,
29534
+ /** The risks associated with this question */
29074
29535
  risks: t.union([t.array(OneTrustAssessmentQuestionRisk), t.null]),
29536
+ /** List of IDs associated with the question root requests. */
29075
29537
  rootRequestInformationIds: t.array(t.string),
29538
+ /** Number of attachments added to the question. */
29076
29539
  totalAttachments: t.number,
29540
+ /** IDs of the attachment(s) added to the question. */
29077
29541
  attachmentIds: t.array(t.string),
29542
+ /** The canReopenWithAllowEditOption */
29078
29543
  canReopenWithAllowEditOption: t.boolean,
29544
+ /** The riskCreationAllowed */
29079
29545
  riskCreationAllowed: t.boolean,
29546
+ /** The riskDeletionPopupAllowed */
29080
29547
  riskDeletionPopupAllowed: t.boolean,
29548
+ /** The allowMaturityScaleOnQuestions */
29081
29549
  allowMaturityScaleOnQuestions: t.boolean,
29550
+ /** The questionAssociations */
29082
29551
  questionAssociations: t.union([t.string, t.null]),
29552
+ /** The issues */
29083
29553
  issues: t.union([t.string, t.null]),
29554
+ /** The responseEditableWhileUnderReview */
29084
29555
  responseEditableWhileUnderReview: t.boolean
29085
29556
  }), t.partial({
29557
+ /** The businessKeyReference */
29086
29558
  businessKeyReference: t.union([t.string, t.null]),
29559
+ /** The topic */
29087
29560
  topic: t.union([t.string, t.null]),
29561
+ /** The questionLaws */
29088
29562
  questionLaws: t.array(t.string),
29563
+ /** The responseFilter */
29089
29564
  responseFilter: t.union([t.string, t.null]),
29565
+ /** The linkAssessmentToResponseEntity */
29090
29566
  linkAssessmentToResponseEntity: t.boolean,
29567
+ /** The translationIdentifier */
29091
29568
  translationIdentifier: t.string,
29569
+ /** The readOnly */
29092
29570
  readOnly: t.boolean,
29571
+ /** The schema */
29093
29572
  schema: t.union([t.string, t.null]),
29573
+ /** The attributeId */
29094
29574
  attributeId: t.string,
29575
+ /** Whether it is a vendor question */
29095
29576
  vendorQuestion: t.boolean,
29577
+ /** Whether the question was seeded */
29096
29578
  seeded: t.boolean,
29579
+ /** Whether the question allows justification */
29097
29580
  allowJustification: t.boolean,
29581
+ /** Whether it refers to an asset question */
29098
29582
  assetQuestion: t.boolean,
29583
+ /** Whether it refers to an entity question */
29099
29584
  entityQuestion: t.boolean,
29585
+ /** Whether it is a paquestion */
29100
29586
  paquestion: t.boolean,
29587
+ /** The inventoryTypeEnum */
29101
29588
  inventoryTypeEnum: t.union([t.string, t.null]),
29589
+ /** Whether it is a forceOther */
29102
29590
  forceOther: t.boolean,
29591
+ /** Whether it is a isParentQuestionMultiSelect */
29103
29592
  isParentQuestionMultiSelect: t.boolean
29104
29593
  })]);
29105
29594
  const OneTrustAssessmentSectionHeaderRiskStatistics = t.union([t.type({
29595
+ /** Maximum level of risk in the section. */
29106
29596
  maxRiskLevel: t.union([t.number, t.null]),
29597
+ /** Number of risks in the section. */
29107
29598
  riskCount: t.union([t.number, t.null]),
29599
+ /** ID of the section in the assessment. */
29108
29600
  sectionId: t.union([t.string, t.null])
29109
29601
  }), t.null]);
29110
29602
  const OneTrustAssessmentSectionHeader = t.intersection([t.type({
29603
+ /** ID of the section in the assessment. */
29111
29604
  sectionId: t.string,
29605
+ /** Name of the section. */
29112
29606
  name: t.string,
29607
+ /** The status of the section */
29113
29608
  status: t.union([t.string, t.null]),
29609
+ /** The openNMIQuestionIds */
29114
29610
  openNMIQuestionIds: t.union([t.string, t.null]),
29611
+ /** Description of the section header. */
29115
29612
  description: t.union([t.string, t.null]),
29613
+ /** Sequence of the section within the form */
29116
29614
  sequence: t.number,
29615
+ /** Indicates whether the section is hidden in the assessment. */
29117
29616
  hidden: t.boolean,
29617
+ /** IDs of invalid questions in the section. */
29118
29618
  invalidQuestionIds: t.array(t.string),
29619
+ /** IDs of required but unanswered questions in the section. */
29119
29620
  requiredUnansweredQuestionIds: t.array(t.string),
29621
+ /** IDs of required questions in the section. */
29120
29622
  requiredQuestionIds: t.array(t.string),
29623
+ /** IDs of unanswered questions in the section. */
29121
29624
  unansweredQuestionIds: t.array(t.string),
29625
+ /** IDs of effectiveness questions in the section. */
29122
29626
  effectivenessQuestionIds: t.array(t.string),
29627
+ /** The risk statistics */
29123
29628
  riskStatistics: OneTrustAssessmentSectionHeaderRiskStatistics,
29629
+ /** Whether the section was submitted */
29124
29630
  submitted: t.boolean
29125
- }), t.partial({ nameKey: t.union([t.string, t.null]) })]);
29631
+ }), t.partial({
29632
+ /** The name key of the template */
29633
+ nameKey: t.union([t.string, t.null]) })]);
29126
29634
  const OneTrustAssessmentSection = t.type({
29635
+ /** The Assessment section header */
29127
29636
  header: OneTrustAssessmentSectionHeader,
29637
+ /** The questions within the section */
29128
29638
  questions: t.array(OneTrustAssessmentQuestion),
29639
+ /** Indicates whether navigation rules are enabled for the question. */
29129
29640
  hasNavigationRules: t.boolean,
29641
+ /** Who submitted the section */
29130
29642
  submittedBy: OneTrustAssessmentSectionSubmittedBy,
29643
+ /** Date of the submission */
29131
29644
  submittedDt: t.union([t.string, t.null]),
29645
+ /** Name of the section. */
29132
29646
  name: t.string,
29647
+ /** Indicates whether navigation rules are enabled for the question. */
29133
29648
  hidden: t.boolean,
29649
+ /** Indicates whether the section is valid. */
29134
29650
  valid: t.boolean,
29651
+ /** ID of the section in an assessment. */
29135
29652
  sectionId: t.string,
29653
+ /** Sequence of the section within the form */
29136
29654
  sequence: t.number,
29655
+ /** Whether the section was submitted */
29137
29656
  submitted: t.boolean,
29657
+ /** Descriptions of the section. */
29138
29658
  description: t.union([t.string, t.null])
29139
29659
  });
29140
29660
  const OneTrustAssessmentCreatedBy = t.type({
29661
+ /** The ID of the creator */
29141
29662
  id: t.string,
29663
+ /** The name of the creator */
29142
29664
  name: t.string,
29665
+ /** The name key of the template */
29143
29666
  nameKey: t.union([t.string, t.null])
29144
29667
  });
29145
29668
  const OneTrustGetAssessmentResponse = t.type({
29669
+ /** List of users assigned as approvers of the assessment. */
29146
29670
  approvers: t.array(OneTrustApprover),
29671
+ /** ID of an assessment. */
29147
29672
  assessmentId: t.string,
29673
+ /** Number assigned to an assessment. */
29148
29674
  assessmentNumber: t.number,
29675
+ /** Date and time at which the assessment was completed. */
29149
29676
  completedOn: t.union([t.string, t.null]),
29677
+ /** Status of the assessment. */
29150
29678
  status: OneTrustAssessmentStatus,
29679
+ /** Creator of the Assessment */
29151
29680
  createdBy: OneTrustAssessmentCreatedBy,
29681
+ /** Date and time at which the assessment was created. */
29152
29682
  createdDT: t.string,
29683
+ /** Date and time by which the assessment must be completed. */
29153
29684
  deadline: t.union([t.string, t.null]),
29685
+ /** Description of the assessment. */
29154
29686
  description: t.union([t.string, t.null]),
29687
+ /** Overall inherent risk score without considering the existing controls. */
29155
29688
  inherentRiskScore: t.union([t.number, t.null]),
29689
+ /** Date and time at which the assessment was last updated. */
29156
29690
  lastUpdated: t.string,
29691
+ /** Number of risks captured on the assessment with a low risk level. */
29157
29692
  lowRisk: t.number,
29693
+ /** Number of risks captured on the assessment with a medium risk level. */
29158
29694
  mediumRisk: t.number,
29695
+ /** Number of risks captured on the assessment with a high risk level. */
29159
29696
  highRisk: t.number,
29697
+ /** Name of the assessment. */
29160
29698
  name: t.string,
29699
+ /** Number of open risks that have not been addressed. */
29161
29700
  openRiskCount: t.number,
29701
+ /** The organization group */
29162
29702
  orgGroup: t.intersection([t.type({
29703
+ /** The ID of the organization group */
29163
29704
  id: t.string,
29705
+ /** The name of the organization group */
29164
29706
  name: t.string
29165
- }), t.partial({ nameKey: t.union([t.string, t.null]) })]),
29707
+ }), t.partial({
29708
+ /** The name key of the template */
29709
+ nameKey: t.union([t.string, t.null]) })]),
29710
+ /** The primary record */
29166
29711
  primaryEntityDetails: OneTrustPrimaryEntityDetails,
29712
+ /** Type of inventory record designated as the primary record. */
29167
29713
  primaryRecordType: t.union([t.string, t.null]),
29714
+ /** Overall risk score after considering existing controls. */
29168
29715
  residualRiskScore: t.union([t.number, t.null]),
29716
+ /** The respondent */
29169
29717
  respondent: t.type({
29718
+ /** The ID of the respondent */
29170
29719
  id: t.string,
29720
+ /** The name or email of the respondent */
29171
29721
  name: t.string
29172
29722
  }),
29723
+ /** The respondents */
29173
29724
  respondents: t.array(t.type({
29725
+ /** The ID of the respondent */
29174
29726
  id: t.string,
29727
+ /** The name or email of the respondent */
29175
29728
  name: t.string,
29729
+ /** The name key of the template */
29176
29730
  nameKey: t.union([t.string, t.null])
29177
29731
  })),
29732
+ /** Result of the assessment. */
29178
29733
  result: t.union([t.string, t.null]),
29734
+ /** ID of the result. */
29179
29735
  resultId: t.union([t.string, t.null]),
29736
+ /** Name of the result. */
29180
29737
  resultName: t.union([
29181
29738
  t.literal("Approved - Remediation required"),
29182
29739
  t.literal("Approved"),
@@ -29185,6 +29742,7 @@ const OneTrustGetAssessmentResponse = t.type({
29185
29742
  t.string,
29186
29743
  t.null
29187
29744
  ]),
29745
+ /** Risk level of the assessment. */
29188
29746
  riskLevel: t.union([
29189
29747
  t.literal("None"),
29190
29748
  t.literal("Low"),
@@ -29192,17 +29750,28 @@ const OneTrustGetAssessmentResponse = t.type({
29192
29750
  t.literal("High"),
29193
29751
  t.literal("Very High")
29194
29752
  ]),
29753
+ /** List of sections in the assessment. */
29195
29754
  sections: t.array(OneTrustAssessmentSection),
29755
+ /** Date and time at which the assessment was submitted. */
29196
29756
  submittedOn: t.union([t.string, t.null]),
29757
+ /** List of tags associated with the assessment. */
29197
29758
  tags: t.array(t.string),
29759
+ /** The desired target risk score. */
29198
29760
  targetRiskScore: t.union([t.number, t.null]),
29761
+ /** The template */
29199
29762
  template: t.type({
29763
+ /** The ID of the template */
29200
29764
  id: t.string,
29765
+ /** The name of the template */
29201
29766
  name: t.string,
29767
+ /** The name key of the template */
29202
29768
  nameKey: t.union([t.string, t.null])
29203
29769
  }),
29770
+ /** Number of total risks on the assessment. */
29204
29771
  totalRiskCount: t.number,
29772
+ /** Number of very high risks on the assessment. */
29205
29773
  veryHighRisk: t.number,
29774
+ /** Welcome text if any in the assessment. */
29206
29775
  welcomeText: t.union([t.string, t.null])
29207
29776
  });
29208
29777
  //#endregion
@@ -29212,50 +29781,86 @@ const OneTrustGetAssessmentResponse = t.type({
29212
29781
  * Return types of the "Get Risk" endpoint
29213
29782
  */
29214
29783
  const OneTrustEntityType = t.type({
29784
+ /** Indicates whether entity type is eligible for linking/relating with risk or not */
29215
29785
  eligibleForEntityLink: t.boolean,
29786
+ /** Indicates whether the entity type is enabled or not. */
29216
29787
  enabled: t.boolean,
29788
+ /** Entity Type ID. This can be Assets, Entities, PIA, Engagement, Custom Object GUID in form of String. */
29217
29789
  id: t.string,
29790
+ /** Entity Type Name. */
29218
29791
  label: t.string,
29792
+ /** Name of the module. */
29219
29793
  moduleName: t.union([t.string, t.null]),
29794
+ /** Indicates whether this type can be risk type or not in Risk */
29220
29795
  riskType: t.boolean,
29796
+ /** For Base Entity Type Seeded is true and false for Custom Object/Entity Types by default. */
29221
29797
  seeded: t.boolean,
29798
+ /** Indicates whether this type can be source type or not in Risk */
29222
29799
  sourceType: t.boolean,
29800
+ /** Translation Key of Entity Type ID. */
29223
29801
  translationKey: t.string
29224
29802
  });
29225
29803
  const OneTrustRiskLevel = t.type({
29804
+ /** Risk Impact Level name. */
29226
29805
  impactLevel: t.union([t.string, t.null]),
29806
+ /** Risk Impact level ID. */
29227
29807
  impactLevelId: t.union([t.number, t.null]),
29808
+ /** Risk Level Name. */
29228
29809
  level: t.union([t.string, t.null]),
29810
+ /** Risk Level ID. */
29229
29811
  levelId: t.union([t.number, t.null]),
29812
+ /** Risk Probability Level Name. */
29230
29813
  probabilityLevel: t.union([t.string, t.null]),
29814
+ /** Risk Probability Level ID. */
29231
29815
  probabilityLevelId: t.union([t.number, t.null]),
29816
+ /** Risk Score. */
29232
29817
  riskScore: t.union([t.number, t.null])
29233
29818
  });
29234
- const OneTrustRiskCategories = t.array(t.intersection([t.partial({ seeded: t.boolean }), t.type({
29819
+ const OneTrustRiskCategories = t.array(t.intersection([t.partial({
29820
+ /** Whether the category was seeded */
29821
+ seeded: t.boolean }), t.type({
29822
+ /** Identifier for Risk Category. */
29235
29823
  id: t.string,
29824
+ /** Risk Category Name. */
29236
29825
  name: t.string,
29826
+ /** Risk Category Name Key value for translation. */
29237
29827
  nameKey: t.string
29238
29828
  })]));
29239
29829
  const OneTrustRiskReference = t.type({
29830
+ /** The id of the risk reference */
29240
29831
  id: t.string,
29832
+ /** The type of the risk reference */
29241
29833
  type: t.string,
29834
+ /** The reference type of the risk reference */
29242
29835
  referenceType: OneTrustEntityType,
29836
+ /** The name of the risk reference */
29243
29837
  name: t.union([t.string, t.null]),
29838
+ /** The additional attributes of the risk reference */
29244
29839
  additionalAttributes: t.object
29245
29840
  });
29246
29841
  const OneTrustRiskReferences = t.array(OneTrustRiskReference);
29247
29842
  const OneTrustRiskTemplate = t.type({
29843
+ /** The id of the risk template */
29248
29844
  id: t.union([t.string, t.null]),
29845
+ /** The name of the risk template */
29249
29846
  name: t.union([t.string, t.null])
29250
29847
  });
29251
29848
  const OneTrustGetRiskResponse = t.type({
29849
+ /** The risk references */
29252
29850
  references: OneTrustRiskReferences,
29851
+ /** Whether the risk is closed */
29253
29852
  closed: t.boolean,
29853
+ /** The risk template */
29254
29854
  riskTemplate: OneTrustRiskTemplate,
29855
+ /** The currentStageApproversCount */
29255
29856
  currentStageApproversCount: t.number,
29857
+ /** List of associated inventories to the risk. */
29256
29858
  associatedInventories: t.array(t.type({
29859
+ /** ID of the Inventory. */
29257
29860
  inventoryId: t.string,
29861
+ /** Name of the Inventory. */
29258
29862
  inventoryName: t.string,
29863
+ /** Type of the Inventory. */
29259
29864
  inventoryType: t.union([
29260
29865
  t.literal("ASSETS"),
29261
29866
  t.literal("PROCESSING_ACTIVITIES"),
@@ -29263,32 +29868,59 @@ const OneTrustGetRiskResponse = t.type({
29263
29868
  t.literal("ENTITIES"),
29264
29869
  t.null
29265
29870
  ]),
29871
+ /** ID of the Inventory's Organization. */
29266
29872
  organizationId: t.union([t.string, t.null]),
29873
+ /** The source type */
29267
29874
  sourceType: OneTrustEntityType
29268
29875
  })),
29876
+ /** The attribute values associated with the risk */
29269
29877
  attributeValues: t.object,
29878
+ /** List of categories. */
29270
29879
  categories: OneTrustRiskCategories,
29880
+ /** List of Control Identifiers. */
29271
29881
  controlsIdentifier: t.array(t.string),
29882
+ /** Risk created time. */
29272
29883
  createdUTCDateTime: t.union([t.string, t.null]),
29884
+ /** Risk Creation Type. */
29273
29885
  creationType: t.union([t.string, t.null]),
29886
+ /** Date when the risk is closed. */
29274
29887
  dateClosed: t.union([t.string, t.null]),
29888
+ /** Deadline date for the risk. */
29275
29889
  deadline: t.union([t.string, t.null]),
29890
+ /** Risk delete type. */
29276
29891
  deleteType: t.union([t.literal("SOFT"), t.null]),
29892
+ /** Risk description. */
29277
29893
  description: t.union([t.string, t.null]),
29894
+ /** ID of the risk. */
29278
29895
  id: t.string,
29896
+ /** Residual impact level ID. */
29279
29897
  impactLevelId: t.union([t.number, t.null]),
29898
+ /** The inherent risk level */
29280
29899
  inherentRiskLevel: OneTrustRiskLevel,
29900
+ /** The risk justification */
29281
29901
  justification: t.union([t.string, t.null]),
29902
+ /** Residual level display name. */
29282
29903
  levelDisplayName: t.union([t.string, t.null]),
29904
+ /** Residual level ID. */
29283
29905
  levelId: t.union([t.number, t.null]),
29906
+ /** Risk mitigated date. */
29284
29907
  mitigatedDate: t.union([t.string, t.null]),
29908
+ /** Risk Mitigation details. */
29285
29909
  mitigation: t.union([t.string, t.null]),
29910
+ /** Short Name for a Risk. */
29286
29911
  name: t.union([t.string, t.null]),
29912
+ /** Integer risk identifier. */
29287
29913
  number: t.number,
29914
+ /** The organization group */
29288
29915
  orgGroup: t.intersection([t.type({
29916
+ /** The ID of the organization group */
29289
29917
  id: t.string,
29918
+ /** The name of the organization group */
29290
29919
  name: t.string
29291
- }), t.partial({ nameKey: t.union([t.string, t.null]) })]),
29920
+ }), t.partial({
29921
+ /** The name key of the template */
29922
+ nameKey: t.union([t.string, t.null]) })]),
29923
+ /** The previous risk state */
29292
29924
  previousState: t.union([
29293
29925
  t.literal("IDENTIFIED"),
29294
29926
  t.literal("RECOMMENDATION_ADDED"),
@@ -29300,12 +29932,19 @@ const OneTrustGetRiskResponse = t.type({
29300
29932
  t.literal("ARCHIVED_IN_VERSION"),
29301
29933
  t.null
29302
29934
  ]),
29935
+ /** Residual probability level. */
29303
29936
  probabilityLevel: t.union([t.string, t.null]),
29937
+ /** Residual probability level ID. */
29304
29938
  probabilityLevelId: t.union([t.number, t.null]),
29939
+ /** Risk Recommendation. */
29305
29940
  recommendation: t.union([t.string, t.null]),
29941
+ /** Proposed remediation. */
29306
29942
  remediationProposal: t.union([t.string, t.null]),
29943
+ /** Deadline reminder days. */
29307
29944
  reminderDays: t.union([t.number, t.null]),
29945
+ /** Risk exception request. */
29308
29946
  requestedException: t.union([t.string, t.null]),
29947
+ /** Risk Result. */
29309
29948
  result: t.union([
29310
29949
  t.literal("Accepted"),
29311
29950
  t.literal("Avoided"),
@@ -29315,19 +29954,33 @@ const OneTrustGetRiskResponse = t.type({
29315
29954
  t.literal("Ignored"),
29316
29955
  t.null
29317
29956
  ]),
29957
+ /** Risk approvers name csv. */
29318
29958
  riskApprovers: t.union([t.string, t.null]),
29959
+ /** Risk approvers ID. */
29319
29960
  riskApproversId: t.array(t.string),
29961
+ /** List of risk owners ID. */
29320
29962
  riskOwnersId: t.union([t.array(t.string), t.null]),
29963
+ /** Risk owners name csv. */
29321
29964
  riskOwnersName: t.union([t.string, t.null]),
29965
+ /** Risk score. */
29322
29966
  riskScore: t.union([t.number, t.null]),
29967
+ /** The risk source type */
29323
29968
  riskSourceType: OneTrustEntityType,
29969
+ /** The risk type */
29324
29970
  riskType: OneTrustEntityType,
29971
+ /** For Auto risk, rule Id reference. */
29325
29972
  ruleRootVersionId: t.union([t.string, t.null]),
29973
+ /** The risk source */
29326
29974
  source: t.type({
29975
+ /** Additional information about the Source Entity */
29327
29976
  additionalAttributes: t.object,
29977
+ /** Source Entity ID. */
29328
29978
  id: t.union([t.string, t.null]),
29979
+ /** Source Entity Name. */
29329
29980
  name: t.union([t.string, t.null]),
29981
+ /** The risk source type */
29330
29982
  sourceType: t.union([OneTrustEntityType, t.null]),
29983
+ /** Source Entity Type. */
29331
29984
  type: t.union([
29332
29985
  t.literal("PIA"),
29333
29986
  t.literal("RA"),
@@ -29338,6 +29991,7 @@ const OneTrustGetRiskResponse = t.type({
29338
29991
  t.null
29339
29992
  ])
29340
29993
  }),
29994
+ /** Risk Source Type. */
29341
29995
  sourceType: t.union([
29342
29996
  t.literal("PIA"),
29343
29997
  t.literal("RA"),
@@ -29347,14 +30001,21 @@ const OneTrustGetRiskResponse = t.type({
29347
30001
  t.literal("GENERIC"),
29348
30002
  t.null
29349
30003
  ]),
30004
+ /** The risk stage */
29350
30005
  stage: t.intersection([t.partial({
30006
+ /** The currentStageApprovers */
29351
30007
  currentStageApprovers: t.array(t.string),
30008
+ /** The badgeColor */
29352
30009
  badgeColor: t.union([t.string, t.null])
29353
30010
  }), t.type({
30011
+ /** ID of an entity. */
29354
30012
  id: t.string,
30013
+ /** Name of an entity. */
29355
30014
  name: t.string,
30015
+ /** Name Key of the entity for translation. */
29356
30016
  nameKey: t.string
29357
30017
  })]),
30018
+ /** The risk state */
29358
30019
  state: t.union([
29359
30020
  t.literal("IDENTIFIED"),
29360
30021
  t.literal("RECOMMENDATION_ADDED"),
@@ -29365,13 +30026,20 @@ const OneTrustGetRiskResponse = t.type({
29365
30026
  t.literal("RETAINED"),
29366
30027
  t.literal("ARCHIVED_IN_VERSION")
29367
30028
  ]),
30029
+ /** The target risk level */
29368
30030
  targetRiskLevel: OneTrustRiskLevel,
30031
+ /** The risk threat */
29369
30032
  threat: t.union([t.type({
30033
+ /** Threat ID. */
29370
30034
  id: t.string,
30035
+ /** Threat Identifier. */
29371
30036
  identifier: t.string,
30037
+ /** Threat Name. */
29372
30038
  name: t.string
29373
30039
  }), t.null]),
30040
+ /** Risk Treatment. */
29374
30041
  treatment: t.union([t.string, t.null]),
30042
+ /** Risk Treatment status. */
29375
30043
  treatmentStatus: t.union([
29376
30044
  t.literal("InProgress"),
29377
30045
  t.literal("UnderReview"),
@@ -29380,6 +30048,7 @@ const OneTrustGetRiskResponse = t.type({
29380
30048
  t.literal("ExceptionGranted"),
29381
30049
  t.null
29382
30050
  ]),
30051
+ /** Risk Type. */
29383
30052
  type: t.union([
29384
30053
  t.literal("ASSESSMENTS"),
29385
30054
  t.literal("ASSETS"),
@@ -29390,41 +30059,63 @@ const OneTrustGetRiskResponse = t.type({
29390
30059
  t.literal("ENGAGEMENTS"),
29391
30060
  t.null
29392
30061
  ]),
30062
+ /** ID of an assessment. */
29393
30063
  typeRefIds: t.array(t.string),
30064
+ /** List of vulnerabilities */
29394
30065
  vulnerabilities: t.union([t.array(t.type({
30066
+ /** Vulnerability ID. */
29395
30067
  id: t.string,
30068
+ /** Vulnerability Identifier. */
29396
30069
  identifier: t.string,
30070
+ /** Vulnerability Name. */
29397
30071
  name: t.string
29398
30072
  })), t.null]),
30073
+ /** The risk workflow */
29399
30074
  workflow: t.intersection([t.type({
30075
+ /** ID of an entity. */
29400
30076
  id: t.string,
30077
+ /** Name of an entity. */
29401
30078
  name: t.string
29402
30079
  }), t.partial({
30080
+ /** The name Key */
29403
30081
  nameKey: t.union([t.string, t.null]),
30082
+ /** The badgeColor */
29404
30083
  badgeColor: t.union([t.string, t.null])
29405
30084
  })])
29406
30085
  });
29407
30086
  //#endregion
29408
30087
  //#region src/oneTrust/endpoints/getUser.ts
29409
30088
  const OneTrustUserMetadata = t.type({
30089
+ /** When the user was created */
29410
30090
  created: t.string,
30091
+ /** When the user was modified */
29411
30092
  lastModified: t.string,
30093
+ /** The URI for accessing information about the user */
29412
30094
  location: t.string,
30095
+ /** The resource type */
29413
30096
  resourceType: t.literal("User")
29414
30097
  });
29415
30098
  const OneTrustUserName = t.partial({
30099
+ /** The user's family name */
29416
30100
  familyName: t.string,
30101
+ /** The user's given name */
29417
30102
  givenName: t.string
29418
30103
  });
29419
30104
  const OneTrustUserGroup = t.type({
30105
+ /** The user group's identification */
29420
30106
  value: t.string,
30107
+ /** The user group's display name */
29421
30108
  display: t.string
29422
30109
  });
29423
30110
  const OneTrustUserGroups = t.array(OneTrustUserGroup);
29424
30111
  const OneTrustUserEmail = t.type({
30112
+ /** The email value */
29425
30113
  value: t.string,
30114
+ /** The email display name */
29426
30115
  display: t.string,
30116
+ /** Whether this is the primary email */
29427
30117
  primary: t.boolean,
30118
+ /** The email type */
29428
30119
  type: t.union([t.string, t.literal("work")])
29429
30120
  });
29430
30121
  const OneTrustUserEmails = t.array(OneTrustUserEmail);
@@ -29433,17 +30124,29 @@ const OneTrustUserEmails = t.array(OneTrustUserEmail);
29433
30124
  * ref: https://developer.onetrust.com/onetrust/reference/getuserusingget
29434
30125
  */
29435
30126
  const OneTrustGetUserResponse = t.type({
30127
+ /** ID of the user. */
29436
30128
  id: t.string,
30129
+ /** External ID of the user. */
29437
30130
  externalId: t.union([t.string, t.null]),
30131
+ /** Metadata of the user. */
29438
30132
  meta: OneTrustUserMetadata,
30133
+ /** Schemas of the user */
29439
30134
  schemas: t.array(t.string),
30135
+ /** Name or email of the user */
29440
30136
  userName: t.string,
30137
+ /** Full name of the user */
29441
30138
  name: OneTrustUserName,
30139
+ /** Type of the user */
29442
30140
  userType: t.union([t.literal("Internal"), t.literal("External")]),
30141
+ /** Flag to check if the user is an active user or not. */
29443
30142
  active: t.boolean,
30143
+ /** The groups that the user belongs to */
29444
30144
  groups: OneTrustUserGroups,
30145
+ /** The emails of the user */
29445
30146
  emails: OneTrustUserEmails,
30147
+ /** The roles of the user */
29446
30148
  roles: t.array(t.string),
30149
+ /** The title of the user */
29447
30150
  title: t.union([t.string, t.null])
29448
30151
  });
29449
30152
  //#endregion
@@ -29515,36 +30218,53 @@ const DecryptionStatus = makeEnum({
29515
30218
  * Preference store identifier
29516
30219
  */
29517
30220
  const PreferenceStoreIdentifier = t.type({
30221
+ /** The identifier name (email, phone etc) */
29518
30222
  name: t.string,
30223
+ /** The identifier value */
29519
30224
  value: t.string
29520
30225
  });
29521
30226
  /**
29522
30227
  * Preference store system attributes which are not user editable
29523
30228
  */
29524
- const PreferenceStoreSystemAttributes = t.intersection([t.type({ decryptionStatus: valuesOf(DecryptionStatus) }), t.partial({ updatedAt: t.string })]);
30229
+ const PreferenceStoreSystemAttributes = t.intersection([t.type({
30230
+ /** The decrypted status of the record */
30231
+ decryptionStatus: valuesOf(DecryptionStatus) }), t.partial({
30232
+ /** updated timestamp on the db record */
30233
+ updatedAt: t.string })]);
29525
30234
  /**
29526
30235
  * Contains all the Consent management related fields
29527
30236
  * that are stored in the preference store.
29528
30237
  */
29529
30238
  const PreferenceStoreConsentFields = t.type({
30239
+ /** US IAB Privacy String */
29530
30240
  usp: t.union([t.string, t.null]),
30241
+ /** IAB GPP String */
29531
30242
  gpp: t.union([t.string, t.null]),
30243
+ /** IAB TCF String */
29532
30244
  tcf: t.union([t.string, t.null]),
30245
+ /** Airgap Version */
29533
30246
  airgapVersion: t.union([t.string, t.null])
29534
30247
  });
29535
30248
  /**
29536
30249
  * The format key required fields of the preference store record
29537
30250
  */
29538
30251
  const PreferenceStoreKeyConditionals = t.type({
30252
+ /** The partition key */
29539
30253
  partition: t.string,
30254
+ /** last consent event timestamp (ISO 8601) */
29540
30255
  timestamp: t.string
29541
30256
  });
29542
30257
  /** The format for a preference which include topic and user choice */
29543
30258
  const Preference = t.type({
30259
+ /** The preference topic */
29544
30260
  topic: t.string,
30261
+ /** The preference choice made by the user */
29545
30262
  choice: t.partial({
30263
+ /** The boolean value of the preference */
29546
30264
  booleanValue: t.union([t.boolean, t.null]),
30265
+ /** The select value of the preference */
29547
30266
  selectValue: t.union([t.string, t.null]),
30267
+ /** The select values of the preference */
29548
30268
  selectValues: t.union([t.array(t.string), t.null])
29549
30269
  })
29550
30270
  });
@@ -29552,71 +30272,134 @@ const Preference = t.type({
29552
30272
  * The format for a preference store purpose
29553
30273
  */
29554
30274
  const PreferenceStorePurposeResponse = t.intersection([t.type({
30275
+ /** tracking purpose */
29555
30276
  purpose: t.string,
30277
+ /** Whether the purpose is enabled */
29556
30278
  enabled: t.boolean
29557
- }), t.partial({ preferences: t.array(Preference) })]);
30279
+ }), t.partial({
30280
+ /** additional preference associated with this purpose */
30281
+ preferences: t.array(Preference) })]);
29558
30282
  const PreferenceQueryResponseItem = t.intersection([
29559
30283
  PreferenceStoreKeyConditionals,
29560
30284
  t.type({
30285
+ /** The system attributes of the record */
29561
30286
  system: PreferenceStoreSystemAttributes,
30287
+ /** Consent management related fields */
29562
30288
  consentManagement: t.partial(PreferenceStoreConsentFields.props),
30289
+ /** Preference store purposes */
29563
30290
  purposes: t.array(PreferenceStorePurposeResponse)
29564
30291
  }),
29565
30292
  t.partial({
30293
+ /** Primary identifier of the user. */
29566
30294
  userId: t.string,
30295
+ /** Identifiers associated to the user */
29567
30296
  identifiers: t.array(PreferenceStoreIdentifier),
30297
+ /** metadata */
29568
30298
  metadata: t.array(t.type({
29569
30299
  key: t.string,
29570
30300
  value: t.string
29571
30301
  })),
30302
+ /** last updated for metadata */
29572
30303
  metadataTimestamp: t.string
29573
30304
  })
29574
30305
  ]);
29575
30306
  const CustomFieldApiInput = t.type({
30307
+ /** The attribute key that houses the attribute values */
29576
30308
  key: t.string,
30309
+ /** The attribute values used to label resources */
29577
30310
  values: t.array(t.string)
29578
30311
  });
29579
30312
  /** The format of the preference store workflow settings */
29580
30313
  const PreferenceStoreWorkflowSettings = t.partial({
30314
+ /** Additional tags to forward to the DSR event */
29581
30315
  attributes: t.array(CustomFieldApiInput),
30316
+ /** Data silo IDs to run the workflow on */
29582
30317
  dataSiloIds: t.array(t.string),
30318
+ /** The email template ID to use for the receipt */
29583
30319
  emailReceiptTemplateId: t.string,
30320
+ /** Data silo IDs to ignore when running the workflow */
29584
30321
  ignoreDataSiloIds: t.array(t.string),
30322
+ /** If the workflow is silent */
29585
30323
  isSilent: t.boolean,
30324
+ /** if the workflow is a test run */
29586
30325
  isTest: t.boolean,
30326
+ /** if the workflow should skip sending the receipt */
29587
30327
  skipSendingReceipt: t.boolean,
30328
+ /** if the workflow should skip the waiting period */
29588
30329
  skipWaitingPeriod: t.boolean,
30330
+ /** if the workflow should be skipped */
29589
30331
  skipWorkflowTrigger: t.boolean,
30332
+ /** Force trigger the workflow even when there was no concent/preference change */
29590
30333
  forceTriggerWorkflow: t.boolean,
30334
+ /** Country and/or country subdivision, to pass along to DSR request */
29591
30335
  region: t.partial({
30336
+ /** The country ISO code */
29592
30337
  country: valuesOf(IsoCountryCode),
30338
+ /** The country subdivision ISO code */
29593
30339
  countrySubDivision: valuesOf(IsoCountrySubdivisionCode)
29594
30340
  }),
30341
+ /** Language to translate request to */
29595
30342
  locale: t.string,
30343
+ /** The data subject type associated with the request */
29596
30344
  subjectType: t.string,
30345
+ /** The workflow's V2 configuration ID to use */
29597
30346
  workflowConfigId: t.string
29598
30347
  });
29599
30348
  /**
29600
30349
  * The format for a preference store purpose
29601
30350
  */
29602
30351
  const PreferenceStorePurposeUpdate = t.intersection([PreferenceStorePurposeResponse, t.partial({
30352
+ /** Timestamp of when the purpose was last updated (ISO 8601) */
29603
30353
  timestamp: t.string,
30354
+ /** Additional tags to forward to the DSR event */
29604
30355
  attributes: t.array(CustomFieldApiInput),
30356
+ /** Consent workflow settings */
29605
30357
  workflowSettings: PreferenceStoreWorkflowSettings,
30358
+ /** Language to translate request to */
29606
30359
  locale: t.string
29607
30360
  })]);
29608
30361
  const PreferenceUpdateItem = t.intersection([PreferenceStoreKeyConditionals, t.partial({
30362
+ /** Primary identifier of the user. */
29609
30363
  userId: t.string,
30364
+ /** Identifiers associated to the user */
29610
30365
  identifiers: t.array(PreferenceStoreIdentifier),
30366
+ /** Preference store purposes */
29611
30367
  purposes: t.array(PreferenceStorePurposeUpdate),
30368
+ /** Consent management related fields */
29612
30369
  consentManagement: t.partial(PreferenceStoreConsentFields.props),
30370
+ /**
30371
+ * Language to translate DSR processing
30372
+ * TODO: https://transcend.height.app/T-40208 - move this to `PreferenceStoreKeyConditionals` when stored on record
30373
+ */
29613
30374
  locale: t.string,
30375
+ /** The metadata associated with the record */
29614
30376
  metadata: t.array(t.type({
30377
+ /** metadata key */
29615
30378
  key: t.string,
30379
+ /**
30380
+ * metadata value
30381
+ *
30382
+ * - **null**: to remove the metadata key
30383
+ * - **string**: to set the metadata key
30384
+ */
29616
30385
  value: t.union([t.string, t.null])
29617
30386
  })),
30387
+ /** User birthdate. Optional. Accepted formats: YYYY-MM-DD, YYYY-MM, or MM-YYYY. Format enforcement is in the main repo. */
29618
30388
  birthDate: t.string,
29619
- options: t.partial({ mergeRecordsOnConflict: t.boolean })
30389
+ /** Options to configure the upsert behavior */
30390
+ options: t.partial({
30391
+ /**
30392
+ * Whether to merge consent records, if the any one of the
30393
+ * identifiers in `identifiers` list is already associated to an existing record.
30394
+ *
30395
+ * If true, the consent record will be merged
30396
+ * combining the identifiers and consent details.
30397
+ *
30398
+ * If false, an error will be returned if a conflict is detected.
30399
+ *
30400
+ * Default: true
30401
+ */
30402
+ mergeRecordsOnConflict: t.boolean })
29620
30403
  })]);
29621
30404
  /**
29622
30405
  * The supported preference topic types
@@ -29636,7 +30419,9 @@ const PreferenceStoreAuthLevel = makeEnum({
29636
30419
  });
29637
30420
  /** The standard scopes which are used to access the Sombra APIs */
29638
30421
  const SombraStandardScope = makeEnum({
30422
+ /** Access to Preference Management APIs */
29639
30423
  PreferenceManagement: "preferenceManagement",
30424
+ /** DSR Automation APIs */
29640
30425
  DSRAutomation: "dsrAutomation"
29641
30426
  });
29642
30427
  //#endregion
@@ -29645,8 +30430,11 @@ const SombraStandardScope = makeEnum({
29645
30430
  * The status of a DPIA with a particular processing activity
29646
30431
  */
29647
30432
  const DataProtectionImpactAssessmentStatus = makeEnum({
30433
+ /** There is a link associated with this processing activity's DPIA */
29648
30434
  Link: "LINK",
30435
+ /** There is no DPIA required for this processing activity */
29649
30436
  NotRequired: "NOT_REQUIRED",
30437
+ /** The DPIA for this processing activity is missing */
29650
30438
  Missing: "MISSING"
29651
30439
  });
29652
30440
  //#endregion
@@ -29724,10 +30512,10 @@ let PromptFilePurpose = /* @__PURE__ */ function(PromptFilePurpose) {
29724
30512
  return PromptFilePurpose;
29725
30513
  }({});
29726
30514
  const PROMPT_FILE_PURPOSE_TO_OPEN_AI = {
29727
- [PromptFilePurpose.Assistants]: "assistants",
29728
- [PromptFilePurpose.AssistantsOutput]: "assistants_output",
29729
- [PromptFilePurpose.FineTune]: "fine-tune",
29730
- [PromptFilePurpose.FineTuneResults]: "fine-tune-results"
30515
+ ["ASSISTANTS"]: "assistants",
30516
+ ["ASSISTANTS_OUTPUT"]: "assistants_output",
30517
+ ["FINE_TUNE"]: "fine-tune",
30518
+ ["FINE_TUNE_RESULTS"]: "fine-tune-results"
29731
30519
  };
29732
30520
  //#endregion
29733
30521
  //#region src/promptAVendor.ts
@@ -29735,53 +30523,88 @@ const PROMPT_FILE_PURPOSE_TO_OPEN_AI = {
29735
30523
  * Prompt-a-Vendor email send type.
29736
30524
  */
29737
30525
  const PromptAVendorEmailSendType = makeEnum({
30526
+ /** Send a single email encapsulating all profiles, i.e. at the RequestDataSilo level. */
29738
30527
  PerDsr: "PER_DSR",
30528
+ /** Send an email for all DSRs, that the vendor has not been notified of yet. */
29739
30529
  CrossDsr: "CROSS_DSR"
29740
30530
  });
29741
30531
  /**
29742
30532
  * Prompt-a-Vendor Email Completion link type.
29743
30533
  */
29744
30534
  const PromptAVendorEmailCompletionLinkType = makeEnum({
30535
+ /** Present a link that requires a user logged into Transcend. */
29745
30536
  LoggedInUser: "LOGGED_IN_USER",
30537
+ /**
30538
+ * Present a link that allows an external, unauthenticated user
30539
+ * to access the Bulk Requests UI.
30540
+ */
29746
30541
  UnauthenticatedExternalUser: "UNAUTHENTICATED_EXTERNAL_USER",
30542
+ /**
30543
+ * Send no completion fulfillment link, and mark each datapoint
30544
+ * as resolved, once the email is sent.
30545
+ */
29747
30546
  NoLinkMarkDatapointAsResolved: "NO_LINK_MARK_DATAPOINT_AS_RESOLVED"
29748
30547
  });
29749
30548
  //#endregion
29750
30549
  //#region src/purposeSubCategories/additional.ts
29751
- const AdditionalPurposeSubCategory = makeEnum({ Additional: "ADDITIONAL" });
30550
+ const AdditionalPurposeSubCategory = makeEnum({
30551
+ /** Fallback sub purpose */
30552
+ Additional: "ADDITIONAL" });
29752
30553
  //#endregion
29753
30554
  //#region src/purposeSubCategories/advertising.ts
29754
- const AdvertisingPurposeSubCategory = makeEnum({ Advertising: "ADVERTISING" });
30555
+ const AdvertisingPurposeSubCategory = makeEnum({
30556
+ /** Fallback sub purpose */
30557
+ Advertising: "ADVERTISING" });
29755
30558
  //#endregion
29756
30559
  //#region src/purposeSubCategories/analytics.ts
29757
- const AnalyticsPurposeSubCategory = makeEnum({ Analytics: "ANALYTICS" });
30560
+ const AnalyticsPurposeSubCategory = makeEnum({
30561
+ /** Fallback sub purpose */
30562
+ Analytics: "ANALYTICS" });
29758
30563
  //#endregion
29759
30564
  //#region src/purposeSubCategories/essential.ts
29760
- const EssentialPurposeSubCategory = makeEnum({ Essential: "ESSENTIAL" });
30565
+ const EssentialPurposeSubCategory = makeEnum({
30566
+ /** Fallback sub purpose */
30567
+ Essential: "ESSENTIAL" });
29761
30568
  //#endregion
29762
30569
  //#region src/purposeSubCategories/hr.ts
29763
- const HRPurposeSubCategory = makeEnum({ HR: "HR" });
30570
+ const HRPurposeSubCategory = makeEnum({
30571
+ /** Fallback sub purpose */
30572
+ HR: "HR" });
29764
30573
  //#endregion
29765
30574
  //#region src/purposeSubCategories/legal.ts
29766
- const LegalPurposeSubCategory = makeEnum({ Legal: "LEGAL" });
30575
+ const LegalPurposeSubCategory = makeEnum({
30576
+ /** Fallback sub purpose */
30577
+ Legal: "LEGAL" });
29767
30578
  //#endregion
29768
30579
  //#region src/purposeSubCategories/marketing.ts
29769
- const MarketingPurposeSubCategory = makeEnum({ Marketing: "MARKETING" });
30580
+ const MarketingPurposeSubCategory = makeEnum({
30581
+ /** Fallback sub purpose */
30582
+ Marketing: "MARKETING" });
29770
30583
  //#endregion
29771
30584
  //#region src/purposeSubCategories/operationSecurity.ts
29772
- const OperationSecurityPurposeSubCategory = makeEnum({ OperationSecurity: "OPERATION_SECURITY" });
30585
+ const OperationSecurityPurposeSubCategory = makeEnum({
30586
+ /** Fallback sub purpose */
30587
+ OperationSecurity: "OPERATION_SECURITY" });
29773
30588
  //#endregion
29774
30589
  //#region src/purposeSubCategories/other.ts
29775
- const OtherPurposeSubCategory = makeEnum({ Other: "Other" });
30590
+ const OtherPurposeSubCategory = makeEnum({
30591
+ /** Fallback sub purpose */
30592
+ Other: "Other" });
29776
30593
  //#endregion
29777
30594
  //#region src/purposeSubCategories/personalization.ts
29778
- const PersonalizationPurposeSubCategory = makeEnum({ Personalization: "PERSONALIZATION" });
30595
+ const PersonalizationPurposeSubCategory = makeEnum({
30596
+ /** Fallback sub purpose */
30597
+ Personalization: "PERSONALIZATION" });
29779
30598
  //#endregion
29780
30599
  //#region src/purposeSubCategories/sale.ts
29781
- const SalePurposeSubCategory = makeEnum({ Sale: "SALE" });
30600
+ const SalePurposeSubCategory = makeEnum({
30601
+ /** Fallback sub purpose */
30602
+ Sale: "SALE" });
29782
30603
  //#endregion
29783
30604
  //#region src/purposeSubCategories/transfer.ts
29784
- const TransferPurposeSubCategory = makeEnum({ Transfer: "TRANSFER" });
30605
+ const TransferPurposeSubCategory = makeEnum({
30606
+ /** Fallback sub purpose */
30607
+ Transfer: "TRANSFER" });
29785
30608
  //#endregion
29786
30609
  //#region src/purposeSubCategories/index.ts
29787
30610
  const DefaultPurposeSubCategoryType = makeEnum({
@@ -29811,7 +30634,18 @@ const NORMALIZE_PHONE_NUMBER = /[-\s.]/g;
29811
30634
  * This is useful for the purposes of uploading a backlog
29812
30635
  */
29813
30636
  const PreflightRequestStatus = makeEnum({
30637
+ /**
30638
+ * The privacy request should be canceled because the
30639
+ * user is not allowed to make the request. The user will be
30640
+ * notified via email of the cancellation.
30641
+ * Note: if the request is in silent mode, no emails are ever sent
30642
+ */
29814
30643
  CANCELED: "CANCELED",
30644
+ /**
30645
+ * The privacy request is placed on hold and will need manual intervention.
30646
+ * This will not trigger a notification to the end user, but admin can be
30647
+ * notified that there is a request that requires their review.
30648
+ */
29815
30649
  ON_HOLD: "ON_HOLD"
29816
30650
  });
29817
30651
  /**
@@ -29819,31 +30653,52 @@ const PreflightRequestStatus = makeEnum({
29819
30653
  * This is useful for the purposes of uploading a backlog
29820
30654
  */
29821
30655
  const CompletedRequestStatus = makeEnum({
30656
+ /** The data subject failed to verify at least one of the identifier they submit through the form */
29822
30657
  FailedVerification: "FAILED_VERIFICATION",
30658
+ /** The request has been approved and sent to the data subject with no secondary action */
29823
30659
  Completed: "COMPLETED",
30660
+ /** The request was canceled and the data subject was notified */
29824
30661
  Canceled: "CANCELED",
30662
+ /** The secondary request action completed compilation */
29825
30663
  SecondaryCompleted: "SECONDARY_COMPLETED",
30664
+ /** The request was revoked because it was a duplicate (another open request covers it) */
29826
30665
  Revoked: "REVOKED"
29827
30666
  });
29828
30667
  /**
29829
30668
  * The statuses that a request can take on
29830
30669
  */
29831
30670
  const RequestStatus = makeEnum({
30671
+ /** A data subject submits a DSR */
29832
30672
  RequestMade: "REQUEST_MADE",
30673
+ /** The data subject failed to verify at least one of the identifier they submit through the form */
29833
30674
  FailedVerification: "FAILED_VERIFICATION",
30675
+ /** The request identifiers have been verified and they are enriched to create other identifiers */
29834
30676
  Enriching: "ENRICHING",
30677
+ /** The request is temporarily placed on hold */
29835
30678
  OnHold: "ON_HOLD",
30679
+ /** The request is waiting to compile */
29836
30680
  Waiting: "WAITING",
30681
+ /** The request begins compiling across the organization's Connected Services, specific to the actions requested */
29837
30682
  Compiling: "COMPILING",
30683
+ /** The request is compiled and appending review before send */
29838
30684
  Approving: "APPROVING",
30685
+ /** The primary action has been sent to the data subject and the request is delayed until the secondary action is executed */
29839
30686
  Delayed: "DELAYED",
30687
+ /** The request has been approved and sent to the data subject with no secondary action */
29840
30688
  Completed: "COMPLETED",
30689
+ /** The request is in a state where the data subject report zip can be downloaded. This is typically a completed ACCESS request */
29841
30690
  Downloadable: "DOWNLOADABLE",
30691
+ /** The request is completed but not available for download, but its data categories are visible on the Privacy Center */
29842
30692
  ViewCategories: "VIEW_CATEGORIES",
30693
+ /** The request was canceled and the data subject was notified */
29843
30694
  Canceled: "CANCELED",
30695
+ /** The secondary request action begins compiling across the organization's Connected Services, i.e. erasure is actually called */
29844
30696
  Secondary: "SECONDARY",
30697
+ /** The secondary request action completed compilation */
29845
30698
  SecondaryCompleted: "SECONDARY_COMPLETED",
30699
+ /** The request is pending approval before final deletion request email is sent to the data subject */
29846
30700
  SecondaryApproving: "SECONDARY_APPROVING",
30701
+ /** The request was revoked because it was a duplicate (another open request covers it) */
29847
30702
  Revoked: "REVOKED"
29848
30703
  });
29849
30704
  /**
@@ -29866,12 +30721,30 @@ let RequestOrigin = /* @__PURE__ */ function(RequestOrigin) {
29866
30721
  * The statuses that a queue is expected to implement
29867
30722
  */
29868
30723
  const QueueStatus = makeEnum({
30724
+ /** The row is queued up to be processed by the service worker. */
29869
30725
  Queued: "QUEUED",
30726
+ /**
30727
+ * The service worker has fired and is waiting on an asynchronous response.
30728
+ * If waiting for too long, the item should be retried
30729
+ */
29870
30730
  Waiting: "WAITING",
30731
+ /**
30732
+ * The processing was skipped because the record was no longer found.
30733
+ * The information may have been deleted already by another process.
30734
+ *
30735
+ * If a data silo is consistently skipping operations, there may be a deeper issue.
30736
+ */
29871
30737
  Skipped: "SKIPPED",
30738
+ /** An error occurred while processing the row. The error message is stored on the model. */
29872
30739
  Error: "ERROR",
30740
+ /** The service worker successfully processed the row. */
29873
30741
  Resolved: "RESOLVED",
30742
+ /** The item requires attention for some reason */
29874
30743
  ActionRequired: "ACTION_REQUIRED",
30744
+ /**
30745
+ * The Item has been successfully ingested by our SQS task queue,
30746
+ * and is currently in line to being processed.
30747
+ */
29875
30748
  RemoteProcessing: "REMOTE_PROCESSING"
29876
30749
  });
29877
30750
  /**
@@ -29879,6 +30752,7 @@ const QueueStatus = makeEnum({
29879
30752
  */
29880
30753
  const RequestDataSiloStatus = makeEnum({
29881
30754
  ...QueueStatus,
30755
+ /** The request not processed due to some exception */
29882
30756
  SkippedDueToException: "SKIPPED_DUE_TO_EXCEPTION"
29883
30757
  });
29884
30758
  /**
@@ -29886,7 +30760,9 @@ const RequestDataSiloStatus = makeEnum({
29886
30760
  */
29887
30761
  const RequestEnricherStatus = makeEnum({
29888
30762
  ...QueueStatus,
30763
+ /** Waiting on dependencies in the enrichment step to finish running */
29889
30764
  WaitingOnDependencies: "WAITING_ON_DEPENDENCIES",
30765
+ /** Polling for result */
29890
30766
  Polling: "POLLING"
29891
30767
  });
29892
30768
  /**
@@ -29894,10 +30770,26 @@ const RequestEnricherStatus = makeEnum({
29894
30770
  * request submit.
29895
30771
  */
29896
30772
  const RegionDetectionMethod = makeEnum({
30773
+ /** Region detection is disabled */
29897
30774
  Disabled: "DISABLED",
30775
+ /** Auto detect the region and collect in form silently */
29898
30776
  Auto: "AUTO",
30777
+ /** Collect information about the user's region by presenting the user a form */
29899
30778
  Form: "FORM"
29900
30779
  });
30780
+ /**
30781
+ * How request identifiers should be handled when restarting a request.
30782
+ *
30783
+ * @see https://linear.app/transcend/issue/WAL-7712
30784
+ */
30785
+ const RestartIdentifierStrategy = makeEnum({
30786
+ /** Keep all identifiers; only input-sourced identifiers stay verified */
30787
+ PreserveInitialVerificationsOnly: "PRESERVE_INITIAL_VERIFICATIONS_ONLY",
30788
+ /** Keep all identifiers; preserve JWT verification from prior enrichment */
30789
+ PreserveAllVerifications: "PRESERVE_ALL_VERIFICATIONS",
30790
+ /** Delete enriched identifiers; keep only input-sourced identifiers */
30791
+ RemoveEnrichedIdentifiers: "REMOVE_ENRICHED_IDENTIFIERS"
30792
+ });
29901
30793
  //#endregion
29902
30794
  //#region src/scopes.ts
29903
30795
  /**
@@ -30045,834 +30937,834 @@ let TranscendProduct = /* @__PURE__ */ function(TranscendProduct) {
30045
30937
  * The action scope definitions
30046
30938
  */
30047
30939
  const SCOPES_WITHOUT_VIEW_ONLY = {
30048
- [ScopeName.FullAdmin]: {
30049
- dependencies: Object.values(ScopeName).filter((scope) => scope !== ScopeName.FullAdmin),
30940
+ ["fullAdmin"]: {
30941
+ dependencies: Object.values(ScopeName).filter((scope) => scope !== "fullAdmin"),
30050
30942
  description: "Full administrative access. All scopes are granted.",
30051
30943
  title: "Full Admin",
30052
- type: ScopeType.Modify,
30944
+ type: "MODIFY",
30053
30945
  products: getValues(TranscendProduct)
30054
30946
  },
30055
- [ScopeName.ManageSombraRootKeys]: {
30947
+ ["manageSombraRootKeys"]: {
30056
30948
  dependencies: [],
30057
30949
  description: "Ability to perform a key rotation on the encryption keys used within your account.",
30058
30950
  title: "Rotate Hosted Sombra keys",
30059
- type: ScopeType.Modify,
30060
- products: [TranscendProduct.Sombra]
30951
+ type: "MODIFY",
30952
+ products: ["SOMBRA"]
30061
30953
  },
30062
- [ScopeName.ManageGlobalAttributes]: {
30063
- dependencies: [ScopeName.ViewGlobalAttributes],
30954
+ ["manageGlobalAttributes"]: {
30955
+ dependencies: ["viewGlobalAttributes"],
30064
30956
  description: "Under the infrastructure tab, manage your custom attributes and select which views those attributes should display in.",
30065
30957
  title: "Manage Global Attributes",
30066
- type: ScopeType.Modify,
30958
+ type: "MODIFY",
30067
30959
  products: [
30068
- TranscendProduct.DsrAutomation,
30069
- TranscendProduct.DataInventory,
30070
- TranscendProduct.ConsentManagement,
30071
- TranscendProduct.StructuredDiscovery,
30072
- TranscendProduct.Administration,
30073
- TranscendProduct.Assessments,
30074
- TranscendProduct.Pathfinder,
30075
- TranscendProduct.PromptManagement,
30076
- TranscendProduct.WebAuditor,
30077
- TranscendProduct.ContractScanning
30960
+ "DSR_AUTOMATION",
30961
+ "DATA_INVENTORY",
30962
+ "CONSENT_MANAGEMENT",
30963
+ "STRUCTURED_DISCOVERY",
30964
+ "ADMINISTRATION",
30965
+ "ASSESSMENTS",
30966
+ "PATHFINDER",
30967
+ "PROMPT_MANAGER",
30968
+ "WEB_AUDITOR",
30969
+ "CONTRACT_SCANNING"
30078
30970
  ]
30079
30971
  },
30080
- [ScopeName.ManageAccessControl]: {
30081
- dependencies: [ScopeName.ViewEmployees, ScopeName.ViewScopes],
30972
+ ["manageAccessControl"]: {
30973
+ dependencies: ["viewEmployees", "viewScopes"],
30082
30974
  description: "Manage what employees in your organization can access within Transcend.",
30083
30975
  title: "Manage Access Controls",
30084
- type: ScopeType.Modify,
30085
- products: [TranscendProduct.Administration]
30976
+ type: "MODIFY",
30977
+ products: ["ADMINISTRATION"]
30086
30978
  },
30087
- [ScopeName.ManageBilling]: {
30979
+ ["manageBilling"]: {
30088
30980
  dependencies: [],
30089
30981
  description: "Manage billing details for your organization.",
30090
30982
  title: "Manage Billing",
30091
- type: ScopeType.Modify,
30092
- products: [TranscendProduct.Administration]
30983
+ type: "MODIFY",
30984
+ products: ["ADMINISTRATION"]
30093
30985
  },
30094
- [ScopeName.ManageSSO]: {
30095
- dependencies: [ScopeName.ViewSSO],
30986
+ ["manageSSO"]: {
30987
+ dependencies: ["viewSSO"],
30096
30988
  description: "Manage SSO configuration for members of your organization.",
30097
30989
  title: "Manage SSO",
30098
- type: ScopeType.Modify,
30099
- products: [TranscendProduct.Administration]
30990
+ type: "MODIFY",
30991
+ products: ["ADMINISTRATION"]
30100
30992
  },
30101
- [ScopeName.ManageApiKeys]: {
30102
- dependencies: [ScopeName.ViewApiKeys],
30993
+ ["manageApiKeys"]: {
30994
+ dependencies: ["viewApiKeys"],
30103
30995
  description: "Create, update and delete API keys for programmatic access to your Transcend organization.",
30104
30996
  title: "Manage API Keys",
30105
- type: ScopeType.Modify,
30106
- products: [TranscendProduct.Administration]
30997
+ type: "MODIFY",
30998
+ products: ["ADMINISTRATION"]
30107
30999
  },
30108
- [ScopeName.ManageOrganizationInfo]: {
31000
+ ["manageOrganizationInfo"]: {
30109
31001
  dependencies: [],
30110
31002
  description: "Edit the top-level organization settings details.",
30111
31003
  title: "Manage Organization Information",
30112
- type: ScopeType.Modify,
30113
- products: [TranscendProduct.Administration]
31004
+ type: "MODIFY",
31005
+ products: ["ADMINISTRATION"]
30114
31006
  },
30115
- [ScopeName.ManageEmailDomains]: {
30116
- dependencies: [ScopeName.ViewEmailDomains],
31007
+ ["manageEmailDomains"]: {
31008
+ dependencies: ["viewEmailDomains"],
30117
31009
  description: "Manage the domains from which Transcend can send emails on behalf of your organization.",
30118
31010
  title: "Manage Email Domains",
30119
- type: ScopeType.Modify,
31011
+ type: "MODIFY",
30120
31012
  products: [
30121
- TranscendProduct.Administration,
30122
- TranscendProduct.DsrAutomation,
30123
- TranscendProduct.PrivacyCenter,
30124
- TranscendProduct.Assessments
31013
+ "ADMINISTRATION",
31014
+ "DSR_AUTOMATION",
31015
+ "PRIVACY_CENTER",
31016
+ "ASSESSMENTS"
30125
31017
  ]
30126
31018
  },
30127
- [ScopeName.ManageDataSubCategories]: {
30128
- dependencies: [ScopeName.ViewDataSubCategories],
31019
+ ["manageDataSubCategories"]: {
31020
+ dependencies: ["viewDataSubCategories"],
30129
31021
  description: "Manage data sub categories mentioned in the data inventory",
30130
31022
  title: "Manage Data Sub Categories",
30131
- type: ScopeType.Modify,
30132
- products: [TranscendProduct.DataInventory]
31023
+ type: "MODIFY",
31024
+ products: ["DATA_INVENTORY"]
30133
31025
  },
30134
- [ScopeName.ViewCustomerDataPrivacyRequests]: {
31026
+ ["viewCustomerDataPrivacyRequests"]: {
30135
31027
  dependencies: [],
30136
31028
  description: "Give permissions for an employee to view the data in an access request.",
30137
31029
  title: "View Customer Data in Privacy Requests",
30138
- type: ScopeType.View,
30139
- products: [TranscendProduct.Administration, TranscendProduct.DsrAutomation]
31030
+ type: "VIEW",
31031
+ products: ["ADMINISTRATION", "DSR_AUTOMATION"]
30140
31032
  },
30141
- [ScopeName.ViewCustomerDataDataMapping]: {
31033
+ ["viewCustomerDataDataMapping"]: {
30142
31034
  dependencies: [],
30143
31035
  description: "Give permissions for an employee to view the sampled data in the data mapping product.",
30144
31036
  title: "View Customer Data in Data Mapping",
30145
- type: ScopeType.View,
31037
+ type: "VIEW",
30146
31038
  products: [
30147
- TranscendProduct.Administration,
30148
- TranscendProduct.StructuredDiscovery,
30149
- TranscendProduct.UnstructuredDiscovery
31039
+ "ADMINISTRATION",
31040
+ "STRUCTURED_DISCOVERY",
31041
+ "UNSTRUCTURED_DISCOVERY"
30150
31042
  ]
30151
31043
  },
30152
- [ScopeName.ViewApiKeys]: {
31044
+ ["viewApiKeys"]: {
30153
31045
  dependencies: [],
30154
31046
  description: "View the API keys on your account and see what scopes are assigned to them.",
30155
31047
  title: "View API Keys",
30156
- type: ScopeType.View,
30157
- products: [TranscendProduct.Administration]
31048
+ type: "VIEW",
31049
+ products: ["ADMINISTRATION"]
30158
31050
  },
30159
- [ScopeName.ViewAuditEvents]: {
31051
+ ["viewAuditEvents"]: {
30160
31052
  dependencies: [],
30161
31053
  description: "View any audit events made throughout the platform. This includes any of the \"Audit Trail\" tabs across the Admin Dashboard.",
30162
31054
  title: "View Audit Events",
30163
- type: ScopeType.View,
30164
- products: [TranscendProduct.Administration]
31055
+ type: "VIEW",
31056
+ products: ["ADMINISTRATION"]
30165
31057
  },
30166
- [ScopeName.ViewSSO]: {
31058
+ ["viewSSO"]: {
30167
31059
  dependencies: [],
30168
31060
  description: "View the SSO configuration for your organization.",
30169
31061
  title: "View SSO",
30170
- type: ScopeType.View,
30171
- products: [TranscendProduct.Administration]
31062
+ type: "VIEW",
31063
+ products: ["ADMINISTRATION"]
30172
31064
  },
30173
- [ScopeName.ViewScopes]: {
30174
- dependencies: [ScopeName.ViewEmployees],
31065
+ ["viewScopes"]: {
31066
+ dependencies: ["viewEmployees"],
30175
31067
  description: "View the potential access control scopes that can be assigned to members in the organization.",
30176
31068
  title: "View Scopes",
30177
- type: ScopeType.View,
30178
- products: [TranscendProduct.Administration]
31069
+ type: "VIEW",
31070
+ products: ["ADMINISTRATION"]
30179
31071
  },
30180
- [ScopeName.ViewAllActionItems]: {
31072
+ ["viewAllActionItems"]: {
30181
31073
  dependencies: [],
30182
31074
  description: "View all action items in the organization, regardless of assignee or scopes for specific resources. This is necessary when querying API keys via the API.",
30183
31075
  title: "View All Action Items",
30184
- type: ScopeType.View,
30185
- products: [TranscendProduct.Administration]
31076
+ type: "VIEW",
31077
+ products: ["ADMINISTRATION"]
30186
31078
  },
30187
- [ScopeName.ManageAllActionItems]: {
30188
- dependencies: [ScopeName.ViewAllActionItems, ScopeName.ViewGlobalAttributes],
31079
+ ["manageAllActionItems"]: {
31080
+ dependencies: ["viewAllActionItems", "viewGlobalAttributes"],
30189
31081
  description: "Manage all action items in the organization, regardless of assignee or scopes for specific resources. This is necessary when querying API keys via the API.",
30190
31082
  title: "Manage All Action Items",
30191
- type: ScopeType.Modify,
30192
- products: [TranscendProduct.Administration]
31083
+ type: "MODIFY",
31084
+ products: ["ADMINISTRATION"]
30193
31085
  },
30194
- [ScopeName.ViewEmployees]: {
31086
+ ["viewEmployees"]: {
30195
31087
  dependencies: [],
30196
31088
  description: "View the list of employees within your organization.",
30197
31089
  title: "View Employees",
30198
- type: ScopeType.View,
30199
- products: [TranscendProduct.Administration]
31090
+ type: "VIEW",
31091
+ products: ["ADMINISTRATION"]
30200
31092
  },
30201
- [ScopeName.ViewEmailDomains]: {
31093
+ ["viewEmailDomains"]: {
30202
31094
  dependencies: [],
30203
31095
  description: "View the domains from which Transcend can send emails on behalf of your organization.",
30204
31096
  title: "View Email Domains",
30205
- type: ScopeType.View,
31097
+ type: "VIEW",
30206
31098
  products: [
30207
- TranscendProduct.Administration,
30208
- TranscendProduct.DsrAutomation,
30209
- TranscendProduct.PrivacyCenter,
30210
- TranscendProduct.Assessments
31099
+ "ADMINISTRATION",
31100
+ "DSR_AUTOMATION",
31101
+ "PRIVACY_CENTER",
31102
+ "ASSESSMENTS"
30211
31103
  ]
30212
31104
  },
30213
- [ScopeName.ViewGlobalAttributes]: {
31105
+ ["viewGlobalAttributes"]: {
30214
31106
  dependencies: [],
30215
31107
  description: "View the attribute definition key/value pairs.",
30216
31108
  title: "View Global Attributes",
30217
- type: ScopeType.View,
31109
+ type: "VIEW",
30218
31110
  products: [
30219
- TranscendProduct.DsrAutomation,
30220
- TranscendProduct.DataInventory,
30221
- TranscendProduct.ConsentManagement,
30222
- TranscendProduct.StructuredDiscovery,
30223
- TranscendProduct.Administration,
30224
- TranscendProduct.Assessments,
30225
- TranscendProduct.Pathfinder,
30226
- TranscendProduct.PromptManagement,
30227
- TranscendProduct.WebAuditor,
30228
- TranscendProduct.ContractScanning
31111
+ "DSR_AUTOMATION",
31112
+ "DATA_INVENTORY",
31113
+ "CONSENT_MANAGEMENT",
31114
+ "STRUCTURED_DISCOVERY",
31115
+ "ADMINISTRATION",
31116
+ "ASSESSMENTS",
31117
+ "PATHFINDER",
31118
+ "PROMPT_MANAGER",
31119
+ "WEB_AUDITOR",
31120
+ "CONTRACT_SCANNING"
30229
31121
  ]
30230
31122
  },
30231
- [ScopeName.ViewLegalHold]: {
31123
+ ["viewLegalHold"]: {
30232
31124
  dependencies: [],
30233
31125
  description: "View the individuals that have been placed on legal holds.",
30234
31126
  title: "View Legal Hold",
30235
- type: ScopeType.View,
30236
- products: [TranscendProduct.DsrAutomation]
31127
+ type: "VIEW",
31128
+ products: ["DSR_AUTOMATION"]
30237
31129
  },
30238
- [ScopeName.ManageLegalHold]: {
30239
- dependencies: [ScopeName.ViewLegalHold],
31130
+ ["manageLegalHold"]: {
31131
+ dependencies: ["viewLegalHold"],
30240
31132
  description: "Manage and edit the individuals that have been placed on legal holds.",
30241
31133
  title: "Manage Legal Holds",
30242
- type: ScopeType.Modify,
30243
- products: [TranscendProduct.DsrAutomation]
31134
+ type: "MODIFY",
31135
+ products: ["DSR_AUTOMATION"]
30244
31136
  },
30245
- [ScopeName.ManageRequestSecurity]: {
31137
+ ["manageRequestSecurity"]: {
30246
31138
  dependencies: [],
30247
31139
  description: "ReSign expired request encryption contexts, and data silo contexts.",
30248
31140
  title: "Manage Request Security",
30249
- type: ScopeType.Modify,
30250
- products: [TranscendProduct.Administration, TranscendProduct.DsrAutomation]
31141
+ type: "MODIFY",
31142
+ products: ["ADMINISTRATION", "DSR_AUTOMATION"]
30251
31143
  },
30252
- [ScopeName.ManageRequestCompilation]: {
30253
- dependencies: [ScopeName.ViewRequests, ScopeName.ViewRequestCompilation],
31144
+ ["manageRequestCompilation"]: {
31145
+ dependencies: ["viewRequests", "viewRequestCompilation"],
30254
31146
  description: "Make changes to the compilation process of a request. This involves changing the status of data silos in your Data Map, as well as editing profiles and files.",
30255
31147
  title: "Manage Request Compilation",
30256
- type: ScopeType.Modify,
30257
- products: [TranscendProduct.DsrAutomation]
31148
+ type: "MODIFY",
31149
+ products: ["DSR_AUTOMATION"]
30258
31150
  },
30259
- [ScopeName.ManageAssignedRequests]: {
30260
- dependencies: [ScopeName.ViewAssignedRequests],
31151
+ ["managedAssignedRequests"]: {
31152
+ dependencies: ["viewAssignedRequests"],
30261
31153
  description: "Make changes to the compilation process of a request for requests assigned to your or your team. This involves changing the status of data silos in your Data Map, as well as editing profiles and files.",
30262
31154
  title: "Manage Assigned Privacy Requests",
30263
- type: ScopeType.Modify,
30264
- products: [TranscendProduct.DsrAutomation]
31155
+ type: "MODIFY",
31156
+ products: ["DSR_AUTOMATION"]
30265
31157
  },
30266
- [ScopeName.ManageAssignedBulkRespond]: {
31158
+ ["manageAssignedBulkRespond"]: {
30267
31159
  dependencies: [],
30268
31160
  description: "Bulk respond to privacy requests assigned to you or your team.",
30269
31161
  title: "Manage Assigned Bulk Respond",
30270
- type: ScopeType.Modify,
30271
- products: [TranscendProduct.DsrAutomation]
31162
+ type: "MODIFY",
31163
+ products: ["DSR_AUTOMATION"]
30272
31164
  },
30273
- [ScopeName.MakeDataSubjectRequest]: {
30274
- dependencies: [ScopeName.ViewDataSubjectRequestSettings, ScopeName.ViewRequestIdentitySettings],
31165
+ ["makeDataSubjectRequest"]: {
31166
+ dependencies: ["viewDataSubjectRequestSettings", "viewRequestIdentitySettings"],
30275
31167
  description: "Submit a new privacy requests.",
30276
31168
  title: "Submit New Data Subject Request",
30277
- type: ScopeType.Modify,
30278
- products: [TranscendProduct.DsrAutomation]
31169
+ type: "MODIFY",
31170
+ products: ["DSR_AUTOMATION"]
30279
31171
  },
30280
- [ScopeName.ManageDataSubjectRequestSettings]: {
30281
- dependencies: [ScopeName.ViewDataSubjectRequestSettings],
31172
+ ["manageDataSubjectRequestSettings"]: {
31173
+ dependencies: ["viewDataSubjectRequestSettings"],
30282
31174
  description: "Make changes to the request actions that your organization allows, as well as what data subjects you will serve.",
30283
31175
  title: "Manage Data Subject Request Settings",
30284
- type: ScopeType.Modify,
30285
- products: [TranscendProduct.DsrAutomation]
31176
+ type: "MODIFY",
31177
+ products: ["DSR_AUTOMATION"]
30286
31178
  },
30287
- [ScopeName.ManageEmailTemplates]: {
30288
- dependencies: [ScopeName.ViewEmailTemplates],
31179
+ ["manageEmailTemplates"]: {
31180
+ dependencies: ["viewEmailTemplates"],
30289
31181
  description: "Manage the email communication templates that your organization uses to communicate with your data subjects.",
30290
31182
  title: "Manage Email Templates",
30291
- type: ScopeType.Modify,
31183
+ type: "MODIFY",
30292
31184
  products: [
30293
- TranscendProduct.DsrAutomation,
30294
- TranscendProduct.PrivacyCenter,
30295
- TranscendProduct.Assessments
31185
+ "DSR_AUTOMATION",
31186
+ "PRIVACY_CENTER",
31187
+ "ASSESSMENTS"
30296
31188
  ]
30297
31189
  },
30298
- [ScopeName.ManageRequestIdentities]: {
30299
- dependencies: [ScopeName.ViewRequestIdentitySettings],
31190
+ ["manageRequestIdentities"]: {
31191
+ dependencies: ["viewRequestIdentitySettings"],
30300
31192
  description: "Manage how your organization will verify the identities of new privacy requests, and how that identity will be enriched for all of your data silos to lookup that person.",
30301
31193
  title: "Manage Request Identity Verification",
30302
- type: ScopeType.Modify,
30303
- products: [TranscendProduct.DsrAutomation]
31194
+ type: "MODIFY",
31195
+ products: ["DSR_AUTOMATION"]
30304
31196
  },
30305
- [ScopeName.DeployPrivacyCenter]: {
30306
- dependencies: [ScopeName.ManagePrivacyCenter],
31197
+ ["deployPrivacyCenter"]: {
31198
+ dependencies: ["managePrivacyCenter"],
30307
31199
  description: "Launch the Privacy Center on your own domain, and publish new changes.",
30308
31200
  title: "Publish Privacy Center",
30309
- type: ScopeType.Modify,
30310
- products: [TranscendProduct.PrivacyCenter]
31201
+ type: "MODIFY",
31202
+ products: ["PRIVACY_CENTER"]
30311
31203
  },
30312
- [ScopeName.ManageDataMap]: {
30313
- dependencies: [ScopeName.ViewDataMap],
31204
+ ["manageDataMap"]: {
31205
+ dependencies: ["viewDataMap"],
30314
31206
  description: "Edit the configurations on your data silos and determine what information should be included in a request.",
30315
31207
  title: "Manage Data Map",
30316
- type: ScopeType.Modify,
31208
+ type: "MODIFY",
30317
31209
  products: [
30318
- TranscendProduct.DsrAutomation,
30319
- TranscendProduct.DataInventory,
30320
- TranscendProduct.StructuredDiscovery,
30321
- TranscendProduct.SiloDiscovery,
30322
- TranscendProduct.UnstructuredDiscovery
31210
+ "DSR_AUTOMATION",
31211
+ "DATA_INVENTORY",
31212
+ "STRUCTURED_DISCOVERY",
31213
+ "SILO_DISCOVERY",
31214
+ "UNSTRUCTURED_DISCOVERY"
30323
31215
  ]
30324
31216
  },
30325
- [ScopeName.ManagePrivacyCenter]: {
30326
- dependencies: [ScopeName.ViewPrivacyCenter, ScopeName.ManagePolicies],
31217
+ ["managePrivacyCenter"]: {
31218
+ dependencies: ["viewPrivacyCenter", "managePolicies"],
30327
31219
  description: "Make changes to the privacy center configuration and policies.",
30328
31220
  title: "Manage Privacy Center Layout",
30329
- type: ScopeType.Modify,
30330
- products: [TranscendProduct.PrivacyCenter]
31221
+ type: "MODIFY",
31222
+ products: ["PRIVACY_CENTER"]
30331
31223
  },
30332
- [ScopeName.ManagePolicies]: {
30333
- dependencies: [ScopeName.ViewPolicies],
31224
+ ["managePolicies"]: {
31225
+ dependencies: ["viewPolicies"],
30334
31226
  description: "Make changes to the policies defined underneath the privacy center.",
30335
31227
  title: "Manage Privacy Center Policies",
30336
- type: ScopeType.Modify,
30337
- products: [TranscendProduct.PrivacyCenter]
31228
+ type: "MODIFY",
31229
+ products: ["PRIVACY_CENTER"]
30338
31230
  },
30339
- [ScopeName.ViewPolicies]: {
31231
+ ["viewPolicies"]: {
30340
31232
  dependencies: [],
30341
31233
  description: "View the policies defined underneath the privacy center.",
30342
31234
  title: "View Privacy Center Policies",
30343
- type: ScopeType.View,
30344
- products: [TranscendProduct.PrivacyCenter]
31235
+ type: "VIEW",
31236
+ products: ["PRIVACY_CENTER"]
30345
31237
  },
30346
- [ScopeName.ViewPolicyEngineBundles]: {
31238
+ ["viewPolicyEngineBundles"]: {
30347
31239
  dependencies: [],
30348
31240
  description: "View Policy Engine policy bundles and their versions.",
30349
31241
  title: "View Policy",
30350
- type: ScopeType.View,
30351
- products: [TranscendProduct.PolicyEngine]
31242
+ type: "VIEW",
31243
+ products: ["POLICY_ENGINE"]
30352
31244
  },
30353
- [ScopeName.ManagePolicyEngineBundles]: {
30354
- dependencies: [ScopeName.ViewPolicyEngineBundles],
31245
+ ["managePolicyEngineBundles"]: {
31246
+ dependencies: ["viewPolicyEngineBundles"],
30355
31247
  description: "Create and upload Policy Engine policy bundles and versions. Uploaded versions are inert until activated.",
30356
31248
  title: "Manage Policy",
30357
- type: ScopeType.Modify,
30358
- products: [TranscendProduct.PolicyEngine]
31249
+ type: "MODIFY",
31250
+ products: ["POLICY_ENGINE"]
30359
31251
  },
30360
- [ScopeName.ActivatePolicyEngineBundles]: {
30361
- dependencies: [ScopeName.ViewPolicyEngineBundles],
31252
+ ["activatePolicyEngineBundles"]: {
31253
+ dependencies: ["viewPolicyEngineBundles"],
30362
31254
  description: "Activate a Policy Engine bundle version, making it the live policy. Kept separate from Manage Policy so publish-only access can be granted without activation rights.",
30363
31255
  title: "Activate Policy",
30364
- type: ScopeType.Modify,
30365
- products: [TranscendProduct.PolicyEngine]
31256
+ type: "MODIFY",
31257
+ products: ["POLICY_ENGINE"]
30366
31258
  },
30367
- [ScopeName.ManageIntlMessages]: {
30368
- dependencies: [ScopeName.ViewIntlMessages],
31259
+ ["manageIntlMessages"]: {
31260
+ dependencies: ["viewIntlMessages"],
30369
31261
  description: "Manage the internationalization messages used in the privacy center.",
30370
31262
  title: "Manage Internationalization Messages",
30371
- type: ScopeType.Modify,
30372
- products: [TranscendProduct.PrivacyCenter, TranscendProduct.ConsentManagement]
31263
+ type: "MODIFY",
31264
+ products: ["PRIVACY_CENTER", "CONSENT_MANAGEMENT"]
30373
31265
  },
30374
- [ScopeName.ViewIntlMessages]: {
31266
+ ["viewIntlMessages"]: {
30375
31267
  dependencies: [],
30376
31268
  description: "View the internationalization messages used in the privacy center.",
30377
31269
  title: "View Internationalization Messages",
30378
- type: ScopeType.View,
30379
- products: [TranscendProduct.PrivacyCenter, TranscendProduct.ConsentManagement]
31270
+ type: "VIEW",
31271
+ products: ["PRIVACY_CENTER", "CONSENT_MANAGEMENT"]
30380
31272
  },
30381
- [ScopeName.RequestApproval]: {
31273
+ ["requestApproval"]: {
30382
31274
  dependencies: [
30383
- ScopeName.ViewRequests,
30384
- ScopeName.ViewRequestCompilation,
30385
- ScopeName.ManageRequestCompilation
31275
+ "viewRequests",
31276
+ "viewRequestCompilation",
31277
+ "manageRequestCompilation"
30386
31278
  ],
30387
31279
  description: "The ability to approve and manage the state of privacy requests, and communicate with the data subject.",
30388
31280
  title: "Request Approval and Communication",
30389
- type: ScopeType.Modify,
30390
- products: [TranscendProduct.DsrAutomation]
31281
+ type: "MODIFY",
31282
+ products: ["DSR_AUTOMATION"]
30391
31283
  },
30392
- [ScopeName.ViewDataSubjectRequestSettings]: {
31284
+ ["viewDataSubjectRequestSettings"]: {
30393
31285
  dependencies: [],
30394
31286
  description: "View the privacy request actions settings and data subject categories that your organization supports.",
30395
31287
  title: "View Data Subject Request Settings",
30396
- type: ScopeType.View,
30397
- products: [TranscendProduct.DsrAutomation]
31288
+ type: "VIEW",
31289
+ products: ["DSR_AUTOMATION"]
30398
31290
  },
30399
- [ScopeName.ViewRequestCompilation]: {
30400
- dependencies: [ScopeName.ViewRequests],
31291
+ ["viewRequestCompilation"]: {
31292
+ dependencies: ["viewRequests"],
30401
31293
  description: "View the status of requests as they compile across your Data Map.",
30402
31294
  title: "View the Request Compilation",
30403
- type: ScopeType.View,
30404
- products: [TranscendProduct.DsrAutomation]
31295
+ type: "VIEW",
31296
+ products: ["DSR_AUTOMATION"]
30405
31297
  },
30406
- [ScopeName.ViewRequestIdentitySettings]: {
31298
+ ["viewRequestIdentitySettings"]: {
30407
31299
  dependencies: [],
30408
31300
  description: "View the settings for data subject request identity verification.",
30409
31301
  title: "View Identity Verification Settings",
30410
- type: ScopeType.View,
30411
- products: [TranscendProduct.DsrAutomation]
31302
+ type: "VIEW",
31303
+ products: ["DSR_AUTOMATION"]
30412
31304
  },
30413
- [ScopeName.ViewRequests]: {
31305
+ ["viewRequests"]: {
30414
31306
  dependencies: [
30415
- ScopeName.ViewGlobalAttributes,
30416
- ScopeName.ViewDataSubjectRequestSettings,
30417
- ScopeName.ViewEmailTemplates
31307
+ "viewGlobalAttributes",
31308
+ "viewDataSubjectRequestSettings",
31309
+ "viewEmailTemplates"
30418
31310
  ],
30419
31311
  description: "View the stream of incoming requests, and any details submit through the form or later enriched.",
30420
31312
  title: "View Incoming Requests",
30421
- type: ScopeType.View,
30422
- products: [TranscendProduct.DsrAutomation]
31313
+ type: "VIEW",
31314
+ products: ["DSR_AUTOMATION"]
30423
31315
  },
30424
- [ScopeName.ViewAssignedRequests]: {
31316
+ ["viewAssignedRequests"]: {
30425
31317
  dependencies: [
30426
- ScopeName.ViewGlobalAttributes,
30427
- ScopeName.ViewDataSubjectRequestSettings,
30428
- ScopeName.ViewEmailTemplates
31318
+ "viewGlobalAttributes",
31319
+ "viewDataSubjectRequestSettings",
31320
+ "viewEmailTemplates"
30429
31321
  ],
30430
31322
  description: "View the stream of incoming requests assigned to you and your team. You will be able to see any request details submitted through the form or later enriched.",
30431
31323
  title: "View Assigned Privacy Requests",
30432
- type: ScopeType.View,
30433
- products: [TranscendProduct.DsrAutomation]
31324
+ type: "VIEW",
31325
+ products: ["DSR_AUTOMATION"]
30434
31326
  },
30435
- [ScopeName.ViewPrivacyCenter]: {
31327
+ ["viewPrivacyCenter"]: {
30436
31328
  dependencies: [],
30437
31329
  description: "View the full configuration of the privacy center.",
30438
31330
  title: "View Privacy Center Layout",
30439
- type: ScopeType.View,
30440
- products: [TranscendProduct.PrivacyCenter]
31331
+ type: "VIEW",
31332
+ products: ["PRIVACY_CENTER"]
30441
31333
  },
30442
- [ScopeName.ViewEmailTemplates]: {
31334
+ ["viewEmailTemplates"]: {
30443
31335
  dependencies: [],
30444
31336
  description: "View the default email templates templates used to communicate with your data subjects.",
30445
31337
  title: "View Email Templates",
30446
- type: ScopeType.View,
31338
+ type: "VIEW",
30447
31339
  products: [
30448
- TranscendProduct.DsrAutomation,
30449
- TranscendProduct.PrivacyCenter,
30450
- TranscendProduct.Assessments
31340
+ "DSR_AUTOMATION",
31341
+ "PRIVACY_CENTER",
31342
+ "ASSESSMENTS"
30451
31343
  ]
30452
31344
  },
30453
- [ScopeName.ConnectDataSilos]: {
31345
+ ["connectDataSilos"]: {
30454
31346
  dependencies: [
30455
- ScopeName.ViewDataMap,
30456
- ScopeName.ManageDataMap,
30457
- ScopeName.ViewEmailTemplates
31347
+ "viewDataMap",
31348
+ "manageDataMap",
31349
+ "viewEmailTemplates"
30458
31350
  ],
30459
31351
  description: "Connect new data silos to your Data Map.",
30460
31352
  title: "Connect Data Silos",
30461
31353
  products: [
30462
- TranscendProduct.DsrAutomation,
30463
- TranscendProduct.SiloDiscovery,
30464
- TranscendProduct.StructuredDiscovery,
30465
- TranscendProduct.UnstructuredDiscovery
31354
+ "DSR_AUTOMATION",
31355
+ "SILO_DISCOVERY",
31356
+ "STRUCTURED_DISCOVERY",
31357
+ "UNSTRUCTURED_DISCOVERY"
30466
31358
  ],
30467
- type: ScopeType.Modify
31359
+ type: "MODIFY"
30468
31360
  },
30469
- [ScopeName.ManageDataInventory]: {
30470
- dependencies: [ScopeName.ViewDataInventory],
31361
+ ["manageDataInventory"]: {
31362
+ dependencies: ["viewDataInventory"],
30471
31363
  description: "Ability to manage and edit everything in the data mapping product. Includes the data inventory, ROPE, and content classification views.",
30472
31364
  title: "Manage Data Inventory",
30473
- type: ScopeType.Modify,
31365
+ type: "MODIFY",
30474
31366
  products: [
30475
- TranscendProduct.DataInventory,
30476
- TranscendProduct.StructuredDiscovery,
30477
- TranscendProduct.SiloDiscovery,
30478
- TranscendProduct.UnstructuredDiscovery
31367
+ "DATA_INVENTORY",
31368
+ "STRUCTURED_DISCOVERY",
31369
+ "SILO_DISCOVERY",
31370
+ "UNSTRUCTURED_DISCOVERY"
30479
31371
  ]
30480
31372
  },
30481
- [ScopeName.ManageAssignedDataInventory]: {
30482
- dependencies: [ScopeName.ViewAssignedDataInventory],
31373
+ ["managedAssignedDataInventory"]: {
31374
+ dependencies: ["viewAssignedDataInventory"],
30483
31375
  description: "Manage the data inventory rows in your organization's Data Map that are assigned to you or your team.",
30484
31376
  title: "Manage Assigned Data Inventory",
30485
- type: ScopeType.Modify,
31377
+ type: "MODIFY",
30486
31378
  products: [
30487
- TranscendProduct.DataInventory,
30488
- TranscendProduct.StructuredDiscovery,
30489
- TranscendProduct.SiloDiscovery,
30490
- TranscendProduct.UnstructuredDiscovery
31379
+ "DATA_INVENTORY",
31380
+ "STRUCTURED_DISCOVERY",
31381
+ "SILO_DISCOVERY",
31382
+ "UNSTRUCTURED_DISCOVERY"
30491
31383
  ]
30492
31384
  },
30493
- [ScopeName.ManageAssignedIntegrations]: {
30494
- dependencies: [ScopeName.ViewAssignedIntegrations],
31385
+ ["managedAssignedIntegrations"]: {
31386
+ dependencies: ["viewAssignedIntegrations"],
30495
31387
  description: "Manage the integrations in your organization's Data Map that are assigned to you or your team.",
30496
31388
  title: "Manage Assigned Integrations",
30497
- type: ScopeType.Modify,
31389
+ type: "MODIFY",
30498
31390
  products: [
30499
- TranscendProduct.DsrAutomation,
30500
- TranscendProduct.DataInventory,
30501
- TranscendProduct.StructuredDiscovery,
30502
- TranscendProduct.SiloDiscovery,
30503
- TranscendProduct.UnstructuredDiscovery
31391
+ "DSR_AUTOMATION",
31392
+ "DATA_INVENTORY",
31393
+ "STRUCTURED_DISCOVERY",
31394
+ "SILO_DISCOVERY",
31395
+ "UNSTRUCTURED_DISCOVERY"
30504
31396
  ]
30505
31397
  },
30506
- [ScopeName.ViewDataMap]: {
30507
- dependencies: [ScopeName.ViewGlobalAttributes],
31398
+ ["viewDataMap"]: {
31399
+ dependencies: ["viewGlobalAttributes"],
30508
31400
  description: "View your organization's Data Map and see the configuration settings for each action your support.",
30509
31401
  title: "View Data Map",
30510
- type: ScopeType.View,
31402
+ type: "VIEW",
30511
31403
  products: [
30512
- TranscendProduct.DsrAutomation,
30513
- TranscendProduct.DataInventory,
30514
- TranscendProduct.StructuredDiscovery,
30515
- TranscendProduct.SiloDiscovery,
30516
- TranscendProduct.UnstructuredDiscovery
31404
+ "DSR_AUTOMATION",
31405
+ "DATA_INVENTORY",
31406
+ "STRUCTURED_DISCOVERY",
31407
+ "SILO_DISCOVERY",
31408
+ "UNSTRUCTURED_DISCOVERY"
30517
31409
  ]
30518
31410
  },
30519
- [ScopeName.ViewAssignedIntegrations]: {
30520
- dependencies: [ScopeName.ViewGlobalAttributes],
31411
+ ["viewAssignedIntegrations"]: {
31412
+ dependencies: ["viewGlobalAttributes"],
30521
31413
  description: "View the integrations in your organization's Data Map that are assigned to you or your team.",
30522
31414
  title: "View Assigned Integrations",
30523
- type: ScopeType.View,
31415
+ type: "VIEW",
30524
31416
  products: [
30525
- TranscendProduct.DsrAutomation,
30526
- TranscendProduct.DataInventory,
30527
- TranscendProduct.StructuredDiscovery,
30528
- TranscendProduct.SiloDiscovery,
30529
- TranscendProduct.UnstructuredDiscovery
31417
+ "DSR_AUTOMATION",
31418
+ "DATA_INVENTORY",
31419
+ "STRUCTURED_DISCOVERY",
31420
+ "SILO_DISCOVERY",
31421
+ "UNSTRUCTURED_DISCOVERY"
30530
31422
  ]
30531
31423
  },
30532
- [ScopeName.ViewAssignedDataInventory]: {
30533
- dependencies: [ScopeName.ViewGlobalAttributes, ScopeName.ViewDataSubjectRequestSettings],
31424
+ ["viewAssignedDataInventory"]: {
31425
+ dependencies: ["viewGlobalAttributes", "viewDataSubjectRequestSettings"],
30534
31426
  description: "Ability to view the resources in the data mapping product that are assigned to your or your team.",
30535
31427
  title: "View Assigned Data Inventory",
30536
- type: ScopeType.View,
31428
+ type: "VIEW",
30537
31429
  products: [
30538
- TranscendProduct.DataInventory,
30539
- TranscendProduct.StructuredDiscovery,
30540
- TranscendProduct.SiloDiscovery,
30541
- TranscendProduct.UnstructuredDiscovery
31430
+ "DATA_INVENTORY",
31431
+ "STRUCTURED_DISCOVERY",
31432
+ "SILO_DISCOVERY",
31433
+ "UNSTRUCTURED_DISCOVERY"
30542
31434
  ]
30543
31435
  },
30544
- [ScopeName.ViewDataInventory]: {
31436
+ ["viewDataInventory"]: {
30545
31437
  dependencies: [
30546
- ScopeName.ViewDataMap,
30547
- ScopeName.ViewGlobalAttributes,
30548
- ScopeName.ViewDataSubjectRequestSettings
31438
+ "viewDataMap",
31439
+ "viewGlobalAttributes",
31440
+ "viewDataSubjectRequestSettings"
30549
31441
  ],
30550
31442
  description: "Ability to view all of the data mapping product. Includes the data inventory, ROPA, and content classification views.",
30551
31443
  title: "View Data Inventory",
30552
- type: ScopeType.View,
31444
+ type: "VIEW",
30553
31445
  products: [
30554
- TranscendProduct.DataInventory,
30555
- TranscendProduct.StructuredDiscovery,
30556
- TranscendProduct.SiloDiscovery,
30557
- TranscendProduct.UnstructuredDiscovery
31446
+ "DATA_INVENTORY",
31447
+ "STRUCTURED_DISCOVERY",
31448
+ "SILO_DISCOVERY",
31449
+ "UNSTRUCTURED_DISCOVERY"
30558
31450
  ]
30559
31451
  },
30560
- [ScopeName.ManageConsentManager]: {
31452
+ ["manageConsentManager"]: {
30561
31453
  dependencies: [
30562
- ScopeName.ViewConsentManager,
30563
- ScopeName.ManageDataFlow,
30564
- ScopeName.ManageConsentManagerDisplaySettings,
30565
- ScopeName.ManageConsentManagerDeveloperSettings,
30566
- ScopeName.DeployConsentManager,
30567
- ScopeName.DeployTestConsentManager,
30568
- ScopeName.ViewDataFlow
31454
+ "viewConsentManager",
31455
+ "manageDataFlow",
31456
+ "manageConsentManagerDisplaySettings",
31457
+ "manageConsentManagerDeveloperSettings",
31458
+ "deployConsentManager",
31459
+ "deployTestConsentManager",
31460
+ "viewDataFlow"
30569
31461
  ],
30570
31462
  description: "Manage & deploy the consent manager changes to your websites.",
30571
31463
  title: "Manage Consent Manager",
30572
- type: ScopeType.Modify,
30573
- products: [TranscendProduct.ConsentManagement]
31464
+ type: "MODIFY",
31465
+ products: ["CONSENT_MANAGEMENT"]
30574
31466
  },
30575
- [ScopeName.ManageConsentManagerDeveloperSettings]: {
30576
- dependencies: [ScopeName.ViewConsentManager],
31467
+ ["manageConsentManagerDeveloperSettings"]: {
31468
+ dependencies: ["viewConsentManager"],
30577
31469
  description: "Manage the developer settings for the Consent Manager. This does not allow for clicking the \"Set Changes Live\" button.",
30578
31470
  title: "Manage Consent Manager Developer Settings",
30579
- type: ScopeType.Modify,
30580
- products: [TranscendProduct.ConsentManagement]
31471
+ type: "MODIFY",
31472
+ products: ["CONSENT_MANAGEMENT"]
30581
31473
  },
30582
- [ScopeName.ManageConsentManagerDisplaySettings]: {
30583
- dependencies: [ScopeName.ViewConsentManager],
31474
+ ["manageConsentManagerDisplaySettings"]: {
31475
+ dependencies: ["viewConsentManager"],
30584
31476
  description: "Manage the display settings for the consent manager. This includes messages, styles and other UI settings.",
30585
31477
  title: "Manage Consent Manager Display Settings",
30586
- type: ScopeType.Modify,
30587
- products: [TranscendProduct.ConsentManagement]
31478
+ type: "MODIFY",
31479
+ products: ["CONSENT_MANAGEMENT"]
30588
31480
  },
30589
- [ScopeName.DeployTestConsentManager]: {
30590
- dependencies: [ScopeName.ViewConsentManager],
31481
+ ["deployTestConsentManager"]: {
31482
+ dependencies: ["viewConsentManager"],
30591
31483
  description: "Ability to publish changes to the test Consent Manager bundle. This changes the code contents of airgap.js and attempts to invalidate the CDN.",
30592
31484
  title: "Deploy Test Consent Manager",
30593
- type: ScopeType.Modify,
30594
- products: [TranscendProduct.ConsentManagement]
31485
+ type: "MODIFY",
31486
+ products: ["CONSENT_MANAGEMENT"]
30595
31487
  },
30596
- [ScopeName.DeployConsentManager]: {
30597
- dependencies: [ScopeName.ViewConsentManager, ScopeName.DeployTestConsentManager],
31488
+ ["deployConsentManager"]: {
31489
+ dependencies: ["viewConsentManager", "deployTestConsentManager"],
30598
31490
  description: "Ability to publish changes to the production and test Consent Manager bundle. This changes the code contents of airgap.js and attempts to invalidate the CDN.",
30599
31491
  title: "Deploy Consent Manager",
30600
- type: ScopeType.Modify,
30601
- products: [TranscendProduct.ConsentManagement]
31492
+ type: "MODIFY",
31493
+ products: ["CONSENT_MANAGEMENT"]
30602
31494
  },
30603
- [ScopeName.ManageAssignedConsentManager]: {
30604
- dependencies: [ScopeName.ViewAssignedConsentManager],
31495
+ ["managedAssignedConsentManager"]: {
31496
+ dependencies: ["viewAssignedConsentManager"],
30605
31497
  description: "Manage Data Flows & Cookies assigned to you or your team.",
30606
31498
  title: "Manage Assigned Consent Manager",
30607
- type: ScopeType.Modify,
30608
- products: [TranscendProduct.ConsentManagement]
31499
+ type: "MODIFY",
31500
+ products: ["CONSENT_MANAGEMENT"]
30609
31501
  },
30610
- [ScopeName.ManageDataFlow]: {
30611
- dependencies: [ScopeName.ViewDataFlow],
31502
+ ["manageDataFlow"]: {
31503
+ dependencies: ["viewDataFlow"],
30612
31504
  description: "Ability to manage and delete Data Flows and Cookies within the Consent Manager product.",
30613
31505
  title: "Manage Data Flows",
30614
- type: ScopeType.Modify,
30615
- products: [TranscendProduct.ConsentManagement]
31506
+ type: "MODIFY",
31507
+ products: ["CONSENT_MANAGEMENT"]
30616
31508
  },
30617
- [ScopeName.ViewDataFlow]: {
30618
- dependencies: [ScopeName.ViewConsentManager],
31509
+ ["viewDataFlow"]: {
31510
+ dependencies: ["viewConsentManager"],
30619
31511
  description: "View Data Flows (tracking purpose maps, site scans)",
30620
31512
  title: "View Data Flows",
30621
- type: ScopeType.View,
30622
- products: [TranscendProduct.ConsentManagement]
31513
+ type: "VIEW",
31514
+ products: ["CONSENT_MANAGEMENT"]
30623
31515
  },
30624
- [ScopeName.ViewAssignedConsentManager]: {
30625
- dependencies: [ScopeName.ViewGlobalAttributes],
31516
+ ["viewAssignedConsentManager"]: {
31517
+ dependencies: ["viewGlobalAttributes"],
30626
31518
  description: "View Data Flows and Cookies assigned to you or your team.",
30627
31519
  title: "View Assigned Consent Manager",
30628
- type: ScopeType.View,
30629
- products: [TranscendProduct.ConsentManagement]
31520
+ type: "VIEW",
31521
+ products: ["CONSENT_MANAGEMENT"]
30630
31522
  },
30631
- [ScopeName.ViewConsentManager]: {
31523
+ ["viewConsentManager"]: {
30632
31524
  title: "View Consent Manager",
30633
- type: ScopeType.View,
30634
- dependencies: [ScopeName.ViewGlobalAttributes, ScopeName.ViewManagedConsentDatabaseAdminApi],
31525
+ type: "VIEW",
31526
+ dependencies: ["viewGlobalAttributes", "viewManagedConsentDatabaseAdminApi"],
30635
31527
  description: "View the consent manager configuration.",
30636
- products: [TranscendProduct.ConsentManagement]
31528
+ products: ["CONSENT_MANAGEMENT"]
30637
31529
  },
30638
- [ScopeName.ViewAssessments]: {
31530
+ ["viewAssessments"]: {
30639
31531
  title: "View Assessments",
30640
31532
  dependencies: [],
30641
31533
  description: "View the assessments and assessment templates.",
30642
- type: ScopeType.View,
30643
- products: [TranscendProduct.Assessments, TranscendProduct.DataInventory]
31534
+ type: "VIEW",
31535
+ products: ["ASSESSMENTS", "DATA_INVENTORY"]
30644
31536
  },
30645
- [ScopeName.ManageAssessments]: {
31537
+ ["manageAssessments"]: {
30646
31538
  title: "Manage Assessments",
30647
- dependencies: [ScopeName.ViewAssessments],
31539
+ dependencies: ["viewAssessments"],
30648
31540
  description: "Manage and edit assessments and assessment templates",
30649
- type: ScopeType.Modify,
30650
- products: [TranscendProduct.Assessments, TranscendProduct.DataInventory]
31541
+ type: "MODIFY",
31542
+ products: ["ASSESSMENTS", "DATA_INVENTORY"]
30651
31543
  },
30652
- [ScopeName.ViewAssignedAssessments]: {
31544
+ ["viewAssignedAssessments"]: {
30653
31545
  title: "View Assigned Assessments",
30654
31546
  dependencies: [],
30655
31547
  description: "View the assigned assessments forms.",
30656
- type: ScopeType.View,
30657
- products: [TranscendProduct.Assessments, TranscendProduct.DataInventory]
31548
+ type: "VIEW",
31549
+ products: ["ASSESSMENTS", "DATA_INVENTORY"]
30658
31550
  },
30659
- [ScopeName.ManageAssignedAssessments]: {
31551
+ ["manageAssignedAssessments"]: {
30660
31552
  title: "Manage Assigned Assessments",
30661
- dependencies: [ScopeName.ViewAssignedAssessments],
31553
+ dependencies: ["viewAssignedAssessments"],
30662
31554
  description: "Manage and edit the assigned assessments.",
30663
- type: ScopeType.Modify,
30664
- products: [TranscendProduct.Assessments, TranscendProduct.DataInventory]
31555
+ type: "MODIFY",
31556
+ products: ["ASSESSMENTS", "DATA_INVENTORY"]
30665
31557
  },
30666
- [ScopeName.ViewPathfinder]: {
31558
+ ["viewPathfinder"]: {
30667
31559
  title: "View Pathfinder",
30668
- dependencies: [ScopeName.ViewGlobalAttributes],
31560
+ dependencies: ["viewGlobalAttributes"],
30669
31561
  description: "View the pathfinder settings.",
30670
- type: ScopeType.View,
30671
- products: [TranscendProduct.Pathfinder]
31562
+ type: "VIEW",
31563
+ products: ["PATHFINDER"]
30672
31564
  },
30673
- [ScopeName.ManagePathfinder]: {
31565
+ ["managePathfinder"]: {
30674
31566
  title: "Manage Pathfinder",
30675
- dependencies: [ScopeName.ViewPathfinder],
31567
+ dependencies: ["viewPathfinder"],
30676
31568
  description: "Manage the pathfinder settings under that pathfinder side menu",
30677
- type: ScopeType.Modify,
30678
- products: [TranscendProduct.Pathfinder]
31569
+ type: "MODIFY",
31570
+ products: ["PATHFINDER"]
30679
31571
  },
30680
- [ScopeName.ViewContractScanning]: {
31572
+ ["viewContractScanning"]: {
30681
31573
  title: "View Contract Scanning",
30682
- dependencies: [ScopeName.ViewGlobalAttributes],
31574
+ dependencies: ["viewGlobalAttributes"],
30683
31575
  description: "View the contract scanning side menu - including setting and contracts.",
30684
- type: ScopeType.View,
30685
- products: [TranscendProduct.ContractScanning]
31576
+ type: "VIEW",
31577
+ products: ["CONTRACT_SCANNING"]
30686
31578
  },
30687
- [ScopeName.ManageContractScanning]: {
31579
+ ["manageContractScanning"]: {
30688
31580
  title: "Manage Contract Scanning",
30689
- dependencies: [ScopeName.ViewContractScanning],
31581
+ dependencies: ["viewContractScanning"],
30690
31582
  description: "Upload and manage contracts under the contract scanning side menu",
30691
- type: ScopeType.Modify,
30692
- products: [TranscendProduct.ContractScanning]
31583
+ type: "MODIFY",
31584
+ products: ["CONTRACT_SCANNING"]
30693
31585
  },
30694
- [ScopeName.ViewPrompts]: {
31586
+ ["viewPrompts"]: {
30695
31587
  title: "View Prompts",
30696
- dependencies: [ScopeName.ViewGlobalAttributes],
31588
+ dependencies: ["viewGlobalAttributes"],
30697
31589
  description: "View the prompts and prompt templates.",
30698
- type: ScopeType.View,
30699
- products: [TranscendProduct.PromptManagement]
31590
+ type: "VIEW",
31591
+ products: ["PROMPT_MANAGER"]
30700
31592
  },
30701
- [ScopeName.ManagePrompts]: {
31593
+ ["managePrompts"]: {
30702
31594
  title: "Manage Prompts",
30703
- dependencies: [ScopeName.ViewPrompts],
31595
+ dependencies: ["viewPrompts"],
30704
31596
  description: "Manage and edit prompts and prompt templates",
30705
- type: ScopeType.Modify,
30706
- products: [TranscendProduct.PromptManagement]
31597
+ type: "MODIFY",
31598
+ products: ["PROMPT_MANAGER"]
30707
31599
  },
30708
- [ScopeName.ViewPromptRuns]: {
31600
+ ["viewPromptRuns"]: {
30709
31601
  title: "View Prompt Runs",
30710
- dependencies: [ScopeName.ViewPrompts],
31602
+ dependencies: ["viewPrompts"],
30711
31603
  description: "View the output run results for prompts.",
30712
- type: ScopeType.View,
30713
- products: [TranscendProduct.PromptManagement]
31604
+ type: "VIEW",
31605
+ products: ["PROMPT_MANAGER"]
30714
31606
  },
30715
- [ScopeName.ManagePromptRuns]: {
31607
+ ["managePromptRuns"]: {
30716
31608
  title: "Manage Prompt Runs",
30717
- dependencies: [ScopeName.ViewPromptRuns, ScopeName.ViewPrompts],
31609
+ dependencies: ["viewPromptRuns", "viewPrompts"],
30718
31610
  description: "Manage, edit and create prompt run results",
30719
- type: ScopeType.Modify,
30720
- products: [TranscendProduct.PromptManagement, TranscendProduct.Pathfinder]
31611
+ type: "MODIFY",
31612
+ products: ["PROMPT_MANAGER", "PATHFINDER"]
30721
31613
  },
30722
- [ScopeName.ViewCodeScanning]: {
31614
+ ["viewCodeScanning"]: {
30723
31615
  title: "View Code Scanning",
30724
- dependencies: [ScopeName.ViewGlobalAttributes],
31616
+ dependencies: ["viewGlobalAttributes"],
30725
31617
  description: "View the code scanning tables.",
30726
- type: ScopeType.View,
30727
- products: [TranscendProduct.DataInventory, TranscendProduct.ConsentManagement]
31618
+ type: "VIEW",
31619
+ products: ["DATA_INVENTORY", "CONSENT_MANAGEMENT"]
30728
31620
  },
30729
- [ScopeName.ManageCodeScanning]: {
31621
+ ["manageCodeScanning"]: {
30730
31622
  title: "Manage Code Scanning",
30731
- dependencies: [ScopeName.ViewCodeScanning],
31623
+ dependencies: ["viewCodeScanning"],
30732
31624
  description: "Manage, edit and create records in code scanning",
30733
- type: ScopeType.Modify,
30734
- products: [TranscendProduct.DataInventory, TranscendProduct.ConsentManagement]
31625
+ type: "MODIFY",
31626
+ products: ["DATA_INVENTORY", "CONSENT_MANAGEMENT"]
30735
31627
  },
30736
- [ScopeName.ExecutePrompt]: {
31628
+ ["executePrompt"]: {
30737
31629
  title: "Execute Prompt",
30738
- dependencies: [ScopeName.ViewPromptRuns, ScopeName.ViewPrompts],
31630
+ dependencies: ["viewPromptRuns", "viewPrompts"],
30739
31631
  description: "Ability to execute a prompt and view the outputs",
30740
- type: ScopeType.Modify,
30741
- products: [TranscendProduct.PromptManagement]
31632
+ type: "MODIFY",
31633
+ products: ["PROMPT_MANAGER"]
30742
31634
  },
30743
- [ScopeName.ViewAuditorRuns]: {
31635
+ ["viewAuditorRuns"]: {
30744
31636
  title: "View Auditor Runs",
30745
31637
  dependencies: [],
30746
31638
  description: "View the output run results for Auditor.",
30747
- type: ScopeType.View,
30748
- products: [TranscendProduct.WebAuditor]
31639
+ type: "VIEW",
31640
+ products: ["WEB_AUDITOR"]
30749
31641
  },
30750
- [ScopeName.ManageAuditor]: {
31642
+ ["manageAuditor"]: {
30751
31643
  title: "Manage Auditor Runs and Schedules",
30752
- dependencies: [ScopeName.ViewAuditorRuns],
31644
+ dependencies: ["viewAuditorRuns"],
30753
31645
  description: "Manage, edit and create prompt run results",
30754
- type: ScopeType.Modify,
30755
- products: [TranscendProduct.WebAuditor]
31646
+ type: "MODIFY",
31647
+ products: ["WEB_AUDITOR"]
30756
31648
  },
30757
- [ScopeName.ExecuteAuditor]: {
31649
+ ["executeAuditor"]: {
30758
31650
  title: "Execute Auditor",
30759
- dependencies: [ScopeName.ViewAuditorRuns],
31651
+ dependencies: ["viewAuditorRuns"],
30760
31652
  description: "Ability to execute or schedule Auditor and view the outputs",
30761
- type: ScopeType.Modify,
30762
- products: [TranscendProduct.WebAuditor]
31653
+ type: "MODIFY",
31654
+ products: ["WEB_AUDITOR"]
30763
31655
  },
30764
- [ScopeName.ApprovePrompts]: {
31656
+ ["approvePrompts"]: {
30765
31657
  title: "Approve Prompts",
30766
- dependencies: [ScopeName.ViewPrompts],
31658
+ dependencies: ["viewPrompts"],
30767
31659
  description: "Approve the prompts and prompt templates",
30768
- type: ScopeType.Modify,
30769
- products: [TranscendProduct.PromptManagement]
31660
+ type: "MODIFY",
31661
+ products: ["PROMPT_MANAGER"]
30770
31662
  },
30771
- [ScopeName.ManageActionItemCollections]: {
31663
+ ["manageActionItemCollections"]: {
30772
31664
  title: "Manage Action Item Collections",
30773
31665
  dependencies: [],
30774
31666
  description: "Manage and edit action item collections",
30775
- type: ScopeType.Modify,
30776
- products: [TranscendProduct.Administration]
31667
+ type: "MODIFY",
31668
+ products: ["ADMINISTRATION"]
30777
31669
  },
30778
- [ScopeName.ViewManagedConsentDatabaseAdminApi]: {
31670
+ ["viewManagedConsentDatabaseAdminApi"]: {
30779
31671
  title: "View Managed Consent Database Admin API",
30780
31672
  dependencies: [],
30781
31673
  description: "Ability to query user consent preferences with the Managed Consent Database Admin API",
30782
- type: ScopeType.View,
30783
- products: [TranscendProduct.ConsentManagement, TranscendProduct.PreferenceManagement]
31674
+ type: "VIEW",
31675
+ products: ["CONSENT_MANAGEMENT", "PREFERENCE_MANAGEMENT"]
30784
31676
  },
30785
- [ScopeName.ManageStoredPreferences]: {
31677
+ ["manageStoredPreferences"]: {
30786
31678
  title: "Modify User Stored Preferences",
30787
- dependencies: [ScopeName.ViewManagedConsentDatabaseAdminApi],
31679
+ dependencies: ["viewManagedConsentDatabaseAdminApi"],
30788
31680
  description: "Ability to make updates to user stored consent preferences",
30789
- type: ScopeType.Modify,
30790
- products: [TranscendProduct.ConsentManagement, TranscendProduct.PreferenceManagement]
31681
+ type: "MODIFY",
31682
+ products: ["CONSENT_MANAGEMENT", "PREFERENCE_MANAGEMENT"]
30791
31683
  },
30792
- [ScopeName.ManagePreferenceStoreSettings]: {
31684
+ ["managePreferenceStoreSettings"]: {
30793
31685
  title: "Manage Preference Store Settings",
30794
- dependencies: [ScopeName.ViewPreferenceStoreSettings],
31686
+ dependencies: ["viewPreferenceStoreSettings"],
30795
31687
  description: "Ability to make updates to preference store settings",
30796
- type: ScopeType.Modify,
30797
- products: [TranscendProduct.PreferenceManagement]
31688
+ type: "MODIFY",
31689
+ products: ["PREFERENCE_MANAGEMENT"]
30798
31690
  },
30799
- [ScopeName.ViewPreferenceStoreSettings]: {
31691
+ ["viewPreferenceStoreSettings"]: {
30800
31692
  title: "View Preference Store Settings",
30801
- dependencies: [ScopeName.ViewPreferenceStoreSettings],
31693
+ dependencies: ["viewPreferenceStoreSettings"],
30802
31694
  description: "Ability to view preference store settings",
30803
- type: ScopeType.Modify,
30804
- products: [TranscendProduct.PreferenceManagement]
31695
+ type: "MODIFY",
31696
+ products: ["PREFERENCE_MANAGEMENT"]
30805
31697
  },
30806
- [ScopeName.LLMLogTransfer]: {
31698
+ ["llmLogTransfer"]: {
30807
31699
  title: "LLM Log Transfer",
30808
- dependencies: [ScopeName.ManageDataInventory],
31700
+ dependencies: ["manageDataInventory"],
30809
31701
  description: "Ability to transfer logs from LLM to Transcend",
30810
- type: ScopeType.Modify,
30811
- products: [TranscendProduct.StructuredDiscovery, TranscendProduct.UnstructuredDiscovery]
31702
+ type: "MODIFY",
31703
+ products: ["STRUCTURED_DISCOVERY", "UNSTRUCTURED_DISCOVERY"]
30812
31704
  },
30813
- [ScopeName.ManageWorkflows]: {
31705
+ ["manageWorkflows"]: {
30814
31706
  title: "Manage Workflows",
30815
31707
  description: "Ability to make updates to Workflows and their settings",
30816
31708
  dependencies: [],
30817
- type: ScopeType.Modify,
30818
- products: [TranscendProduct.DsrAutomation]
31709
+ type: "MODIFY",
31710
+ products: ["DSR_AUTOMATION"]
30819
31711
  },
30820
- [ScopeName.ViewDataSubCategories]: {
31712
+ ["viewDataSubCategories"]: {
30821
31713
  title: "View Data Sub Categories",
30822
31714
  dependencies: [],
30823
31715
  description: "View Data Sub Categories from Data Inventory",
30824
- type: ScopeType.View,
30825
- products: [TranscendProduct.DataInventory]
31716
+ type: "VIEW",
31717
+ products: ["DATA_INVENTORY"]
30826
31718
  },
30827
- [ScopeName.GeneratePreferenceAccessTokens]: {
31719
+ ["generatePreferenceAccessTokens"]: {
30828
31720
  title: "Generate Preference Access Tokens",
30829
31721
  dependencies: [],
30830
31722
  description: "Ability to generate access tokens for user preferences",
30831
- type: ScopeType.Modify,
30832
- products: [TranscendProduct.PreferenceManagement, TranscendProduct.PrivacyCenter]
31723
+ type: "MODIFY",
31724
+ products: ["PREFERENCE_MANAGEMENT", "PRIVACY_CENTER"]
30833
31725
  },
30834
- [ScopeName.ViewRules]: {
31726
+ ["viewRules"]: {
30835
31727
  title: "View Rules",
30836
31728
  dependencies: [],
30837
31729
  description: "View rules, their triggers, actions, and execution history.",
30838
- type: ScopeType.View,
30839
- products: [TranscendProduct.RulesAutomation]
31730
+ type: "VIEW",
31731
+ products: ["RULES_AUTOMATION"]
30840
31732
  },
30841
- [ScopeName.ManageRules]: {
31733
+ ["manageRules"]: {
30842
31734
  title: "Manage Rules",
30843
- dependencies: [ScopeName.ViewRules],
31735
+ dependencies: ["viewRules"],
30844
31736
  description: "Create, update, and delete rules and their configurations.",
30845
- type: ScopeType.Modify,
30846
- products: [TranscendProduct.RulesAutomation]
31737
+ type: "MODIFY",
31738
+ products: ["RULES_AUTOMATION"]
30847
31739
  },
30848
- [ScopeName.ViewAssignedRules]: {
31740
+ ["viewAssignedRules"]: {
30849
31741
  title: "View Assigned Rules",
30850
31742
  dependencies: [],
30851
31743
  description: "View rules assigned to you or your team.",
30852
- type: ScopeType.View,
30853
- products: [TranscendProduct.RulesAutomation]
31744
+ type: "VIEW",
31745
+ products: ["RULES_AUTOMATION"]
30854
31746
  },
30855
- [ScopeName.ManageAssignedRules]: {
31747
+ ["manageAssignedRules"]: {
30856
31748
  title: "Manage Assigned Rules",
30857
- dependencies: [ScopeName.ViewAssignedRules],
31749
+ dependencies: ["viewAssignedRules"],
30858
31750
  description: "Manage and edit rules assigned to you or your team.",
30859
- type: ScopeType.Modify,
30860
- products: [TranscendProduct.RulesAutomation]
31751
+ type: "MODIFY",
31752
+ products: ["RULES_AUTOMATION"]
30861
31753
  },
30862
- [ScopeName.ExecuteRules]: {
31754
+ ["executeRules"]: {
30863
31755
  title: "Execute Rules",
30864
- dependencies: [ScopeName.ViewRules],
31756
+ dependencies: ["viewRules"],
30865
31757
  description: "Trigger rule execution and view the outputs.",
30866
- type: ScopeType.Modify,
30867
- products: [TranscendProduct.RulesAutomation]
31758
+ type: "MODIFY",
31759
+ products: ["RULES_AUTOMATION"]
30868
31760
  }
30869
31761
  };
30870
31762
  const TRANSCEND_SCOPES = {
30871
- [ScopeName.ReadOnly]: {
30872
- dependencies: getEntries(SCOPES_WITHOUT_VIEW_ONLY).filter(([, v]) => v.type === ScopeType.View).map(([k]) => k),
31763
+ ["readOnly"]: {
31764
+ dependencies: getEntries(SCOPES_WITHOUT_VIEW_ONLY).filter(([, v]) => v.type === "VIEW").map(([k]) => k),
30873
31765
  description: "Access is granted to all of the scopes of type \"View\".",
30874
31766
  title: "View Only",
30875
- type: ScopeType.View,
31767
+ type: "VIEW",
30876
31768
  products: getValues(TranscendProduct)
30877
31769
  },
30878
31770
  ...SCOPES_WITHOUT_VIEW_ONLY
@@ -30884,31 +31776,48 @@ const TRANSCEND_SCOPES = {
30884
31776
  * identifiers needed to establish a connection for the current browsing session.
30885
31777
  */
30886
31778
  const ConnectionSubCategory = makeEnum({
31779
+ /** A Media Access Control address */
30887
31780
  MACAddress: "MAC_ADDRESS",
31781
+ /** An internet protocol address */
30888
31782
  IPAddress: "IP_ADDRESS",
31783
+ /** The User-Agent request header */
30889
31784
  UserAgent: "USER_AGENT",
31785
+ /** Fallback subcategory */
30890
31786
  Connection: "CONNECTION"
30891
31787
  });
30892
31788
  //#endregion
30893
31789
  //#region src/subcategories/contact.ts
30894
31790
  const ContactSubCategory = makeEnum({
31791
+ /** An email address */
30895
31792
  Email: "EMAIL",
31793
+ /** A phone number */
30896
31794
  Phone: "PHONE",
31795
+ /** Fallback subcategory */
30897
31796
  Contact: "CONTACT"
30898
31797
  });
30899
31798
  //#endregion
30900
31799
  //#region src/subcategories/demographic.ts
30901
31800
  /** Information about the features or characteristics of a user */
30902
31801
  const DemographicSubCategory = makeEnum({
31802
+ /** Information about an individual's racial or ethnic origin */
30903
31803
  RaceOrEthnicity: "RACE_OR_ETHNICITY",
31804
+ /** An individual's gender */
30904
31805
  Gender: "GENDER",
31806
+ /** An individual's date of birth */
30905
31807
  DateOfBirth: "DATE_OF_BIRTH",
31808
+ /** An individual's country, city, or other static location information */
30906
31809
  Region: "REGION",
31810
+ /** The industry in which an individual works */
30907
31811
  Industry: "INDUSTRY",
31812
+ /** An individual's sexual orientation */
30908
31813
  SexualOrientation: "SEXUAL_ORIENTATION",
31814
+ /** Information about an individual's union membership */
30909
31815
  UnionMembership: "UNION_MEMBERSHIP",
31816
+ /** Information about an individual's religious beliefs */
30910
31817
  Religion: "RELIGION",
31818
+ /** Information about an individual's political beliefs or party membership */
30911
31819
  PoliticalAffiliation: "POLITICAL_AFFILIATION",
31820
+ /** Fallback subcategory */
30912
31821
  Demographic: "DEMOGRAPHIC"
30913
31822
  });
30914
31823
  //#endregion
@@ -30917,73 +31826,109 @@ const DemographicSubCategory = makeEnum({
30917
31826
  * The type of operating system (OS) or web browser that the user uses, or similar computer or device information.
30918
31827
  */
30919
31828
  const DeviceSubCategory = makeEnum({
31829
+ /** A unique device identifier */
30920
31830
  SerialNumber: "SERIAL_NUMBER",
31831
+ /** Fallback subcategory */
30921
31832
  Device: "DEVICE"
30922
31833
  });
30923
31834
  //#endregion
30924
31835
  //#region src/subcategories/financial.ts
30925
31836
  /** Information about an individual's finances */
30926
31837
  const FinancialSubCategory = makeEnum({
31838
+ /** Account number */
30927
31839
  AccountNumber: "ACCOUNT_NUMBER",
31840
+ /** Credit Card Number */
30928
31841
  CreditCardNumber: "CREDIT_CARD_NUMBER",
31842
+ /** Income */
30929
31843
  Income: "INCOME",
31844
+ /** Tax information */
30930
31845
  Tax: "TAX",
31846
+ /** Routing number */
30931
31847
  RoutingNumber: "ROUTING_NUMBER",
31848
+ /** Fallback subcategory */
30932
31849
  Financial: "FINANCIAL"
30933
31850
  });
30934
31851
  //#endregion
30935
31852
  //#region src/subcategories/health.ts
30936
31853
  /** Information about an individual's health */
30937
- const HealthSubCategory = makeEnum({ Health: "HEALTH" });
31854
+ const HealthSubCategory = makeEnum({
31855
+ /** Fallback subcategory */
31856
+ Health: "HEALTH" });
30938
31857
  //#endregion
30939
31858
  //#region src/subcategories/id.ts
30940
31859
  /** Information that can be used to identify an individual */
30941
31860
  const IdSubCategory = makeEnum({
31861
+ /** A username associated with an individual */
30942
31862
  Username: "USERNAME",
31863
+ /** A person's name */
30943
31864
  Name: "NAME",
31865
+ /** An individual's (US) Social security number */
30944
31866
  SocialSecurityNumber: "SOCIAL_SECURITY_NUMBER",
31867
+ /** Driver's license */
30945
31868
  DriversLicense: "DRIVERS_LICENSE",
31869
+ /** Passport number */
30946
31870
  PassportNumber: "PASSPORT_NUMBER",
31871
+ /** A digital representation of an individual's unique physical characteristics (e.g. fingerprint, retina or iris image, etc.) */
30947
31872
  BiometricIdentifier: "BIOMETRIC_IDENTIFIER",
31873
+ /** The user ID */
30948
31874
  UserId: "USER_ID",
31875
+ /** Fallback subcategory */
30949
31876
  Id: "ID"
30950
31877
  });
30951
31878
  //#endregion
30952
31879
  //#region src/subcategories/location.ts
30953
31880
  const LocationSubCategory = makeEnum({
31881
+ /** Approximate geolocation */
30954
31882
  ApproximateLocation: "APPROXIMATE_LOCATION",
31883
+ /** Fallback subcategory */
30955
31884
  Location: "LOCATION"
30956
31885
  });
30957
31886
  //#endregion
30958
31887
  //#region src/subcategories/notPersonalData.ts
30959
31888
  /** Information that does not belong to an individual */
30960
- const NotPersonalDataSubCategory = makeEnum({ NotPersonalData: "NOT_PERSONAL_DATA" });
31889
+ const NotPersonalDataSubCategory = makeEnum({
31890
+ /** Fallback subcategory */
31891
+ NotPersonalData: "NOT_PERSONAL_DATA" });
30961
31892
  //#endregion
30962
31893
  //#region src/subcategories/onlineActivity.ts
30963
31894
  const OnlineActivitySubCategory = makeEnum({
31895
+ /** Declared interests */
30964
31896
  DeclaredInterests: "DECLARED_INTERESTS",
31897
+ /** Page views */
30965
31898
  PageViews: "PAGE_VIEWS",
31899
+ /** Interaction events */
30966
31900
  InteractionEvents: "INTERACTION_EVENTS",
31901
+ /** Fallback subcategory */
30967
31902
  OnlineActivity: "ONLINE_ACTIVITY"
30968
31903
  });
30969
31904
  //#endregion
30970
31905
  //#region src/subcategories/socialMedia.ts
30971
31906
  const SocialMediaSubCategory = makeEnum({
31907
+ /** A link to an individual's social media profile */
30972
31908
  ProfileURL: "PROFILE_URL",
31909
+ /** Fallback subcategory */
30973
31910
  SocialMedia: "SOCIAL_MEDIA"
30974
31911
  });
30975
31912
  //#endregion
30976
31913
  //#region src/subcategories/survey.ts
30977
- const SurveySubCategory = makeEnum({ Survey: "SURVEY" });
31914
+ const SurveySubCategory = makeEnum({
31915
+ /** Fallback subcategory */
31916
+ Survey: "SURVEY" });
30978
31917
  //#endregion
30979
31918
  //#region src/subcategories/tracking.ts
30980
- const TrackingSubCategory = makeEnum({ Tracking: "TRACKING" });
31919
+ const TrackingSubCategory = makeEnum({
31920
+ /** Fallback subcategory */
31921
+ Tracking: "TRACKING" });
30981
31922
  //#endregion
30982
31923
  //#region src/subcategories/userProfile.ts
30983
31924
  const UserProfileSubCategory = makeEnum({
31925
+ /** A link to an individual's profile picture */
30984
31926
  ProfilePictureURL: "PROFILE_PICTURE_URL",
31927
+ /** An individual's profile picture */
30985
31928
  ProfilePictureImage: "PROFILE_PICTURE_IMAGE",
31929
+ /** The user's stated preferences while using an app */
30986
31930
  UserPreferences: "USER_PREFERENCES",
31931
+ /** Fallback subcategory */
30987
31932
  UserProfile: "USER_PROFILE"
30988
31933
  });
30989
31934
  //#endregion
@@ -31079,30 +32024,70 @@ let CustomizableText = /* @__PURE__ */ function(CustomizableText) {
31079
32024
  * The color palette that must be defined
31080
32025
  */
31081
32026
  const RequiredConfigurableColorPaletteColor = makeEnum({
32027
+ /**
32028
+ * Used everywhere...
32029
+ *
32030
+ * The primary color chosen by Company X will be applied by default to the following elements of the Privacy Center:
32031
+ * 1. **Hero background**
32032
+ * 2. **Sidebar navigation background**
32033
+ * 3. **Primary CTA (call to action)**
32034
+ * 4. **Primary links and active states**
32035
+ */
31082
32036
  Primary: "primary",
32037
+ /**
32038
+ * Used everywhere...
32039
+ *
32040
+ * The secondary color chosen by Company X will be applied by default to the following elements of the Privacy Center::
32041
+ * 1. **Secondary CTAs**
32042
+ * 2. **Secondary links**
32043
+ */
31083
32044
  Secondary: "secondary"
31084
32045
  });
31085
32046
  /**
31086
32047
  * The optional color pallette colors
31087
32048
  */
31088
32049
  const OptionalConfigurableColorPaletteColor = makeEnum({
32050
+ /**
32051
+ * The background color will be set by the primary color by default with the ability to change it to secondary color, black or white.
32052
+ */
31089
32053
  SidebarNavBg: "sidebarNavBg",
32054
+ /**
32055
+ * The hero background color
32056
+ */
31090
32057
  HeroBg: "heroBg",
32058
+ /**
32059
+ * The background of the widget
32060
+ */
31091
32061
  WidgetBg: "widgetBg",
32062
+ /** The main text color to use when text is shown on an object colored bg */
31092
32063
  TextOnBg: "textOnBg",
32064
+ /** A lighter text color to use when text is shown on an object colored bg */
31093
32065
  TextLightOnBg: "textLightOnBg",
32066
+ /** The main text color to use when text is shown on an object colored primary */
31094
32067
  TextOnPrimary: "textOnPrimary",
32068
+ /** Text on sidebar */
31095
32069
  TextOnSidebar: "textOnSidebar",
32070
+ /** Accent on sidebar */
31096
32071
  AccentOnSidebar: "accentOnSidebar",
32072
+ /** Text to use on hero */
31097
32073
  TextOnHero: "textOnHero",
32074
+ /** Text to use on About Transcend widget */
31098
32075
  TextOnAboutTranscend: "textOnAboutTranscend",
32076
+ /** Used to highlight text */
31099
32077
  Highlight: "highlight",
32078
+ /** The color of the table outline */
31100
32079
  TableOutline: "tableOutline",
32080
+ /** The page's accent background color (used in call-outs and asides) */
31101
32081
  BgAccent: "bgAccent",
32082
+ /** Error color -- something went wrong */
31102
32083
  Error: "error",
32084
+ /** White color */
31103
32085
  White: "white",
32086
+ /** Black color */
31104
32087
  Black: "black",
32088
+ /** Light gray color */
31105
32089
  Gray1: "gray1",
32090
+ /** Medium gray color */
31106
32091
  Gray4: "gray4"
31107
32092
  });
31108
32093
  /**
@@ -31136,13 +32121,17 @@ const PrivacyCenterTextStyles = t.partial(applyEnum(CustomizableText, () => Priv
31136
32121
  * Input for defining a new theme
31137
32122
  */
31138
32123
  const PrivacyCenterThemePartial = t.intersection([t.type({
32124
+ /** The display name of the theme */
31139
32125
  name: t.string,
32126
+ /** The theme colors */
31140
32127
  colors: PrivacyCenterConfigurableColorPalette
31141
32128
  }), t.partial({
32129
+ /** Styles to apply to components */
31142
32130
  componentStyles: PrivacyCenterComponentStyles,
32131
+ /** Override styles */
31143
32132
  textStyles: PrivacyCenterTextStyles
31144
32133
  })]);
31145
32134
  //#endregion
31146
- export { AbsoluteUrlString, ActionItemCode, ActionItemPriorityOverride, AirgapBundleAnalyticsBinInterval, AirgapBundleAnalyticsDimension, AirgapBundleAnalyticsMetric, AssessmentFormStatus, AssessmentFormTemplateSource, AssessmentFormTemplateStatus, AssessmentQuestionSubType, AssessmentQuestionType, AssessmentSyncColumn, AssessmentSyncModel, AssessmentsDisplayLogicAction, AttributeKeyType, AttributeSupportedResourceType, AutofocusToggle, AutofocusValues, BackendSyncOption, Background, Border, Breakpoint, BreakpointType, BrowserTimeZone, BusinessEntityAttribute, BusinessEntityAttributeSyncColumn, ButtonAction, ButtonConfig, ButtonTheme, ButtonThemeIndex, ButtonType, CODE_PACKAGE_TYPE_TO_LINK, COUNTRIES, COUNTRY_LOOKUP, ChatCompletionMessage, ChatCompletionRole, CloseButtonTheme, CodePackageType, CommonLayerConfig, CommonLayerTheme, CommonLayerThemeMinimal, CommunicationIdentifierType, ComparisonOperator, CompletedRequestStatus, ConfidenceLabel, ConfigurableColorPaletteColor, ConsentBundleType, ConsentManagerAnalyticsDataSource, ConsentManagerMetricBin, ConsentPrecedenceOption, ConsentTrackerSource, ConsentTrackerStatus, ConsentTrackerType, ContainerTheme, ContentFlows, ContentLayout, Controllership, CookieOrderField, CspOption, CssUnitString, CustomEnricherType, CustomFieldApiInput, CustomizableComponent, CustomizableText, DEFAULT_MACROREGIONS_MAP, DOMElementId, DataCategoryType, DataFlowOrderField, DataFlowScope, DataFlowType, DataProtectionImpactAssessmentStatus, DataSiloAttribute, DataSiloAttributeSyncColumn, DataSubCategoryAttribute, DataSubCategoryAttributeSyncColumn, DatabaseDriver, DatabaseIntegration, DatabaseSqlVariablesForPrivacyRequest, DatabaseVariables, DecryptionStatus, DefaultConsentOption, DefaultDataSubCategoryType, DefaultPurposeSubCategoryType, DescriptionTextTheme, EXCEPTIONAL_RESERVATIONS, EXCEPTIONAL_RESERVATION_LOOKUP, EnricherType, FirstLayerConfig, FirstLayerTheme, FirstLayerThemeMinimal, FooterConfig, FooterTheme, FullWidthContentLayout, HeaderTheme, HeaderThemeMinimal, HorizontalAlign, ISO_31661, ISO_31662, Icon, IdentifierType, InitEnricherType, IntegerString, InternalDataSiloObjectResolver, IsoCountryCode, IsoCountrySubdivisionCode, LargeLanguageModelClient, Link, LoadOptions, LocalSyncOption, LogicOperator, LogoPosition, MacroRegion, ModalButtonActions, ModalButtonConfig, NORMALIZE_PHONE_NUMBER, OneTrustApprover, OneTrustAssessment, OneTrustAssessmentCreatedBy, OneTrustAssessmentCsvHeader, OneTrustAssessmentCsvRecord, OneTrustAssessmentNestedQuestion, OneTrustAssessmentQuestion, OneTrustAssessmentQuestionOption, OneTrustAssessmentQuestionResponses, OneTrustAssessmentQuestionRisk, OneTrustAssessmentResponses, OneTrustAssessmentSection, OneTrustAssessmentSectionHeader, OneTrustAssessmentSectionHeaderRiskStatistics, OneTrustAssessmentSectionSubmittedBy, OneTrustAssessmentStatus, OneTrustEnrichedAssessment, OneTrustEnrichedAssessmentQuestion, OneTrustEnrichedAssessmentResponse, OneTrustEnrichedAssessmentSection, OneTrustEnrichedAssessments, OneTrustEnrichedRisk, OneTrustEnrichedRisks, OneTrustEnrichedUser, OneTrustGetAssessmentResponse, OneTrustGetListOfAssessmentsResponse, OneTrustGetRiskResponse, OneTrustGetUserResponse, OneTrustPrimaryEntityDetails, OneTrustQuestionComment, OneTrustQuestionComments, OneTrustRiskCategories, OneTrustRiskReference, OneTrustRiskReferences, OneTrustRiskTemplate, OneTrustUserDetails, OneTrustUserEmail, OneTrustUserEmails, OneTrustUserGroup, OneTrustUserMetadata, OptionalConfigurableColorPaletteColor, OrderDirection, PROMPT_FILE_PURPOSE_TO_OPEN_AI, PaddedContentLayout, Preference, PreferenceQueryResponseItem, PreferenceStoreAuthLevel, PreferenceStoreConsentFields, PreferenceStoreIdentifier, PreferenceStoreKeyConditionals, PreferenceStorePurposeResponse, PreferenceStorePurposeUpdate, PreferenceStoreSystemAttributes, PreferenceStoreWorkflowSettings, PreferenceTopicType, PreferenceUpdateItem, PreflightRequestStatus, PrivacyCenterComponentStyles, PrivacyCenterConfigurableColorPalette, PrivacyCenterFont, PrivacyCenterFontBasic, PrivacyCenterTextStyles, PrivacyCenterThemePartial, ProcessingActivityAttribute, ProcessingActivityAttributeSyncColumn, ProcessingPurpose, ProcessingPurposeSubCategoryAttribute, ProcessingPurposeSubCategoryAttributeSyncColumn, PromptAVendorEmailCompletionLinkType, PromptAVendorEmailSendType, PromptFilePurpose, PromptResponseFormat, PromptRunProductArea, PromptStatus, QueueStatus, REQUEST_ACTION_OPT_IN_TO_OPT_OUT, REQUEST_ACTION_OPT_OUT_TO_OPT_IN, RegimeKey, RegionDetectionMethod, RegionsOperator, RequestAction, RequestActionObjectResolver, RequestActionOptIn, RequestActionOptOut, RequestDataSiloStatus, RequestEnricherStatus, RequestOrigin, RequestStatus, RequiredConfigurableColorPaletteColor, RetentionScheduleOperation, RetentionScheduleType, RetentionType, RgbHexString, RgbaHexString, SQLDriverWithDataMapping, ScopeName, ScopeType, SecondLayerConfig, SecondLayerTheme, SecondLayerThemeMinimal, SemicolonDelimitedRegimeKeyString, ShadowRootOptions, SharedTopLevelConfig, SharedTopLevelTheme, SignedIabAgreementOption, SombraStandardScope, StaticTeamType, SubDataPointAttribute, SubDataPointAttributeSyncColumn, SubDataPointDataSubCategoryGuessStatus, TRANSCEND_SCOPES, TableEncryptionType, TelemetryPartitionStrategy, TemplateVariableModelName, Text, ThemeConfiguration, ThemeConfigurationBannerIntoModal, ThemeConfigurationBannerIntoModalMinimal, ThemeConfigurationBannerOnly, ThemeConfigurationBannerOnlyMinimal, ThemeConfigurationMinimal, ThemeConfigurationModalOnly, ThemeConfigurationModalOnlyMinimal, ThemeKey, ToggleTheme, TranscendProduct, TriageAction, UIConfiguration, UIConfigurationBannerIntoModal, UIConfigurationBannerOnly, UIConfigurationModalOnly, UnknownRequestPolicy, UnstructuredSubDataPointRecommendationStatus, UspapiOption, VariantKey, VendorAttribute, VendorAttributeSyncColumn, VerticalAlign, getRegistryLink };
32135
+ export { AbsoluteUrlString, ActionItemCode, ActionItemPriorityOverride, AirgapBundleAnalyticsBinInterval, AirgapBundleAnalyticsDimension, AirgapBundleAnalyticsMetric, AssessmentFormStatus, AssessmentFormTemplateSource, AssessmentFormTemplateStatus, AssessmentQuestionSubType, AssessmentQuestionType, AssessmentSyncColumn, AssessmentSyncModel, AssessmentsDisplayLogicAction, AttributeKeyType, AttributeSupportedResourceType, AutofocusToggle, AutofocusValues, BackendSyncOption, Background, Border, Breakpoint, BreakpointType, BrowserTimeZone, BusinessEntityAttribute, BusinessEntityAttributeSyncColumn, ButtonAction, ButtonConfig, ButtonTheme, ButtonThemeIndex, ButtonType, CODE_PACKAGE_TYPE_TO_LINK, COUNTRIES, COUNTRY_LOOKUP, ChatCompletionMessage, ChatCompletionRole, CloseButtonTheme, CodePackageType, CommonLayerConfig, CommonLayerTheme, CommonLayerThemeMinimal, CommunicationIdentifierType, ComparisonOperator, CompletedRequestStatus, ConfidenceLabel, ConfigurableColorPaletteColor, ConsentBundleType, ConsentManagerAnalyticsDataSource, ConsentManagerMetricBin, ConsentPrecedenceOption, ConsentThemeInput, ConsentTrackerSource, ConsentTrackerStatus, ConsentTrackerType, ConsentUiUserFlow, ConsentVariantInput, ContainerTheme, ContentFlows, ContentLayout, Controllership, CookieOrderField, CspOption, CssUnitString, CustomEnricherType, CustomFieldApiInput, CustomizableComponent, CustomizableText, DEFAULT_MACROREGIONS_MAP, DOMElementId, DataCategoryType, DataFlowOrderField, DataFlowScope, DataFlowType, DataProtectionImpactAssessmentStatus, DataSiloAttribute, DataSiloAttributeSyncColumn, DataSubCategoryAttribute, DataSubCategoryAttributeSyncColumn, DatabaseDriver, DatabaseIntegration, DatabaseSqlVariablesForPrivacyRequest, DatabaseVariables, DecryptionStatus, DefaultConsentOption, DefaultDataSubCategoryType, DefaultPurposeSubCategoryType, DescriptionTextTheme, EXCEPTIONAL_RESERVATIONS, EXCEPTIONAL_RESERVATION_LOOKUP, EnricherType, FirstLayerConfig, FirstLayerTheme, FirstLayerThemeMinimal, FooterConfig, FooterTheme, FullWidthContentLayout, HeaderTheme, HeaderThemeMinimal, HorizontalAlign, ISO_31661, ISO_31662, Icon, IdentifierType, InitEnricherType, IntegerString, InternalDataSiloObjectResolver, IsoCountryCode, IsoCountrySubdivisionCode, LargeLanguageModelClient, Link, LoadOptions, LocalSyncOption, LogicOperator, LogoPosition, MacroRegion, ModalButtonActions, ModalButtonConfig, NORMALIZE_PHONE_NUMBER, OneTrustApprover, OneTrustAssessment, OneTrustAssessmentCreatedBy, OneTrustAssessmentCsvHeader, OneTrustAssessmentCsvRecord, OneTrustAssessmentNestedQuestion, OneTrustAssessmentQuestion, OneTrustAssessmentQuestionOption, OneTrustAssessmentQuestionResponses, OneTrustAssessmentQuestionRisk, OneTrustAssessmentResponses, OneTrustAssessmentSection, OneTrustAssessmentSectionHeader, OneTrustAssessmentSectionHeaderRiskStatistics, OneTrustAssessmentSectionSubmittedBy, OneTrustAssessmentStatus, OneTrustEnrichedAssessment, OneTrustEnrichedAssessmentQuestion, OneTrustEnrichedAssessmentResponse, OneTrustEnrichedAssessmentSection, OneTrustEnrichedAssessments, OneTrustEnrichedRisk, OneTrustEnrichedRisks, OneTrustEnrichedUser, OneTrustGetAssessmentResponse, OneTrustGetListOfAssessmentsResponse, OneTrustGetRiskResponse, OneTrustGetUserResponse, OneTrustPrimaryEntityDetails, OneTrustQuestionComment, OneTrustQuestionComments, OneTrustRiskCategories, OneTrustRiskReference, OneTrustRiskReferences, OneTrustRiskTemplate, OneTrustUserDetails, OneTrustUserEmail, OneTrustUserEmails, OneTrustUserGroup, OneTrustUserMetadata, OptionalConfigurableColorPaletteColor, OrderDirection, PROMPT_FILE_PURPOSE_TO_OPEN_AI, PaddedContentLayout, Preference, PreferenceQueryResponseItem, PreferenceStoreAuthLevel, PreferenceStoreConsentFields, PreferenceStoreIdentifier, PreferenceStoreKeyConditionals, PreferenceStorePurposeResponse, PreferenceStorePurposeUpdate, PreferenceStoreSystemAttributes, PreferenceStoreWorkflowSettings, PreferenceTopicType, PreferenceUpdateItem, PreflightRequestStatus, PrivacyCenterComponentStyles, PrivacyCenterConfigurableColorPalette, PrivacyCenterFont, PrivacyCenterFontBasic, PrivacyCenterTextStyles, PrivacyCenterThemePartial, ProcessingActivityAttribute, ProcessingActivityAttributeSyncColumn, ProcessingPurpose, ProcessingPurposeSubCategoryAttribute, ProcessingPurposeSubCategoryAttributeSyncColumn, PromptAVendorEmailCompletionLinkType, PromptAVendorEmailSendType, PromptFilePurpose, PromptResponseFormat, PromptRunProductArea, PromptStatus, QueueStatus, REQUEST_ACTION_OPT_IN_TO_OPT_OUT, REQUEST_ACTION_OPT_OUT_TO_OPT_IN, RegimeKey, RegionDetectionMethod, RegionsOperator, RequestAction, RequestActionObjectResolver, RequestActionOptIn, RequestActionOptOut, RequestDataSiloStatus, RequestEnricherStatus, RequestOrigin, RequestStatus, RequiredConfigurableColorPaletteColor, RestartIdentifierStrategy, RetentionScheduleOperation, RetentionScheduleType, RetentionType, RgbHexString, RgbaHexString, SQLDriverWithDataMapping, ScopeName, ScopeType, SecondLayerConfig, SecondLayerTheme, SecondLayerThemeMinimal, SemicolonDelimitedRegimeKeyString, ShadowRootOptions, SharedTopLevelConfig, SharedTopLevelTheme, SignedIabAgreementOption, SombraStandardScope, StaticTeamType, SubDataPointAttribute, SubDataPointAttributeSyncColumn, SubDataPointDataSubCategoryGuessStatus, TRANSCEND_SCOPES, TableEncryptionType, TelemetryPartitionStrategy, TemplateVariableModelName, Text, ThemeConfiguration, ThemeConfigurationBannerIntoModal, ThemeConfigurationBannerIntoModalMinimal, ThemeConfigurationBannerOnly, ThemeConfigurationBannerOnlyMinimal, ThemeConfigurationMinimal, ThemeConfigurationModalOnly, ThemeConfigurationModalOnlyMinimal, ThemeKey, ToggleTheme, TranscendProduct, TriageAction, UIConfiguration, UIConfigurationBannerIntoModal, UIConfigurationBannerOnly, UIConfigurationModalOnly, UiVariantStatus, UnknownRequestPolicy, UnstructuredSubDataPointRecommendationStatus, UspapiOption, VariantKey, VendorAttribute, VendorAttributeSyncColumn, VerticalAlign, getRegistryLink };
31147
32136
 
31148
32137
  //# sourceMappingURL=index.mjs.map