@transcend-io/privacy-types 5.2.3 → 5.2.5

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,14 +1901,21 @@ 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
  /**
1714
1910
  * Represents a container theme with background and border configurations
1715
1911
  */
1716
1912
  const ContainerTheme = t.intersection([Background, Border]);
1717
- /** Represents the header theme configuration */
1913
+ /** Represents the header theme configuration (reduced scope) */
1914
+ const HeaderThemeMinimal = t.type({
1915
+ logoPosition: valuesOf(LogoPosition),
1916
+ logoImageUrl: AbsoluteUrlString
1917
+ });
1918
+ /** Represents the header theme configuration (full scope) */
1718
1919
  const HeaderTheme = t.intersection([Text, t.type({ logoPosition: valuesOf(LogoPosition) })]);
1719
1920
  /** Represents the configuration of the close button */
1720
1921
  const CloseButtonTheme = t.intersection([
@@ -1745,7 +1946,9 @@ const ToggleTheme = t.intersection([
1745
1946
  knobColor: RgbHexString
1746
1947
  })
1747
1948
  ]);
1748
- /** Theme configuration shared between both First (banner) and Second Layers (modal) */
1949
+ /** Theme configuration shared between both First (banner) and Second Layers (modal) (reduced scope) */
1950
+ const CommonLayerThemeMinimal = t.intersection([t.type({ alwaysShowScrollbar: t.boolean }), t.partial({ header: HeaderThemeMinimal })]);
1951
+ /** Theme configuration shared between both First (banner) and Second Layers (modal) (full scope) */
1749
1952
  const CommonLayerTheme = t.intersection([t.type({
1750
1953
  buttons: t.tuple([
1751
1954
  ButtonThemeIndex,
@@ -1763,12 +1966,20 @@ const CommonLayerTheme = t.intersection([t.type({
1763
1966
  header: HeaderTheme,
1764
1967
  closeButton: CloseButtonTheme
1765
1968
  })]);
1766
- /** Theme configuration for the First Layer (banner) */
1767
- const FirstLayerTheme = t.intersection([CommonLayerTheme, t.type({
1768
- contentFlow: valuesOf(ContentFlows),
1769
- verticalAlign: valuesOf(VerticalAlign)
1770
- })]);
1771
- /** Theme configuration for the Second Layer (modal) */
1969
+ /** Theme configuration for the First Layer (banner) (reduced scope) */
1970
+ const FirstLayerThemeMinimal = t.intersection([CommonLayerThemeMinimal, t.type({ contentLayout: ContentLayout })]);
1971
+ /** Theme configuration for the First Layer (banner) (full scope) */
1972
+ const FirstLayerTheme = t.intersection([
1973
+ CommonLayerTheme,
1974
+ t.type({
1975
+ contentFlow: valuesOf(ContentFlows),
1976
+ verticalAlign: valuesOf(VerticalAlign)
1977
+ }),
1978
+ t.partial({ contentLayout: ContentLayout })
1979
+ ]);
1980
+ /** Theme configuration for the Second Layer (modal) (reduced scope) */
1981
+ const SecondLayerThemeMinimal = t.intersection([CommonLayerThemeMinimal, t.type({ lockToEdges: t.boolean })]);
1982
+ /** Theme configuration for the Second Layer (modal) (full scope) */
1772
1983
  const SecondLayerTheme = t.intersection([
1773
1984
  CommonLayerTheme,
1774
1985
  t.type({
@@ -1797,16 +2008,31 @@ const ButtonTheme = t.union([t.intersection([
1797
2008
  ]), Link]);
1798
2009
  /** Configuration shared between all themes types */
1799
2010
  const SharedTopLevelTheme = t.type({ buttonThemes: t.array(ButtonTheme) });
1800
- /** Banner-only theme configuration */
2011
+ /** Banner-only theme configuration (reduced scope) */
2012
+ const ThemeConfigurationBannerOnlyMinimal = t.type({ firstLayer: FirstLayerThemeMinimal });
2013
+ /** Banner-only theme configuration (full scope) */
1801
2014
  const ThemeConfigurationBannerOnly = t.intersection([SharedTopLevelTheme, t.type({ firstLayer: FirstLayerTheme })]);
1802
- /** Modal-only theme configuration */
2015
+ /** Modal-only theme configuration (reduced scope) */
2016
+ const ThemeConfigurationModalOnlyMinimal = t.type({ secondLayer: SecondLayerThemeMinimal });
2017
+ /** Modal-only theme configuration (full scope) */
1803
2018
  const ThemeConfigurationModalOnly = t.intersection([SharedTopLevelTheme, t.type({ secondLayer: SecondLayerTheme })]);
1804
- /** Banner into modal theme configuration */
2019
+ /** Banner into modal theme configuration (reduced scope) */
2020
+ const ThemeConfigurationBannerIntoModalMinimal = t.type({
2021
+ firstLayer: FirstLayerThemeMinimal,
2022
+ secondLayer: SecondLayerThemeMinimal
2023
+ });
2024
+ /** Banner into modal theme configuration (full scope) */
1805
2025
  const ThemeConfigurationBannerIntoModal = t.intersection([SharedTopLevelTheme, t.type({
1806
2026
  firstLayer: FirstLayerTheme,
1807
2027
  secondLayer: SecondLayerTheme
1808
2028
  })]);
1809
- /** Union of all theme configurations */
2029
+ /** Union of all reduced-scope theme configurations */
2030
+ const ThemeConfigurationMinimal = t.union([
2031
+ ThemeConfigurationBannerOnlyMinimal,
2032
+ ThemeConfigurationModalOnlyMinimal,
2033
+ ThemeConfigurationBannerIntoModalMinimal
2034
+ ]);
2035
+ /** Union of all full-scope theme configurations */
1810
2036
  const ThemeConfiguration = t.union([
1811
2037
  ThemeConfigurationBannerOnly,
1812
2038
  ThemeConfigurationModalOnly,
@@ -1834,7 +2060,9 @@ const SemicolonDelimitedRegimeKeyString = t.string;
1834
2060
  * Autofocus toggle values ("on" / "off").
1835
2061
  */
1836
2062
  const AutofocusToggle = makeEnum({
2063
+ /** Enable autofocus */
1837
2064
  On: "on",
2065
+ /** Disable autofocus */
1838
2066
  Off: "off"
1839
2067
  });
1840
2068
  /**
@@ -1847,8 +2075,11 @@ const AutofocusValues = t.union([valuesOf(AutofocusToggle), DOMElementId]);
1847
2075
  * Shadow root options ("open" / "closed" / "none").
1848
2076
  */
1849
2077
  const ShadowRootOptions = makeEnum({
2078
+ /** Enable shadow root */
1850
2079
  Open: "open",
2080
+ /** Disable shadow root */
1851
2081
  Closed: "closed",
2082
+ /** Disable shadow root */
1852
2083
  None: "none"
1853
2084
  });
1854
2085
  /** The top-level configuration for the consent UI */
@@ -1857,6 +2088,7 @@ const LoadOptions = t.intersection([t.type({
1857
2088
  regimeAutoPromptMap: t.record(RegimeKey, t.boolean),
1858
2089
  variantConfigMap: t.record(VariantKey, UIConfiguration),
1859
2090
  variantThemeMap: t.record(VariantKey, ThemeKey),
2091
+ themeConfigMap: t.record(ThemeKey, t.union([ThemeConfiguration, ThemeConfigurationMinimal])),
1860
2092
  autofocus: AutofocusValues,
1861
2093
  uiZIndex: IntegerString,
1862
2094
  messageFolder: AbsoluteUrlString,
@@ -1939,15 +2171,23 @@ const ConfidenceLabel = makeEnum({
1939
2171
  });
1940
2172
  /** The approval status of the category guess for a subdatapoint */
1941
2173
  const SubDataPointDataSubCategoryGuessStatus = makeEnum({
2174
+ /** The guess has been approved as valid */
1942
2175
  Approved: "APPROVED",
2176
+ /** The guess is pending review */
1943
2177
  Pending: "PENDING",
2178
+ /** The guess has been marked as wrong */
1944
2179
  Rejected: "REJECTED"
1945
2180
  });
1946
2181
  const UnstructuredSubDataPointRecommendationStatus = makeEnum({
2182
+ /** The category was manually applied */
1947
2183
  ManuallyAdded: "MANUALLY_ADDED",
2184
+ /** The recommendation has been corrected */
1948
2185
  Corrected: "CORRECTED",
2186
+ /** The recommendation has been approved as valid */
1949
2187
  Validated: "VALIDATED",
2188
+ /** The recommendation is has been made but not validated */
1950
2189
  Classified: "CLASSIFIED",
2190
+ /** The recommendation has been marked as wrong */
1951
2191
  Rejected: "REJECTED"
1952
2192
  });
1953
2193
  /**
@@ -1959,16 +2199,24 @@ const TableEncryptionType = makeEnum({
1959
2199
  EncryptedByDataAtRest: "ENCRYPTED_DATA_AT_REST"
1960
2200
  });
1961
2201
  const Controllership = makeEnum({
2202
+ /** The current organization is a controller of the data */
1962
2203
  Controller: "CONTROLLER",
2204
+ /** The current organization is a processor of the data */
1963
2205
  Processor: "PROCESSOR",
2206
+ /** The current organization is a joint controller of the data */
1964
2207
  JointController: "JOINT_CONTROLLER"
1965
2208
  });
1966
2209
  /** The type of retention schedule for personal data */
1967
2210
  const RetentionType = makeEnum({
2211
+ /** Collected user information is deleted, anonymized or aggregated after a specific time period */
1968
2212
  StatedPeriod: "STATED_PERIOD",
2213
+ /** Data is deleted, anonymized, or aggregated at some point, but no specific retention period is stated */
1969
2214
  Limited: "LIMITED",
2215
+ /** Collected user information is retained indefinitely */
1970
2216
  Indefinite: "INDEFINITE",
2217
+ /** A specific retention type not covered above */
1971
2218
  Other: "OTHER",
2219
+ /** Retention period is not stated or unclear */
1972
2220
  Unspecified: "UNSPECIFIED"
1973
2221
  });
1974
2222
  //#endregion
@@ -1977,7 +2225,9 @@ const RetentionType = makeEnum({
1977
2225
  * An identifier that can be used to communication with the data subject, also implies that the identifier is transcend supported
1978
2226
  */
1979
2227
  const CommunicationIdentifierType = makeEnum({
2228
+ /** An email address */
1980
2229
  Email: "email",
2230
+ /** A phone number */
1981
2231
  Phone: "phone"
1982
2232
  });
1983
2233
  /**
@@ -1985,35 +2235,84 @@ const CommunicationIdentifierType = makeEnum({
1985
2235
  */
1986
2236
  const IdentifierType = makeEnum({
1987
2237
  ...CommunicationIdentifierType,
2238
+ /** The core id of the organization (usually provided through login) */
1988
2239
  CoreIdentifier: "coreIdentifier",
2240
+ /** A custom identifier */
1989
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
+ */
1990
2248
  Gaid: "gaid",
2249
+ /** Apple ios mobile identifier */
1991
2250
  Idfa: "idfa",
2251
+ /**
2252
+ * The Identifier for Vendors
2253
+ *
2254
+ * @see https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor
2255
+ */
1992
2256
  Idfv: "idfv",
1993
2257
  BrowserId: "browserId",
2258
+ /** Microsoft Advertising Id */
1994
2259
  MicrosoftAdvertisingId: "microsoftAdvertisingId",
2260
+ /** Amazon fire Advertising Id */
1995
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
+ */
1996
2267
  Rida: "rida",
2268
+ /** The handle for the filestack file */
1997
2269
  FilestackHandle: "filestackHandle",
2270
+ /** An ID for a stripe user */
1998
2271
  StripeId: "stripeId",
2272
+ /** The ID used to key braintree customer */
1999
2273
  BraintreeCustomerId: "braintreeCustomerId",
2274
+ /** An ID for a chargebee user */
2000
2275
  ChargebeeId: "chargebeeId",
2276
+ /** An ID for a Thrive TRM contact */
2001
2277
  thriveTrmContactId: "thriveTrmContactId",
2278
+ /** Talkable uuid */
2002
2279
  TalkableUUID: "talkableUUID",
2280
+ /** Recurly site account ID */
2003
2281
  RecurlyId: "recurlyId",
2282
+ /** The customer.io ID - also known as cio_id */
2004
2283
  customerIoId: "customerIoId",
2284
+ /** The visitorId for the Sprig integration */
2005
2285
  sprigVisitorId: "sprigVisitorId",
2286
+ /** URL of a LinkedIn profile */
2006
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
+ */
2007
2292
  AdvertisingId: "advertisingId",
2293
+ /** An ID for a Persona account */
2008
2294
  PersonaReferenceId: "personaReferenceId",
2295
+ /** An ID for a Stream user */
2009
2296
  StreamUserId: "streamUserId",
2297
+ /** A token used to make API calls on behalf of a Plaid account. */
2010
2298
  PlaidProcessorToken: "plaidProcessorToken",
2299
+ /** An ID for an applicant on Onfido */
2011
2300
  OnfidoApplicantId: "onfidoApplicantId",
2301
+ /** Custom ID for a Vero user */
2012
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 */
2013
2308
  AdobeAdvertisingCloudId: "adobeAdvertisingCloudId",
2309
+ /** Adobe Audience Manager UUID */
2014
2310
  AdobeAudienceManagerId: "adobeAudienceManagerId",
2311
+ /** Adobe Experience Cloud ID */
2015
2312
  AdobeExperienceCloudId: "adobeExperienceCloudId",
2313
+ /** Adobe Target ID */
2016
2314
  AdobeTargetID: "adobeTargetId",
2315
+ /** The special Transcend identifier on consent preference records */
2017
2316
  Transcend: "transcend"
2018
2317
  });
2019
2318
  //#endregion
@@ -2023,22 +2322,35 @@ const IdentifierType = makeEnum({
2023
2322
  * and return arbitrary outputs
2024
2323
  */
2025
2324
  const CustomEnricherType = makeEnum({
2325
+ /** Notify a server to enrich the variable */
2026
2326
  Server: "SERVER",
2327
+ /** Notify a person to enrich the value */
2027
2328
  Person: "PERSON",
2329
+ /** Check the legal hold list for that enricher type */
2028
2330
  LegalHold: "LEGAL_HOLD",
2331
+ /** Auto approve a specific identifier in a specific situation */
2029
2332
  AutoApprove: "AUTO_APPROVE",
2333
+ /** Test an identifier using a regex */
2030
2334
  RegexMatch: "REGEX_MATCH",
2335
+ /** Perform conditional logic based on region */
2031
2336
  RegionMatcher: "REGION_MATCH",
2337
+ /** Execute an SQL query against a database */
2032
2338
  Database: "DATABASE",
2339
+ /** Execute a look in looker to map identifiers */
2033
2340
  Looker: "LOOKER",
2341
+ /** Adds an enricher dependency */
2034
2342
  WaitPeriod: "WAIT_PERIOD",
2343
+ /** Verify a government ID */
2035
2344
  GovernmentId: "GOVERNMENT_ID",
2345
+ /** Custom Function enricher type. */
2036
2346
  CustomFunction: "CUSTOM_FUNCTION"
2037
2347
  });
2038
2348
  /**
2039
2349
  * Enrichers that can only be used to initialize the beginning of a DSR
2040
2350
  */
2041
- const InitEnricherType = makeEnum({ Sombra: "SOMBRA" });
2351
+ const InitEnricherType = makeEnum({
2352
+ /** Sombra has the capability */
2353
+ Sombra: "SOMBRA" });
2042
2354
  /**
2043
2355
  * The various types of identity enrichers supported by transcend
2044
2356
  */
@@ -28018,20 +28330,35 @@ const DatabaseVariables = t.record(t.string, t.union([
28018
28330
  * e.g. INSERT INTO table (id, type) VALUES ('{{requestId}}', '{{requestType}}');
28019
28331
  */
28020
28332
  const DatabaseSqlVariablesForPrivacyRequest = t.intersection([t.type({
28333
+ /** The unique UUID for the privacy request */
28021
28334
  requestId: t.string,
28335
+ /** The action type of the privacy request */
28022
28336
  requestType: valuesOf(RequestAction),
28337
+ /** The time that the privacy request was created */
28023
28338
  requestCreatedAt: t.string,
28339
+ /** The language key for the privacy request */
28024
28340
  requestLocale: valuesOf(LOCALE_KEY),
28341
+ /** Additional details provided about the request */
28025
28342
  requestDetails: t.string,
28343
+ /** Whether the request is a test request */
28026
28344
  requestIsTest: t.boolean,
28345
+ /** Origin in which request was made */
28027
28346
  requestOrigin: t.union([t.string, t.null]),
28347
+ /** Slug for type of data subject that made the request */
28028
28348
  requestDataSubjectType: t.string,
28349
+ /** The country code of person that made the request */
28029
28350
  requestCountry: t.union([t.string, t.null]),
28351
+ /** The country sub division code of person that made the request */
28030
28352
  requestCountrySubDivision: t.union([t.string, t.null]),
28353
+ /** Primary email value on request */
28031
28354
  requestPrimaryEmailValue: t.union([t.string, t.null]),
28355
+ /** Slug of consent purpose that triggered the request */
28032
28356
  consentPurposeTriggerSlug: t.union([t.string, t.null]),
28357
+ /** True/false consent value that triggered the request */
28033
28358
  consentPurposeTriggerValue: t.union([t.boolean, t.null]),
28359
+ /** The unique ID of partition that request was for */
28034
28360
  partitionId: t.union([t.string, t.null]),
28361
+ /** The name of partition that request was for */
28035
28362
  partitionName: t.union([t.string, t.null])
28036
28363
  }), DatabaseVariables]);
28037
28364
  //#endregion
@@ -28157,38 +28484,71 @@ const DEFAULT_MACROREGIONS_MAP = { [MacroRegion.EU]: [
28157
28484
  //#region src/objects.ts
28158
28485
  /** The purpose of processing data */
28159
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 */
28160
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 */
28161
28490
  AdditionalFunctionality: "ADDITIONAL_FUNCTIONALITY",
28491
+ /** To show ads that are either targeted to the specific user or not targeted */
28162
28492
  Advertising: "ADVERTISING",
28493
+ /** To contact the user to offer products, services, or other promotions */
28163
28494
  Marketing: "MARKETING",
28495
+ /** For understanding the product’s audience, improving the product, inform company strategy, or general research */
28164
28496
  Analytics: "ANALYTICS",
28497
+ /** For providing user with a personalized experience */
28165
28498
  Personalization: "PERSONALIZATION",
28499
+ /** For product operation and security, enforcement of terms of service, fraud prevention, protecting users and property, etc. */
28166
28500
  OperationSecurity: "OPERATION_SECURITY",
28501
+ /** For compliance with legal obligations */
28167
28502
  Legal: "LEGAL",
28503
+ /** For data that was transferred as part of a change in circumstance (e.g. a merger or acquisition) */
28168
28504
  Transfer: "TRANSFER",
28505
+ /** For selling the data to third parties */
28169
28506
  Sale: "SALE",
28507
+ /** For personnel training, recruitment, payroll, management, etc. */
28170
28508
  HR: "HR",
28509
+ /** Other specific purpose not covered above */
28171
28510
  Other: "OTHER",
28511
+ /** The purpose is not explicitly stated or is unclear */
28172
28512
  Unspecified: "UNSPECIFIED"
28173
28513
  });
28174
28514
  /** The category of personal data that is processed */
28175
28515
  const DataCategoryType = makeEnum({
28516
+ /** Financial information */
28176
28517
  Financial: "FINANCIAL",
28518
+ /** Health information */
28177
28519
  Health: "HEALTH",
28520
+ /** Contact information */
28178
28521
  Contact: "CONTACT",
28522
+ /** Geo-location information */
28179
28523
  Location: "LOCATION",
28524
+ /** Demographic Information */
28180
28525
  Demographic: "DEMOGRAPHIC",
28526
+ /** Identifiers that uniquely identify a person */
28181
28527
  Id: "ID",
28528
+ /** The user's online activities on the first party website/app or other websites/apps */
28182
28529
  OnlineActivity: "ONLINE_ACTIVITY",
28530
+ /** The user’s profile on the first-party website/app and its contents */
28183
28531
  UserProfile: "USER_PROFILE",
28532
+ /** User profile and data from a social media website/app or other third party service */
28184
28533
  SocialMedia: "SOCIAL_MEDIA",
28534
+ /** Connection information for the current browsing session, e.g. device IDs, MAC addresses, IP addresses, etc. */
28185
28535
  Connection: "CONNECTION",
28536
+ /** Cookies and tracking elements */
28186
28537
  Tracking: "TRACKING",
28538
+ /** Computer or device information */
28187
28539
  Device: "DEVICE",
28540
+ /** Any data that is collected through surveys */
28188
28541
  Survey: "SURVEY",
28542
+ /** A specific type of information not covered by the above categories */
28189
28543
  Other: "OTHER",
28544
+ /** The type of information is not explicitly stated or unclear */
28190
28545
  Unspecified: "UNSPECIFIED",
28546
+ /** Information that is NOT personal data */
28191
28547
  NotPersonalData: "NOT_PERSONAL_DATA",
28548
+ /**
28549
+ * Information identifying an object associated with a particular integration.
28550
+ * For example, Salesforce Object Ids.
28551
+ */
28192
28552
  IntegrationIdentifier: "INTEGRATION_IDENTIFIER"
28193
28553
  });
28194
28554
  //#endregion
@@ -28605,210 +28965,210 @@ let OneTrustAssessmentCsvHeader = /* @__PURE__ */ function(OneTrustAssessmentCsv
28605
28965
  const OneTrustAssessmentCsvRecord = t.record(
28606
28966
  /** The keys found in the OneTrust CSV header */
28607
28967
  t.keyof({
28608
- [OneTrustAssessmentCsvHeader.AssessmentId]: null,
28609
- [OneTrustAssessmentCsvHeader.CreateDt]: null,
28610
- [OneTrustAssessmentCsvHeader.InherentRiskScore]: null,
28611
- [OneTrustAssessmentCsvHeader.LastUpdated]: null,
28612
- [OneTrustAssessmentCsvHeader.Name]: null,
28613
- [OneTrustAssessmentCsvHeader.Number]: null,
28614
- [OneTrustAssessmentCsvHeader.OpenRiskCount]: null,
28615
- [OneTrustAssessmentCsvHeader.OrgGroupName]: null,
28616
- [OneTrustAssessmentCsvHeader.PrimaryInventoryDetails_PrimaryInventoryId]: null,
28617
- [OneTrustAssessmentCsvHeader.PrimaryInventoryDetails_PrimaryInventoryName]: null,
28618
- [OneTrustAssessmentCsvHeader.PrimaryInventoryDetails_PrimaryInventoryNumber]: null,
28619
- [OneTrustAssessmentCsvHeader.ResidualRiskScore]: null,
28620
- [OneTrustAssessmentCsvHeader.Result]: null,
28621
- [OneTrustAssessmentCsvHeader.ResultId]: null,
28622
- [OneTrustAssessmentCsvHeader.ResultName]: null,
28623
- [OneTrustAssessmentCsvHeader.State]: null,
28624
- [OneTrustAssessmentCsvHeader.Tags]: null,
28625
- [OneTrustAssessmentCsvHeader.TargetRiskScore]: null,
28626
- [OneTrustAssessmentCsvHeader.TemplateId]: null,
28627
- [OneTrustAssessmentCsvHeader.TemplateName]: null,
28628
- [OneTrustAssessmentCsvHeader.TemplateRootVersionId]: null,
28629
- [OneTrustAssessmentCsvHeader.AssessmentNumber]: null,
28630
- [OneTrustAssessmentCsvHeader.CompletedOn]: null,
28631
- [OneTrustAssessmentCsvHeader.Status]: null,
28632
- [OneTrustAssessmentCsvHeader.CreatedBy_Id]: null,
28633
- [OneTrustAssessmentCsvHeader.CreatedBy_Name]: null,
28634
- [OneTrustAssessmentCsvHeader.CreatedBy_NameKey]: null,
28635
- [OneTrustAssessmentCsvHeader.CreatedDT]: null,
28636
- [OneTrustAssessmentCsvHeader.Deadline]: null,
28637
- [OneTrustAssessmentCsvHeader.Description]: null,
28638
- [OneTrustAssessmentCsvHeader.LowRisk]: null,
28639
- [OneTrustAssessmentCsvHeader.MediumRisk]: null,
28640
- [OneTrustAssessmentCsvHeader.HighRisk]: null,
28641
- [OneTrustAssessmentCsvHeader.OrgGroup_Id]: null,
28642
- [OneTrustAssessmentCsvHeader.OrgGroup_Name]: null,
28643
- [OneTrustAssessmentCsvHeader.OrgGroup_NameKey]: null,
28644
- [OneTrustAssessmentCsvHeader.PrimaryRecordType]: null,
28645
- [OneTrustAssessmentCsvHeader.RiskLevel]: null,
28646
- [OneTrustAssessmentCsvHeader.SubmittedOn]: null,
28647
- [OneTrustAssessmentCsvHeader.Template_Id]: null,
28648
- [OneTrustAssessmentCsvHeader.Template_Name]: null,
28649
- [OneTrustAssessmentCsvHeader.Template_NameKey]: null,
28650
- [OneTrustAssessmentCsvHeader.TotalRiskCount]: null,
28651
- [OneTrustAssessmentCsvHeader.VeryHighRisk]: null,
28652
- [OneTrustAssessmentCsvHeader.WelcomeText]: null,
28653
- [OneTrustAssessmentCsvHeader.Approvers_Id]: null,
28654
- [OneTrustAssessmentCsvHeader.Approvers_WorkflowStageId]: null,
28655
- [OneTrustAssessmentCsvHeader.Approvers_Name]: null,
28656
- [OneTrustAssessmentCsvHeader.Approvers_Approver_Id]: null,
28657
- [OneTrustAssessmentCsvHeader.Approvers_Approver_FullName]: null,
28658
- [OneTrustAssessmentCsvHeader.Approvers_Approver_Email]: null,
28659
- [OneTrustAssessmentCsvHeader.Approvers_Approver_Deleted]: null,
28660
- [OneTrustAssessmentCsvHeader.Approvers_Approver_AssigneeType]: null,
28661
- [OneTrustAssessmentCsvHeader.Approvers_ApprovalState]: null,
28662
- [OneTrustAssessmentCsvHeader.Approvers_ApprovedOn]: null,
28663
- [OneTrustAssessmentCsvHeader.Approvers_ResultId]: null,
28664
- [OneTrustAssessmentCsvHeader.Approvers_ResultName]: null,
28665
- [OneTrustAssessmentCsvHeader.Approvers_ResultNameKey]: null,
28666
- [OneTrustAssessmentCsvHeader.Respondents_Id]: null,
28667
- [OneTrustAssessmentCsvHeader.Respondents_Name]: null,
28668
- [OneTrustAssessmentCsvHeader.Respondents_NameKey]: null,
28669
- [OneTrustAssessmentCsvHeader.PrimaryEntityDetails_Id]: null,
28670
- [OneTrustAssessmentCsvHeader.PrimaryEntityDetails_Name]: null,
28671
- [OneTrustAssessmentCsvHeader.PrimaryEntityDetails_Number]: null,
28672
- [OneTrustAssessmentCsvHeader.PrimaryEntityDetails_DisplayName]: null,
28673
- [OneTrustAssessmentCsvHeader.PrimaryEntityDetails_RelationshipResponseDetails]: null,
28674
- [OneTrustAssessmentCsvHeader.PrimaryEntityDetails_EntityBusinessKey]: null,
28675
- [OneTrustAssessmentCsvHeader.Sections_HasNavigationRules]: null,
28676
- [OneTrustAssessmentCsvHeader.Sections_SubmittedBy_Id]: null,
28677
- [OneTrustAssessmentCsvHeader.Sections_SubmittedBy_Name]: null,
28678
- [OneTrustAssessmentCsvHeader.Sections_SubmittedBy_NameKey]: null,
28679
- [OneTrustAssessmentCsvHeader.Sections_SubmittedDt]: null,
28680
- [OneTrustAssessmentCsvHeader.Sections_Name]: null,
28681
- [OneTrustAssessmentCsvHeader.Sections_Hidden]: null,
28682
- [OneTrustAssessmentCsvHeader.Sections_Valid]: null,
28683
- [OneTrustAssessmentCsvHeader.Sections_SectionId]: null,
28684
- [OneTrustAssessmentCsvHeader.Sections_Sequence]: null,
28685
- [OneTrustAssessmentCsvHeader.Sections_Submitted]: null,
28686
- [OneTrustAssessmentCsvHeader.Sections_Description]: null,
28687
- [OneTrustAssessmentCsvHeader.Sections_Status]: null,
28688
- [OneTrustAssessmentCsvHeader.Sections_OpenNMIQuestionIds]: null,
28689
- [OneTrustAssessmentCsvHeader.Sections_InvalidQuestionIds]: null,
28690
- [OneTrustAssessmentCsvHeader.Sections_RequiredUnansweredQuestionIds]: null,
28691
- [OneTrustAssessmentCsvHeader.Sections_RequiredQuestionIds]: null,
28692
- [OneTrustAssessmentCsvHeader.Sections_UnansweredQuestionIds]: null,
28693
- [OneTrustAssessmentCsvHeader.Sections_EffectivenessQuestionIds]: null,
28694
- [OneTrustAssessmentCsvHeader.Sections_NameKey]: null,
28695
- [OneTrustAssessmentCsvHeader.Sections_RiskStatistics_MaxRiskLevel]: null,
28696
- [OneTrustAssessmentCsvHeader.Sections_RiskStatistics_RiskCount]: null,
28697
- [OneTrustAssessmentCsvHeader.Sections_RiskStatistics_SectionId]: null,
28698
- [OneTrustAssessmentCsvHeader.Sections_Questions_Hidden]: null,
28699
- [OneTrustAssessmentCsvHeader.Sections_Questions_LockReason]: null,
28700
- [OneTrustAssessmentCsvHeader.Sections_Questions_CopyErrors]: null,
28701
- [OneTrustAssessmentCsvHeader.Sections_Questions_HasNavigationRules]: null,
28702
- [OneTrustAssessmentCsvHeader.Sections_Questions_RootRequestInformationIds]: null,
28703
- [OneTrustAssessmentCsvHeader.Sections_Questions_TotalAttachments]: null,
28704
- [OneTrustAssessmentCsvHeader.Sections_Questions_AttachmentIds]: null,
28705
- [OneTrustAssessmentCsvHeader.Sections_Questions_CanReopenWithAllowEditOption]: null,
28706
- [OneTrustAssessmentCsvHeader.Sections_Questions_RiskCreationAllowed]: null,
28707
- [OneTrustAssessmentCsvHeader.Sections_Questions_RiskDeletionPopupAllowed]: null,
28708
- [OneTrustAssessmentCsvHeader.Sections_Questions_AllowMaturityScaleOnQuestions]: null,
28709
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionAssociations]: null,
28710
- [OneTrustAssessmentCsvHeader.Sections_Questions_Issues]: null,
28711
- [OneTrustAssessmentCsvHeader.Sections_Questions_ResponseEditableWhileUnderReview]: null,
28712
- [OneTrustAssessmentCsvHeader.Sections_Questions_BusinessKeyReference]: null,
28713
- [OneTrustAssessmentCsvHeader.Sections_Questions_Topic]: null,
28714
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionLaws]: null,
28715
- [OneTrustAssessmentCsvHeader.Sections_Questions_AttachmentRequired]: null,
28716
- [OneTrustAssessmentCsvHeader.Sections_Questions_ResponseFilter]: null,
28717
- [OneTrustAssessmentCsvHeader.Sections_Questions_LinkAssessmentToResponseEntity]: null,
28718
- [OneTrustAssessmentCsvHeader.Sections_Questions_TranslationIdentifier]: null,
28719
- [OneTrustAssessmentCsvHeader.Sections_Questions_ReadOnly]: null,
28720
- [OneTrustAssessmentCsvHeader.Sections_Questions_Schema]: null,
28721
- [OneTrustAssessmentCsvHeader.Sections_Questions_AttributeId]: null,
28722
- [OneTrustAssessmentCsvHeader.Sections_Questions_VendorQuestion]: null,
28723
- [OneTrustAssessmentCsvHeader.Sections_Questions_Seeded]: null,
28724
- [OneTrustAssessmentCsvHeader.Sections_Questions_AllowJustification]: null,
28725
- [OneTrustAssessmentCsvHeader.Sections_Questions_AssetQuestion]: null,
28726
- [OneTrustAssessmentCsvHeader.Sections_Questions_EntityQuestion]: null,
28727
- [OneTrustAssessmentCsvHeader.Sections_Questions_Paquestion]: null,
28728
- [OneTrustAssessmentCsvHeader.Sections_Questions_InventoryTypeEnum]: null,
28729
- [OneTrustAssessmentCsvHeader.Sections_Questions_ForceOther]: null,
28730
- [OneTrustAssessmentCsvHeader.Sections_Questions_IsParentQuestionMultiSelect]: null,
28731
- [OneTrustAssessmentCsvHeader.Sections_Questions_Id]: null,
28732
- [OneTrustAssessmentCsvHeader.Sections_Questions_RootVersionId]: null,
28733
- [OneTrustAssessmentCsvHeader.Sections_Questions_Sequence]: null,
28734
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionType]: null,
28735
- [OneTrustAssessmentCsvHeader.Sections_Questions_Required]: null,
28736
- [OneTrustAssessmentCsvHeader.Sections_Questions_Attributes]: null,
28737
- [OneTrustAssessmentCsvHeader.Sections_Questions_FriendlyName]: null,
28738
- [OneTrustAssessmentCsvHeader.Sections_Questions_Description]: null,
28739
- [OneTrustAssessmentCsvHeader.Sections_Questions_Hint]: null,
28740
- [OneTrustAssessmentCsvHeader.Sections_Questions_ParentQuestionId]: null,
28741
- [OneTrustAssessmentCsvHeader.Sections_Questions_PrePopulateResponse]: null,
28742
- [OneTrustAssessmentCsvHeader.Sections_Questions_LinkAssessmentToInventory]: null,
28743
- [OneTrustAssessmentCsvHeader.Sections_Questions_Valid]: null,
28744
- [OneTrustAssessmentCsvHeader.Sections_Questions_Type]: null,
28745
- [OneTrustAssessmentCsvHeader.Sections_Questions_AllowMultiSelect]: null,
28746
- [OneTrustAssessmentCsvHeader.Sections_Questions_Content]: null,
28747
- [OneTrustAssessmentCsvHeader.Sections_Questions_RequireJustification]: null,
28748
- [OneTrustAssessmentCsvHeader.Sections_Questions_Options_TranslationIdentifier]: null,
28749
- [OneTrustAssessmentCsvHeader.Sections_Questions_Options_Id]: null,
28750
- [OneTrustAssessmentCsvHeader.Sections_Questions_Options_Option]: null,
28751
- [OneTrustAssessmentCsvHeader.Sections_Questions_Options_OptionKey]: null,
28752
- [OneTrustAssessmentCsvHeader.Sections_Questions_Options_Hint]: null,
28753
- [OneTrustAssessmentCsvHeader.Sections_Questions_Options_HintKey]: null,
28754
- [OneTrustAssessmentCsvHeader.Sections_Questions_Options_Score]: null,
28755
- [OneTrustAssessmentCsvHeader.Sections_Questions_Options_PreSelectedOption]: null,
28756
- [OneTrustAssessmentCsvHeader.Sections_Questions_Options_Sequence]: null,
28757
- [OneTrustAssessmentCsvHeader.Sections_Questions_Options_Attributes]: null,
28758
- [OneTrustAssessmentCsvHeader.Sections_Questions_Options_OptionType]: null,
28759
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_QuestionId]: null,
28760
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_RiskId]: null,
28761
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Level]: null,
28762
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Score]: null,
28763
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Probability]: null,
28764
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_ImpactLevel]: null,
28765
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Description]: null,
28766
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Name]: null,
28767
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Treatment]: null,
28768
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_TreatmentStatus]: null,
28769
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Type]: null,
28770
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Stage_CurrentStageApprovers]: null,
28771
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Stage_BadgeColor]: null,
28772
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Stage_Id]: null,
28773
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Stage_Name]: null,
28774
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Stage_NameKey]: null,
28775
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_State]: null,
28776
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Result]: null,
28777
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Categories_Seeded]: null,
28778
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Categories_Id]: null,
28779
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Categories_Name]: null,
28780
- [OneTrustAssessmentCsvHeader.Sections_Questions_Risks_Categories_NameKey]: null,
28781
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_MaturityScale]: null,
28782
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_EffectivenessScale]: null,
28783
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_ParentAssessmentDetailId]: null,
28784
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_DisplayLabel]: null,
28785
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_ParentQuestionType]: null,
28786
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_ParentResponseId]: null,
28787
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_IsLocalVersion]: null,
28788
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_RelationshipDisplayInformation]: null,
28789
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_LockReason]: null,
28790
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_ControlResponse]: null,
28791
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_RelationshipResponseDetails]: null,
28792
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_TextRedacted]: null,
28793
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_ResponseMap]: null,
28794
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_ResponseId]: null,
28795
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_Response]: null,
28796
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_ResponseKey]: null,
28797
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_ContractResponse]: null,
28798
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_Type]: null,
28799
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_ResponseSourceType]: null,
28800
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_ErrorCode]: null,
28801
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_Valid]: null,
28802
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_DataSubject_Id]: null,
28803
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_DataSubject_Name]: null,
28804
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_DataSubject_NameKey]: null,
28805
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_DataCategory_Id]: null,
28806
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_DataCategory_Name]: null,
28807
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_DataCategory_NameKey]: null,
28808
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_DataElement_Id]: null,
28809
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_DataElement_Name]: null,
28810
- [OneTrustAssessmentCsvHeader.Sections_Questions_QuestionResponses_DataElement_NameKey]: null,
28811
- [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
28812
29172
  }),
28813
29173
  /** The values of the header */
28814
29174
  t.string
@@ -28820,20 +29180,34 @@ const OneTrustAssessmentCsvRecord = t.record(
28820
29180
  * Return types of the "Get List of Assessments" endpoint
28821
29181
  */
28822
29182
  const OneTrustAssessment = t.type({
29183
+ /** ID of the assessment. */
28823
29184
  assessmentId: t.string,
29185
+ /** Date that the assessment was created. */
28824
29186
  createDt: t.string,
29187
+ /** Overall risk score without considering existing controls. */
28825
29188
  inherentRiskScore: t.union([t.number, t.null]),
29189
+ /** Date and time that the assessment was last updated. */
28826
29190
  lastUpdated: t.string,
29191
+ /** Name of the assessment. */
28827
29192
  name: t.string,
29193
+ /** Number assigned to the assessment. */
28828
29194
  number: t.number,
29195
+ /** Number of risks that are open on the assessment. */
28829
29196
  openRiskCount: t.number,
29197
+ /** Name of the organization group assigned to the assessment. */
28830
29198
  orgGroupName: t.string,
29199
+ /** Details about the inventory record which is the primary record of the assessment. */
28831
29200
  primaryInventoryDetails: t.union([t.type({
29201
+ /** GUID of the inventory record. */
28832
29202
  primaryInventoryId: t.string,
29203
+ /** Name of the inventory record. */
28833
29204
  primaryInventoryName: t.string,
29205
+ /** Integer ID of the inventory record. */
28834
29206
  primaryInventoryNumber: t.number
28835
29207
  }), t.null]),
29208
+ /** Overall risk score after considering existing controls. */
28836
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. */
28837
29211
  result: t.union([
28838
29212
  t.literal("Approved"),
28839
29213
  t.literal("AutoClosed"),
@@ -28841,7 +29215,9 @@ const OneTrustAssessment = t.type({
28841
29215
  t.string,
28842
29216
  t.null
28843
29217
  ]),
29218
+ /** ID of the result. */
28844
29219
  resultId: t.union([t.string, t.null]),
29220
+ /** Name of the result. */
28845
29221
  resultName: t.union([
28846
29222
  t.literal("Approved - Remediation required"),
28847
29223
  t.literal("Approved"),
@@ -28850,7 +29226,9 @@ const OneTrustAssessment = t.type({
28850
29226
  t.string,
28851
29227
  t.null
28852
29228
  ]),
29229
+ /** State of the assessment. */
28853
29230
  state: t.union([t.literal("ARCHIVE"), t.literal("ACTIVE")]),
29231
+ /** Status of the assessment. */
28854
29232
  status: t.union([
28855
29233
  t.literal("Not Started"),
28856
29234
  t.literal("In Progress"),
@@ -28858,18 +29236,29 @@ const OneTrustAssessment = t.type({
28858
29236
  t.literal("Completed"),
28859
29237
  t.null
28860
29238
  ]),
29239
+ /** Name of the tag attached to the assessment. */
28861
29240
  tags: t.array(t.string),
29241
+ /** The desired risk score. */
28862
29242
  targetRiskScore: t.union([t.number, t.null]),
29243
+ /** ID used to launch an assessment using a specific version of a template. */
28863
29244
  templateId: t.string,
29245
+ /** Name of the template that is being used on the assessment. */
28864
29246
  templateName: t.string,
29247
+ /** ID used to launch an assessment using the latest published version of a template. */
28865
29248
  templateRootVersionId: t.string
28866
29249
  });
28867
29250
  const OneTrustGetListOfAssessmentsResponse = t.partial({
29251
+ /** The list of assessments in the current page. */
28868
29252
  content: t.array(OneTrustAssessment),
29253
+ /** Details about the pages being fetched */
28869
29254
  page: t.type({
29255
+ /** Page number of the results list (0…N). */
28870
29256
  number: t.number,
29257
+ /** Number of records per page (0…N). */
28871
29258
  size: t.number,
29259
+ /** Total number of elements. */
28872
29260
  totalElements: t.number,
29261
+ /** Total number of pages. */
28873
29262
  totalPages: t.number
28874
29263
  })
28875
29264
  });
@@ -28880,23 +29269,36 @@ const OneTrustGetListOfAssessmentsResponse = t.partial({
28880
29269
  * Return types of the "Get Assessments" endpoint
28881
29270
  */
28882
29271
  const OneTrustApprover = t.type({
29272
+ /** ID of the user assigned as an approver. */
28883
29273
  id: t.string,
29274
+ /** ID of the workflow stage */
28884
29275
  workflowStageId: t.string,
29276
+ /** Name of the user assigned as an approver. */
28885
29277
  name: t.string,
29278
+ /** More details about the approver */
28886
29279
  approver: t.type({
29280
+ /** ID of the user assigned as an approver. */
28887
29281
  id: t.string,
29282
+ /** Full name of the user assigned as an approver. */
28888
29283
  fullName: t.string,
29284
+ /** Email of the user assigned as an approver. */
28889
29285
  email: t.union([t.string, t.null]),
29286
+ /** Whether the user assigned as an approver was deleted. */
28890
29287
  deleted: t.boolean,
29288
+ /** The assignee type */
28891
29289
  assigneeType: t.union([t.string, t.null])
28892
29290
  }),
29291
+ /** Assessment approval status. */
28893
29292
  approvalState: t.union([
28894
29293
  t.literal("OPEN"),
28895
29294
  t.literal("APPROVED"),
28896
29295
  t.literal("REJECTED")
28897
29296
  ]),
29297
+ /** Date and time at which the assessment was approved. */
28898
29298
  approvedOn: t.union([t.string, t.null]),
29299
+ /** ID of the assessment result. */
28899
29300
  resultId: t.union([t.string, t.null]),
29301
+ /** Name of the assessment result. */
28900
29302
  resultName: t.union([
28901
29303
  t.literal("Approved - Remediation required"),
28902
29304
  t.literal("Approved"),
@@ -28905,6 +29307,7 @@ const OneTrustApprover = t.type({
28905
29307
  t.string,
28906
29308
  t.null
28907
29309
  ]),
29310
+ /** Name key of the assessment result. */
28908
29311
  resultNameKey: t.union([t.string, t.null])
28909
29312
  });
28910
29313
  const OneTrustAssessmentStatus = t.union([
@@ -28914,27 +29317,49 @@ const OneTrustAssessmentStatus = t.union([
28914
29317
  t.literal("COMPLETED")
28915
29318
  ]);
28916
29319
  const OneTrustPrimaryEntityDetails = t.array(t.type({
29320
+ /** Unique ID for the primary record. */
28917
29321
  id: t.string,
29322
+ /** Name of the primary record. */
28918
29323
  name: t.string,
29324
+ /** The number associated with the primary record. */
28919
29325
  number: t.number,
29326
+ /** Name and number of the primary record. */
28920
29327
  displayName: t.string,
29328
+ /** The relationshipResponseDetails */
28921
29329
  relationshipResponseDetails: t.union([t.string, t.null]),
29330
+ /** The entity business key */
28922
29331
  entityBusinessKey: t.union([t.string, t.null])
28923
29332
  }));
28924
29333
  const OneTrustAssessmentSectionSubmittedBy = t.union([t.intersection([t.type({
29334
+ /** The ID of the user who submitted the section */
28925
29335
  id: t.string,
29336
+ /** THe name or email of the user who submitted the section */
28926
29337
  name: t.string
28927
- }), t.partial({ nameKey: t.union([t.string, t.null]) })]), t.null]);
28928
- 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. */
28929
29345
  id: t.string,
29346
+ /** Name of the option. */
28930
29347
  option: t.string,
29348
+ /** The key of the option */
28931
29349
  optionKey: t.union([t.string, t.null]),
29350
+ /** The hint */
28932
29351
  hint: t.union([t.string, t.null]),
29352
+ /** The hint key */
28933
29353
  hintKey: t.union([t.string, t.null]),
29354
+ /** The score */
28934
29355
  score: t.union([t.number, t.null]),
29356
+ /** If the option was pre-selected */
28935
29357
  preSelectedOption: t.boolean,
29358
+ /** Order in which the option appears. */
28936
29359
  sequence: t.union([t.number, t.null]),
29360
+ /** Attribute for which the option is available. */
28937
29361
  attributes: t.union([t.string, t.null]),
29362
+ /** Type of option. */
28938
29363
  optionType: t.union([
28939
29364
  t.literal("NOT_SURE"),
28940
29365
  t.literal("NOT_APPLICABLE"),
@@ -28943,49 +29368,86 @@ const OneTrustAssessmentQuestionOption = t.intersection([t.partial({ translation
28943
29368
  ])
28944
29369
  })]);
28945
29370
  const OneTrustAssessmentNestedQuestion = t.type({
29371
+ /** ID of the question. */
28946
29372
  id: t.string,
29373
+ /** ID of the root version of the question. */
28947
29374
  rootVersionId: t.string,
29375
+ /** Order in which the question appears in the assessment. */
28948
29376
  sequence: t.number,
29377
+ /** Type of question in the assessment. */
28949
29378
  questionType: t.union([t.string, t.null]),
29379
+ /** Indicates whether a response to the question is required. */
28950
29380
  required: t.boolean,
29381
+ /** Data element attributes that are directly updated by the question. */
28951
29382
  attributes: t.string,
29383
+ /** Short, descriptive name for the question. */
28952
29384
  friendlyName: t.union([t.string, t.null]),
29385
+ /** Description of the question. */
28953
29386
  description: t.union([t.string, t.null]),
29387
+ /** Tooltip text within a hint for the question. */
28954
29388
  hint: t.union([t.string, t.null]),
29389
+ /** ID of the parent question. */
28955
29390
  parentQuestionId: t.union([t.string, t.null]),
29391
+ /** Indicates whether the response to the question is prepopulated. */
28956
29392
  prePopulateResponse: t.boolean,
29393
+ /** Indicates whether the assessment is linked to inventory records. */
28957
29394
  linkAssessmentToInventory: t.boolean,
29395
+ /** The question options */
28958
29396
  options: t.union([t.array(OneTrustAssessmentQuestionOption), t.null]),
29397
+ /** Indicates whether the question is valid. */
28959
29398
  valid: t.boolean,
29399
+ /** Type of question in the assessment. */
28960
29400
  type: t.union([t.string, t.null]),
29401
+ /** Whether the response can be multi select */
28961
29402
  allowMultiSelect: t.boolean,
29403
+ /** The text of a question. */
28962
29404
  content: t.string,
29405
+ /** Indicates whether justification comments are required for the question. */
28963
29406
  requireJustification: t.boolean,
29407
+ /** The attachmentRequired */
28964
29408
  attachmentRequired: t.boolean
28965
29409
  });
28966
29410
  const OneTrustAssessmentResponses = t.array(t.intersection([t.partial({
29411
+ /** The response maturityScale */
28967
29412
  maturityScale: t.union([t.string, t.null]),
29413
+ /** The response effectivenessScale */
28968
29414
  effectivenessScale: t.union([t.string, t.null]),
29415
+ /** The response parentAssessmentDetailId */
28969
29416
  parentAssessmentDetailId: t.union([t.string, t.null]),
29417
+ /** The response display label */
28970
29418
  displayLabel: t.string,
29419
+ /** The response type of the parent question */
28971
29420
  parentQuestionType: t.string,
29421
+ /** The response ID of the parent response */
28972
29422
  parentResponseId: t.string,
29423
+ /** Whether it's local version */
28973
29424
  isLocalVersion: t.string,
29425
+ /** Whether relationshipDisplayInformation */
28974
29426
  relationshipDisplayInformation: t.union([t.string, t.null]),
29427
+ /** The response lock reason */
28975
29428
  lockReason: t.union([t.string, t.null])
28976
29429
  }), t.type({
29430
+ /** The controlResponse */
28977
29431
  controlResponse: t.union([
28978
29432
  t.string,
28979
29433
  t.object,
28980
29434
  t.null
28981
29435
  ]),
29436
+ /** The relationshipResponseDetails */
28982
29437
  relationshipResponseDetails: t.array(t.string),
29438
+ /** The textRedacted */
28983
29439
  textRedacted: t.boolean,
29440
+ /** The responseMap */
28984
29441
  responseMap: t.object,
29442
+ /** ID of the response. */
28985
29443
  responseId: t.string,
29444
+ /** Content of the response. */
28986
29445
  response: t.union([t.string, t.null]),
29446
+ /** The response key */
28987
29447
  responseKey: t.union([t.string, t.null]),
29448
+ /** The response key */
28988
29449
  contractResponse: t.union([t.string, t.null]),
29450
+ /** Type of response. */
28989
29451
  type: t.union([
28990
29452
  t.literal("NOT_SURE"),
28991
29453
  t.literal("JUSTIFICATION"),
@@ -28993,7 +29455,9 @@ const OneTrustAssessmentResponses = t.array(t.intersection([t.partial({
28993
29455
  t.literal("DEFAULT"),
28994
29456
  t.literal("OTHERS")
28995
29457
  ]),
29458
+ /** Source from which the assessment is launched. */
28996
29459
  responseSourceType: t.union([t.string, t.null]),
29460
+ /** Error associated with the response. */
28997
29461
  errorCode: t.union([
28998
29462
  t.literal("ATTRIBUTE_DISABLED"),
28999
29463
  t.literal("ATTRIBUTE_OPTION_DISABLED"),
@@ -29003,149 +29467,273 @@ const OneTrustAssessmentResponses = t.array(t.intersection([t.partial({
29003
29467
  t.literal("DUPLICATE_INVENTORY"),
29004
29468
  t.null
29005
29469
  ]),
29470
+ /** Indicates whether the response is valid. */
29006
29471
  valid: t.boolean,
29472
+ /** The data subject */
29007
29473
  dataSubject: t.union([t.type({
29474
+ /** The ID of the data subject */
29008
29475
  id: t.union([t.string, t.null]),
29476
+ /** The ID of the data subject */
29009
29477
  name: t.union([t.string, t.null]),
29478
+ /** The nameKey of the data category */
29010
29479
  nameKey: t.union([t.string, t.null])
29011
29480
  }), t.null]),
29481
+ /** The data category */
29012
29482
  dataCategory: t.union([t.type({
29483
+ /** The ID of the data category */
29013
29484
  id: t.union([t.string, t.null]),
29485
+ /** The name of the data category */
29014
29486
  name: t.union([t.string, t.null]),
29487
+ /** The nameKey of the data category */
29015
29488
  nameKey: t.union([t.string, t.null])
29016
29489
  }), t.null]),
29490
+ /** The data element */
29017
29491
  dataElement: t.union([t.type({
29492
+ /** The ID of the data element */
29018
29493
  id: t.union([t.string, t.null]),
29494
+ /** The name of the data element */
29019
29495
  name: t.union([t.string, t.null]),
29496
+ /** The name key of the data element */
29020
29497
  nameKey: t.union([t.string, t.null])
29021
29498
  }), t.null])
29022
29499
  })]));
29023
29500
  const OneTrustAssessmentQuestionResponses = t.array(t.type({
29501
+ /** The responses */
29024
29502
  responses: OneTrustAssessmentResponses,
29503
+ /** Justification comments for the given response. */
29025
29504
  justification: t.union([t.string, t.null])
29026
29505
  }));
29027
29506
  const OneTrustAssessmentQuestionRisk = t.intersection([t.type({
29507
+ /** ID of the question for which the risk was flagged. */
29028
29508
  questionId: t.string,
29509
+ /** ID of the flagged risk. */
29029
29510
  riskId: t.string
29030
29511
  }), t.partial({
29512
+ /** Level of risk flagged on the question. */
29031
29513
  level: t.union([t.number, t.null]),
29514
+ /** Score of risk flagged on the question. */
29032
29515
  score: t.union([t.number, t.null]),
29516
+ /** Probability of risk flagged on the question. */
29033
29517
  probability: t.union([t.number, t.undefined]),
29518
+ /** Impact Level of risk flagged on the question. */
29034
29519
  impactLevel: t.union([t.number, t.undefined])
29035
29520
  })]);
29036
29521
  const OneTrustAssessmentQuestion = t.intersection([t.type({
29522
+ /** The question */
29037
29523
  question: OneTrustAssessmentNestedQuestion,
29524
+ /** Indicates whether the question is hidden on the assessment. */
29038
29525
  hidden: t.boolean,
29526
+ /** Reason for locking the question in the assessment. */
29039
29527
  lockReason: t.union([t.string, t.null]),
29528
+ /** The copy errors */
29040
29529
  copyErrors: t.union([t.string, t.null]),
29530
+ /** Indicates whether navigation rules are enabled for the question. */
29041
29531
  hasNavigationRules: t.boolean,
29532
+ /** The responses to this question */
29042
29533
  questionResponses: OneTrustAssessmentQuestionResponses,
29534
+ /** The risks associated with this question */
29043
29535
  risks: t.union([t.array(OneTrustAssessmentQuestionRisk), t.null]),
29536
+ /** List of IDs associated with the question root requests. */
29044
29537
  rootRequestInformationIds: t.array(t.string),
29538
+ /** Number of attachments added to the question. */
29045
29539
  totalAttachments: t.number,
29540
+ /** IDs of the attachment(s) added to the question. */
29046
29541
  attachmentIds: t.array(t.string),
29542
+ /** The canReopenWithAllowEditOption */
29047
29543
  canReopenWithAllowEditOption: t.boolean,
29544
+ /** The riskCreationAllowed */
29048
29545
  riskCreationAllowed: t.boolean,
29546
+ /** The riskDeletionPopupAllowed */
29049
29547
  riskDeletionPopupAllowed: t.boolean,
29548
+ /** The allowMaturityScaleOnQuestions */
29050
29549
  allowMaturityScaleOnQuestions: t.boolean,
29550
+ /** The questionAssociations */
29051
29551
  questionAssociations: t.union([t.string, t.null]),
29552
+ /** The issues */
29052
29553
  issues: t.union([t.string, t.null]),
29554
+ /** The responseEditableWhileUnderReview */
29053
29555
  responseEditableWhileUnderReview: t.boolean
29054
29556
  }), t.partial({
29557
+ /** The businessKeyReference */
29055
29558
  businessKeyReference: t.union([t.string, t.null]),
29559
+ /** The topic */
29056
29560
  topic: t.union([t.string, t.null]),
29561
+ /** The questionLaws */
29057
29562
  questionLaws: t.array(t.string),
29563
+ /** The responseFilter */
29058
29564
  responseFilter: t.union([t.string, t.null]),
29565
+ /** The linkAssessmentToResponseEntity */
29059
29566
  linkAssessmentToResponseEntity: t.boolean,
29567
+ /** The translationIdentifier */
29060
29568
  translationIdentifier: t.string,
29569
+ /** The readOnly */
29061
29570
  readOnly: t.boolean,
29571
+ /** The schema */
29062
29572
  schema: t.union([t.string, t.null]),
29573
+ /** The attributeId */
29063
29574
  attributeId: t.string,
29575
+ /** Whether it is a vendor question */
29064
29576
  vendorQuestion: t.boolean,
29577
+ /** Whether the question was seeded */
29065
29578
  seeded: t.boolean,
29579
+ /** Whether the question allows justification */
29066
29580
  allowJustification: t.boolean,
29581
+ /** Whether it refers to an asset question */
29067
29582
  assetQuestion: t.boolean,
29583
+ /** Whether it refers to an entity question */
29068
29584
  entityQuestion: t.boolean,
29585
+ /** Whether it is a paquestion */
29069
29586
  paquestion: t.boolean,
29587
+ /** The inventoryTypeEnum */
29070
29588
  inventoryTypeEnum: t.union([t.string, t.null]),
29589
+ /** Whether it is a forceOther */
29071
29590
  forceOther: t.boolean,
29591
+ /** Whether it is a isParentQuestionMultiSelect */
29072
29592
  isParentQuestionMultiSelect: t.boolean
29073
29593
  })]);
29074
29594
  const OneTrustAssessmentSectionHeaderRiskStatistics = t.union([t.type({
29595
+ /** Maximum level of risk in the section. */
29075
29596
  maxRiskLevel: t.union([t.number, t.null]),
29597
+ /** Number of risks in the section. */
29076
29598
  riskCount: t.union([t.number, t.null]),
29599
+ /** ID of the section in the assessment. */
29077
29600
  sectionId: t.union([t.string, t.null])
29078
29601
  }), t.null]);
29079
29602
  const OneTrustAssessmentSectionHeader = t.intersection([t.type({
29603
+ /** ID of the section in the assessment. */
29080
29604
  sectionId: t.string,
29605
+ /** Name of the section. */
29081
29606
  name: t.string,
29607
+ /** The status of the section */
29082
29608
  status: t.union([t.string, t.null]),
29609
+ /** The openNMIQuestionIds */
29083
29610
  openNMIQuestionIds: t.union([t.string, t.null]),
29611
+ /** Description of the section header. */
29084
29612
  description: t.union([t.string, t.null]),
29613
+ /** Sequence of the section within the form */
29085
29614
  sequence: t.number,
29615
+ /** Indicates whether the section is hidden in the assessment. */
29086
29616
  hidden: t.boolean,
29617
+ /** IDs of invalid questions in the section. */
29087
29618
  invalidQuestionIds: t.array(t.string),
29619
+ /** IDs of required but unanswered questions in the section. */
29088
29620
  requiredUnansweredQuestionIds: t.array(t.string),
29621
+ /** IDs of required questions in the section. */
29089
29622
  requiredQuestionIds: t.array(t.string),
29623
+ /** IDs of unanswered questions in the section. */
29090
29624
  unansweredQuestionIds: t.array(t.string),
29625
+ /** IDs of effectiveness questions in the section. */
29091
29626
  effectivenessQuestionIds: t.array(t.string),
29627
+ /** The risk statistics */
29092
29628
  riskStatistics: OneTrustAssessmentSectionHeaderRiskStatistics,
29629
+ /** Whether the section was submitted */
29093
29630
  submitted: t.boolean
29094
- }), 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]) })]);
29095
29634
  const OneTrustAssessmentSection = t.type({
29635
+ /** The Assessment section header */
29096
29636
  header: OneTrustAssessmentSectionHeader,
29637
+ /** The questions within the section */
29097
29638
  questions: t.array(OneTrustAssessmentQuestion),
29639
+ /** Indicates whether navigation rules are enabled for the question. */
29098
29640
  hasNavigationRules: t.boolean,
29641
+ /** Who submitted the section */
29099
29642
  submittedBy: OneTrustAssessmentSectionSubmittedBy,
29643
+ /** Date of the submission */
29100
29644
  submittedDt: t.union([t.string, t.null]),
29645
+ /** Name of the section. */
29101
29646
  name: t.string,
29647
+ /** Indicates whether navigation rules are enabled for the question. */
29102
29648
  hidden: t.boolean,
29649
+ /** Indicates whether the section is valid. */
29103
29650
  valid: t.boolean,
29651
+ /** ID of the section in an assessment. */
29104
29652
  sectionId: t.string,
29653
+ /** Sequence of the section within the form */
29105
29654
  sequence: t.number,
29655
+ /** Whether the section was submitted */
29106
29656
  submitted: t.boolean,
29657
+ /** Descriptions of the section. */
29107
29658
  description: t.union([t.string, t.null])
29108
29659
  });
29109
29660
  const OneTrustAssessmentCreatedBy = t.type({
29661
+ /** The ID of the creator */
29110
29662
  id: t.string,
29663
+ /** The name of the creator */
29111
29664
  name: t.string,
29665
+ /** The name key of the template */
29112
29666
  nameKey: t.union([t.string, t.null])
29113
29667
  });
29114
29668
  const OneTrustGetAssessmentResponse = t.type({
29669
+ /** List of users assigned as approvers of the assessment. */
29115
29670
  approvers: t.array(OneTrustApprover),
29671
+ /** ID of an assessment. */
29116
29672
  assessmentId: t.string,
29673
+ /** Number assigned to an assessment. */
29117
29674
  assessmentNumber: t.number,
29675
+ /** Date and time at which the assessment was completed. */
29118
29676
  completedOn: t.union([t.string, t.null]),
29677
+ /** Status of the assessment. */
29119
29678
  status: OneTrustAssessmentStatus,
29679
+ /** Creator of the Assessment */
29120
29680
  createdBy: OneTrustAssessmentCreatedBy,
29681
+ /** Date and time at which the assessment was created. */
29121
29682
  createdDT: t.string,
29683
+ /** Date and time by which the assessment must be completed. */
29122
29684
  deadline: t.union([t.string, t.null]),
29685
+ /** Description of the assessment. */
29123
29686
  description: t.union([t.string, t.null]),
29687
+ /** Overall inherent risk score without considering the existing controls. */
29124
29688
  inherentRiskScore: t.union([t.number, t.null]),
29689
+ /** Date and time at which the assessment was last updated. */
29125
29690
  lastUpdated: t.string,
29691
+ /** Number of risks captured on the assessment with a low risk level. */
29126
29692
  lowRisk: t.number,
29693
+ /** Number of risks captured on the assessment with a medium risk level. */
29127
29694
  mediumRisk: t.number,
29695
+ /** Number of risks captured on the assessment with a high risk level. */
29128
29696
  highRisk: t.number,
29697
+ /** Name of the assessment. */
29129
29698
  name: t.string,
29699
+ /** Number of open risks that have not been addressed. */
29130
29700
  openRiskCount: t.number,
29701
+ /** The organization group */
29131
29702
  orgGroup: t.intersection([t.type({
29703
+ /** The ID of the organization group */
29132
29704
  id: t.string,
29705
+ /** The name of the organization group */
29133
29706
  name: t.string
29134
- }), 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 */
29135
29711
  primaryEntityDetails: OneTrustPrimaryEntityDetails,
29712
+ /** Type of inventory record designated as the primary record. */
29136
29713
  primaryRecordType: t.union([t.string, t.null]),
29714
+ /** Overall risk score after considering existing controls. */
29137
29715
  residualRiskScore: t.union([t.number, t.null]),
29716
+ /** The respondent */
29138
29717
  respondent: t.type({
29718
+ /** The ID of the respondent */
29139
29719
  id: t.string,
29720
+ /** The name or email of the respondent */
29140
29721
  name: t.string
29141
29722
  }),
29723
+ /** The respondents */
29142
29724
  respondents: t.array(t.type({
29725
+ /** The ID of the respondent */
29143
29726
  id: t.string,
29727
+ /** The name or email of the respondent */
29144
29728
  name: t.string,
29729
+ /** The name key of the template */
29145
29730
  nameKey: t.union([t.string, t.null])
29146
29731
  })),
29732
+ /** Result of the assessment. */
29147
29733
  result: t.union([t.string, t.null]),
29734
+ /** ID of the result. */
29148
29735
  resultId: t.union([t.string, t.null]),
29736
+ /** Name of the result. */
29149
29737
  resultName: t.union([
29150
29738
  t.literal("Approved - Remediation required"),
29151
29739
  t.literal("Approved"),
@@ -29154,6 +29742,7 @@ const OneTrustGetAssessmentResponse = t.type({
29154
29742
  t.string,
29155
29743
  t.null
29156
29744
  ]),
29745
+ /** Risk level of the assessment. */
29157
29746
  riskLevel: t.union([
29158
29747
  t.literal("None"),
29159
29748
  t.literal("Low"),
@@ -29161,17 +29750,28 @@ const OneTrustGetAssessmentResponse = t.type({
29161
29750
  t.literal("High"),
29162
29751
  t.literal("Very High")
29163
29752
  ]),
29753
+ /** List of sections in the assessment. */
29164
29754
  sections: t.array(OneTrustAssessmentSection),
29755
+ /** Date and time at which the assessment was submitted. */
29165
29756
  submittedOn: t.union([t.string, t.null]),
29757
+ /** List of tags associated with the assessment. */
29166
29758
  tags: t.array(t.string),
29759
+ /** The desired target risk score. */
29167
29760
  targetRiskScore: t.union([t.number, t.null]),
29761
+ /** The template */
29168
29762
  template: t.type({
29763
+ /** The ID of the template */
29169
29764
  id: t.string,
29765
+ /** The name of the template */
29170
29766
  name: t.string,
29767
+ /** The name key of the template */
29171
29768
  nameKey: t.union([t.string, t.null])
29172
29769
  }),
29770
+ /** Number of total risks on the assessment. */
29173
29771
  totalRiskCount: t.number,
29772
+ /** Number of very high risks on the assessment. */
29174
29773
  veryHighRisk: t.number,
29774
+ /** Welcome text if any in the assessment. */
29175
29775
  welcomeText: t.union([t.string, t.null])
29176
29776
  });
29177
29777
  //#endregion
@@ -29181,50 +29781,86 @@ const OneTrustGetAssessmentResponse = t.type({
29181
29781
  * Return types of the "Get Risk" endpoint
29182
29782
  */
29183
29783
  const OneTrustEntityType = t.type({
29784
+ /** Indicates whether entity type is eligible for linking/relating with risk or not */
29184
29785
  eligibleForEntityLink: t.boolean,
29786
+ /** Indicates whether the entity type is enabled or not. */
29185
29787
  enabled: t.boolean,
29788
+ /** Entity Type ID. This can be Assets, Entities, PIA, Engagement, Custom Object GUID in form of String. */
29186
29789
  id: t.string,
29790
+ /** Entity Type Name. */
29187
29791
  label: t.string,
29792
+ /** Name of the module. */
29188
29793
  moduleName: t.union([t.string, t.null]),
29794
+ /** Indicates whether this type can be risk type or not in Risk */
29189
29795
  riskType: t.boolean,
29796
+ /** For Base Entity Type Seeded is true and false for Custom Object/Entity Types by default. */
29190
29797
  seeded: t.boolean,
29798
+ /** Indicates whether this type can be source type or not in Risk */
29191
29799
  sourceType: t.boolean,
29800
+ /** Translation Key of Entity Type ID. */
29192
29801
  translationKey: t.string
29193
29802
  });
29194
29803
  const OneTrustRiskLevel = t.type({
29804
+ /** Risk Impact Level name. */
29195
29805
  impactLevel: t.union([t.string, t.null]),
29806
+ /** Risk Impact level ID. */
29196
29807
  impactLevelId: t.union([t.number, t.null]),
29808
+ /** Risk Level Name. */
29197
29809
  level: t.union([t.string, t.null]),
29810
+ /** Risk Level ID. */
29198
29811
  levelId: t.union([t.number, t.null]),
29812
+ /** Risk Probability Level Name. */
29199
29813
  probabilityLevel: t.union([t.string, t.null]),
29814
+ /** Risk Probability Level ID. */
29200
29815
  probabilityLevelId: t.union([t.number, t.null]),
29816
+ /** Risk Score. */
29201
29817
  riskScore: t.union([t.number, t.null])
29202
29818
  });
29203
- 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. */
29204
29823
  id: t.string,
29824
+ /** Risk Category Name. */
29205
29825
  name: t.string,
29826
+ /** Risk Category Name Key value for translation. */
29206
29827
  nameKey: t.string
29207
29828
  })]));
29208
29829
  const OneTrustRiskReference = t.type({
29830
+ /** The id of the risk reference */
29209
29831
  id: t.string,
29832
+ /** The type of the risk reference */
29210
29833
  type: t.string,
29834
+ /** The reference type of the risk reference */
29211
29835
  referenceType: OneTrustEntityType,
29836
+ /** The name of the risk reference */
29212
29837
  name: t.union([t.string, t.null]),
29838
+ /** The additional attributes of the risk reference */
29213
29839
  additionalAttributes: t.object
29214
29840
  });
29215
29841
  const OneTrustRiskReferences = t.array(OneTrustRiskReference);
29216
29842
  const OneTrustRiskTemplate = t.type({
29843
+ /** The id of the risk template */
29217
29844
  id: t.union([t.string, t.null]),
29845
+ /** The name of the risk template */
29218
29846
  name: t.union([t.string, t.null])
29219
29847
  });
29220
29848
  const OneTrustGetRiskResponse = t.type({
29849
+ /** The risk references */
29221
29850
  references: OneTrustRiskReferences,
29851
+ /** Whether the risk is closed */
29222
29852
  closed: t.boolean,
29853
+ /** The risk template */
29223
29854
  riskTemplate: OneTrustRiskTemplate,
29855
+ /** The currentStageApproversCount */
29224
29856
  currentStageApproversCount: t.number,
29857
+ /** List of associated inventories to the risk. */
29225
29858
  associatedInventories: t.array(t.type({
29859
+ /** ID of the Inventory. */
29226
29860
  inventoryId: t.string,
29861
+ /** Name of the Inventory. */
29227
29862
  inventoryName: t.string,
29863
+ /** Type of the Inventory. */
29228
29864
  inventoryType: t.union([
29229
29865
  t.literal("ASSETS"),
29230
29866
  t.literal("PROCESSING_ACTIVITIES"),
@@ -29232,32 +29868,59 @@ const OneTrustGetRiskResponse = t.type({
29232
29868
  t.literal("ENTITIES"),
29233
29869
  t.null
29234
29870
  ]),
29871
+ /** ID of the Inventory's Organization. */
29235
29872
  organizationId: t.union([t.string, t.null]),
29873
+ /** The source type */
29236
29874
  sourceType: OneTrustEntityType
29237
29875
  })),
29876
+ /** The attribute values associated with the risk */
29238
29877
  attributeValues: t.object,
29878
+ /** List of categories. */
29239
29879
  categories: OneTrustRiskCategories,
29880
+ /** List of Control Identifiers. */
29240
29881
  controlsIdentifier: t.array(t.string),
29882
+ /** Risk created time. */
29241
29883
  createdUTCDateTime: t.union([t.string, t.null]),
29884
+ /** Risk Creation Type. */
29242
29885
  creationType: t.union([t.string, t.null]),
29886
+ /** Date when the risk is closed. */
29243
29887
  dateClosed: t.union([t.string, t.null]),
29888
+ /** Deadline date for the risk. */
29244
29889
  deadline: t.union([t.string, t.null]),
29890
+ /** Risk delete type. */
29245
29891
  deleteType: t.union([t.literal("SOFT"), t.null]),
29892
+ /** Risk description. */
29246
29893
  description: t.union([t.string, t.null]),
29894
+ /** ID of the risk. */
29247
29895
  id: t.string,
29896
+ /** Residual impact level ID. */
29248
29897
  impactLevelId: t.union([t.number, t.null]),
29898
+ /** The inherent risk level */
29249
29899
  inherentRiskLevel: OneTrustRiskLevel,
29900
+ /** The risk justification */
29250
29901
  justification: t.union([t.string, t.null]),
29902
+ /** Residual level display name. */
29251
29903
  levelDisplayName: t.union([t.string, t.null]),
29904
+ /** Residual level ID. */
29252
29905
  levelId: t.union([t.number, t.null]),
29906
+ /** Risk mitigated date. */
29253
29907
  mitigatedDate: t.union([t.string, t.null]),
29908
+ /** Risk Mitigation details. */
29254
29909
  mitigation: t.union([t.string, t.null]),
29910
+ /** Short Name for a Risk. */
29255
29911
  name: t.union([t.string, t.null]),
29912
+ /** Integer risk identifier. */
29256
29913
  number: t.number,
29914
+ /** The organization group */
29257
29915
  orgGroup: t.intersection([t.type({
29916
+ /** The ID of the organization group */
29258
29917
  id: t.string,
29918
+ /** The name of the organization group */
29259
29919
  name: t.string
29260
- }), 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 */
29261
29924
  previousState: t.union([
29262
29925
  t.literal("IDENTIFIED"),
29263
29926
  t.literal("RECOMMENDATION_ADDED"),
@@ -29269,12 +29932,19 @@ const OneTrustGetRiskResponse = t.type({
29269
29932
  t.literal("ARCHIVED_IN_VERSION"),
29270
29933
  t.null
29271
29934
  ]),
29935
+ /** Residual probability level. */
29272
29936
  probabilityLevel: t.union([t.string, t.null]),
29937
+ /** Residual probability level ID. */
29273
29938
  probabilityLevelId: t.union([t.number, t.null]),
29939
+ /** Risk Recommendation. */
29274
29940
  recommendation: t.union([t.string, t.null]),
29941
+ /** Proposed remediation. */
29275
29942
  remediationProposal: t.union([t.string, t.null]),
29943
+ /** Deadline reminder days. */
29276
29944
  reminderDays: t.union([t.number, t.null]),
29945
+ /** Risk exception request. */
29277
29946
  requestedException: t.union([t.string, t.null]),
29947
+ /** Risk Result. */
29278
29948
  result: t.union([
29279
29949
  t.literal("Accepted"),
29280
29950
  t.literal("Avoided"),
@@ -29284,19 +29954,33 @@ const OneTrustGetRiskResponse = t.type({
29284
29954
  t.literal("Ignored"),
29285
29955
  t.null
29286
29956
  ]),
29957
+ /** Risk approvers name csv. */
29287
29958
  riskApprovers: t.union([t.string, t.null]),
29959
+ /** Risk approvers ID. */
29288
29960
  riskApproversId: t.array(t.string),
29961
+ /** List of risk owners ID. */
29289
29962
  riskOwnersId: t.union([t.array(t.string), t.null]),
29963
+ /** Risk owners name csv. */
29290
29964
  riskOwnersName: t.union([t.string, t.null]),
29965
+ /** Risk score. */
29291
29966
  riskScore: t.union([t.number, t.null]),
29967
+ /** The risk source type */
29292
29968
  riskSourceType: OneTrustEntityType,
29969
+ /** The risk type */
29293
29970
  riskType: OneTrustEntityType,
29971
+ /** For Auto risk, rule Id reference. */
29294
29972
  ruleRootVersionId: t.union([t.string, t.null]),
29973
+ /** The risk source */
29295
29974
  source: t.type({
29975
+ /** Additional information about the Source Entity */
29296
29976
  additionalAttributes: t.object,
29977
+ /** Source Entity ID. */
29297
29978
  id: t.union([t.string, t.null]),
29979
+ /** Source Entity Name. */
29298
29980
  name: t.union([t.string, t.null]),
29981
+ /** The risk source type */
29299
29982
  sourceType: t.union([OneTrustEntityType, t.null]),
29983
+ /** Source Entity Type. */
29300
29984
  type: t.union([
29301
29985
  t.literal("PIA"),
29302
29986
  t.literal("RA"),
@@ -29307,6 +29991,7 @@ const OneTrustGetRiskResponse = t.type({
29307
29991
  t.null
29308
29992
  ])
29309
29993
  }),
29994
+ /** Risk Source Type. */
29310
29995
  sourceType: t.union([
29311
29996
  t.literal("PIA"),
29312
29997
  t.literal("RA"),
@@ -29316,14 +30001,21 @@ const OneTrustGetRiskResponse = t.type({
29316
30001
  t.literal("GENERIC"),
29317
30002
  t.null
29318
30003
  ]),
30004
+ /** The risk stage */
29319
30005
  stage: t.intersection([t.partial({
30006
+ /** The currentStageApprovers */
29320
30007
  currentStageApprovers: t.array(t.string),
30008
+ /** The badgeColor */
29321
30009
  badgeColor: t.union([t.string, t.null])
29322
30010
  }), t.type({
30011
+ /** ID of an entity. */
29323
30012
  id: t.string,
30013
+ /** Name of an entity. */
29324
30014
  name: t.string,
30015
+ /** Name Key of the entity for translation. */
29325
30016
  nameKey: t.string
29326
30017
  })]),
30018
+ /** The risk state */
29327
30019
  state: t.union([
29328
30020
  t.literal("IDENTIFIED"),
29329
30021
  t.literal("RECOMMENDATION_ADDED"),
@@ -29334,13 +30026,20 @@ const OneTrustGetRiskResponse = t.type({
29334
30026
  t.literal("RETAINED"),
29335
30027
  t.literal("ARCHIVED_IN_VERSION")
29336
30028
  ]),
30029
+ /** The target risk level */
29337
30030
  targetRiskLevel: OneTrustRiskLevel,
30031
+ /** The risk threat */
29338
30032
  threat: t.union([t.type({
30033
+ /** Threat ID. */
29339
30034
  id: t.string,
30035
+ /** Threat Identifier. */
29340
30036
  identifier: t.string,
30037
+ /** Threat Name. */
29341
30038
  name: t.string
29342
30039
  }), t.null]),
30040
+ /** Risk Treatment. */
29343
30041
  treatment: t.union([t.string, t.null]),
30042
+ /** Risk Treatment status. */
29344
30043
  treatmentStatus: t.union([
29345
30044
  t.literal("InProgress"),
29346
30045
  t.literal("UnderReview"),
@@ -29349,6 +30048,7 @@ const OneTrustGetRiskResponse = t.type({
29349
30048
  t.literal("ExceptionGranted"),
29350
30049
  t.null
29351
30050
  ]),
30051
+ /** Risk Type. */
29352
30052
  type: t.union([
29353
30053
  t.literal("ASSESSMENTS"),
29354
30054
  t.literal("ASSETS"),
@@ -29359,41 +30059,63 @@ const OneTrustGetRiskResponse = t.type({
29359
30059
  t.literal("ENGAGEMENTS"),
29360
30060
  t.null
29361
30061
  ]),
30062
+ /** ID of an assessment. */
29362
30063
  typeRefIds: t.array(t.string),
30064
+ /** List of vulnerabilities */
29363
30065
  vulnerabilities: t.union([t.array(t.type({
30066
+ /** Vulnerability ID. */
29364
30067
  id: t.string,
30068
+ /** Vulnerability Identifier. */
29365
30069
  identifier: t.string,
30070
+ /** Vulnerability Name. */
29366
30071
  name: t.string
29367
30072
  })), t.null]),
30073
+ /** The risk workflow */
29368
30074
  workflow: t.intersection([t.type({
30075
+ /** ID of an entity. */
29369
30076
  id: t.string,
30077
+ /** Name of an entity. */
29370
30078
  name: t.string
29371
30079
  }), t.partial({
30080
+ /** The name Key */
29372
30081
  nameKey: t.union([t.string, t.null]),
30082
+ /** The badgeColor */
29373
30083
  badgeColor: t.union([t.string, t.null])
29374
30084
  })])
29375
30085
  });
29376
30086
  //#endregion
29377
30087
  //#region src/oneTrust/endpoints/getUser.ts
29378
30088
  const OneTrustUserMetadata = t.type({
30089
+ /** When the user was created */
29379
30090
  created: t.string,
30091
+ /** When the user was modified */
29380
30092
  lastModified: t.string,
30093
+ /** The URI for accessing information about the user */
29381
30094
  location: t.string,
30095
+ /** The resource type */
29382
30096
  resourceType: t.literal("User")
29383
30097
  });
29384
30098
  const OneTrustUserName = t.partial({
30099
+ /** The user's family name */
29385
30100
  familyName: t.string,
30101
+ /** The user's given name */
29386
30102
  givenName: t.string
29387
30103
  });
29388
30104
  const OneTrustUserGroup = t.type({
30105
+ /** The user group's identification */
29389
30106
  value: t.string,
30107
+ /** The user group's display name */
29390
30108
  display: t.string
29391
30109
  });
29392
30110
  const OneTrustUserGroups = t.array(OneTrustUserGroup);
29393
30111
  const OneTrustUserEmail = t.type({
30112
+ /** The email value */
29394
30113
  value: t.string,
30114
+ /** The email display name */
29395
30115
  display: t.string,
30116
+ /** Whether this is the primary email */
29396
30117
  primary: t.boolean,
30118
+ /** The email type */
29397
30119
  type: t.union([t.string, t.literal("work")])
29398
30120
  });
29399
30121
  const OneTrustUserEmails = t.array(OneTrustUserEmail);
@@ -29402,17 +30124,29 @@ const OneTrustUserEmails = t.array(OneTrustUserEmail);
29402
30124
  * ref: https://developer.onetrust.com/onetrust/reference/getuserusingget
29403
30125
  */
29404
30126
  const OneTrustGetUserResponse = t.type({
30127
+ /** ID of the user. */
29405
30128
  id: t.string,
30129
+ /** External ID of the user. */
29406
30130
  externalId: t.union([t.string, t.null]),
30131
+ /** Metadata of the user. */
29407
30132
  meta: OneTrustUserMetadata,
30133
+ /** Schemas of the user */
29408
30134
  schemas: t.array(t.string),
30135
+ /** Name or email of the user */
29409
30136
  userName: t.string,
30137
+ /** Full name of the user */
29410
30138
  name: OneTrustUserName,
30139
+ /** Type of the user */
29411
30140
  userType: t.union([t.literal("Internal"), t.literal("External")]),
30141
+ /** Flag to check if the user is an active user or not. */
29412
30142
  active: t.boolean,
30143
+ /** The groups that the user belongs to */
29413
30144
  groups: OneTrustUserGroups,
30145
+ /** The emails of the user */
29414
30146
  emails: OneTrustUserEmails,
30147
+ /** The roles of the user */
29415
30148
  roles: t.array(t.string),
30149
+ /** The title of the user */
29416
30150
  title: t.union([t.string, t.null])
29417
30151
  });
29418
30152
  //#endregion
@@ -29484,36 +30218,53 @@ const DecryptionStatus = makeEnum({
29484
30218
  * Preference store identifier
29485
30219
  */
29486
30220
  const PreferenceStoreIdentifier = t.type({
30221
+ /** The identifier name (email, phone etc) */
29487
30222
  name: t.string,
30223
+ /** The identifier value */
29488
30224
  value: t.string
29489
30225
  });
29490
30226
  /**
29491
30227
  * Preference store system attributes which are not user editable
29492
30228
  */
29493
- 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 })]);
29494
30234
  /**
29495
30235
  * Contains all the Consent management related fields
29496
30236
  * that are stored in the preference store.
29497
30237
  */
29498
30238
  const PreferenceStoreConsentFields = t.type({
30239
+ /** US IAB Privacy String */
29499
30240
  usp: t.union([t.string, t.null]),
30241
+ /** IAB GPP String */
29500
30242
  gpp: t.union([t.string, t.null]),
30243
+ /** IAB TCF String */
29501
30244
  tcf: t.union([t.string, t.null]),
30245
+ /** Airgap Version */
29502
30246
  airgapVersion: t.union([t.string, t.null])
29503
30247
  });
29504
30248
  /**
29505
30249
  * The format key required fields of the preference store record
29506
30250
  */
29507
30251
  const PreferenceStoreKeyConditionals = t.type({
30252
+ /** The partition key */
29508
30253
  partition: t.string,
30254
+ /** last consent event timestamp (ISO 8601) */
29509
30255
  timestamp: t.string
29510
30256
  });
29511
30257
  /** The format for a preference which include topic and user choice */
29512
30258
  const Preference = t.type({
30259
+ /** The preference topic */
29513
30260
  topic: t.string,
30261
+ /** The preference choice made by the user */
29514
30262
  choice: t.partial({
30263
+ /** The boolean value of the preference */
29515
30264
  booleanValue: t.union([t.boolean, t.null]),
30265
+ /** The select value of the preference */
29516
30266
  selectValue: t.union([t.string, t.null]),
30267
+ /** The select values of the preference */
29517
30268
  selectValues: t.union([t.array(t.string), t.null])
29518
30269
  })
29519
30270
  });
@@ -29521,71 +30272,134 @@ const Preference = t.type({
29521
30272
  * The format for a preference store purpose
29522
30273
  */
29523
30274
  const PreferenceStorePurposeResponse = t.intersection([t.type({
30275
+ /** tracking purpose */
29524
30276
  purpose: t.string,
30277
+ /** Whether the purpose is enabled */
29525
30278
  enabled: t.boolean
29526
- }), t.partial({ preferences: t.array(Preference) })]);
30279
+ }), t.partial({
30280
+ /** additional preference associated with this purpose */
30281
+ preferences: t.array(Preference) })]);
29527
30282
  const PreferenceQueryResponseItem = t.intersection([
29528
30283
  PreferenceStoreKeyConditionals,
29529
30284
  t.type({
30285
+ /** The system attributes of the record */
29530
30286
  system: PreferenceStoreSystemAttributes,
30287
+ /** Consent management related fields */
29531
30288
  consentManagement: t.partial(PreferenceStoreConsentFields.props),
30289
+ /** Preference store purposes */
29532
30290
  purposes: t.array(PreferenceStorePurposeResponse)
29533
30291
  }),
29534
30292
  t.partial({
30293
+ /** Primary identifier of the user. */
29535
30294
  userId: t.string,
30295
+ /** Identifiers associated to the user */
29536
30296
  identifiers: t.array(PreferenceStoreIdentifier),
30297
+ /** metadata */
29537
30298
  metadata: t.array(t.type({
29538
30299
  key: t.string,
29539
30300
  value: t.string
29540
30301
  })),
30302
+ /** last updated for metadata */
29541
30303
  metadataTimestamp: t.string
29542
30304
  })
29543
30305
  ]);
29544
30306
  const CustomFieldApiInput = t.type({
30307
+ /** The attribute key that houses the attribute values */
29545
30308
  key: t.string,
30309
+ /** The attribute values used to label resources */
29546
30310
  values: t.array(t.string)
29547
30311
  });
29548
30312
  /** The format of the preference store workflow settings */
29549
30313
  const PreferenceStoreWorkflowSettings = t.partial({
30314
+ /** Additional tags to forward to the DSR event */
29550
30315
  attributes: t.array(CustomFieldApiInput),
30316
+ /** Data silo IDs to run the workflow on */
29551
30317
  dataSiloIds: t.array(t.string),
30318
+ /** The email template ID to use for the receipt */
29552
30319
  emailReceiptTemplateId: t.string,
30320
+ /** Data silo IDs to ignore when running the workflow */
29553
30321
  ignoreDataSiloIds: t.array(t.string),
30322
+ /** If the workflow is silent */
29554
30323
  isSilent: t.boolean,
30324
+ /** if the workflow is a test run */
29555
30325
  isTest: t.boolean,
30326
+ /** if the workflow should skip sending the receipt */
29556
30327
  skipSendingReceipt: t.boolean,
30328
+ /** if the workflow should skip the waiting period */
29557
30329
  skipWaitingPeriod: t.boolean,
30330
+ /** if the workflow should be skipped */
29558
30331
  skipWorkflowTrigger: t.boolean,
30332
+ /** Force trigger the workflow even when there was no concent/preference change */
29559
30333
  forceTriggerWorkflow: t.boolean,
30334
+ /** Country and/or country subdivision, to pass along to DSR request */
29560
30335
  region: t.partial({
30336
+ /** The country ISO code */
29561
30337
  country: valuesOf(IsoCountryCode),
30338
+ /** The country subdivision ISO code */
29562
30339
  countrySubDivision: valuesOf(IsoCountrySubdivisionCode)
29563
30340
  }),
30341
+ /** Language to translate request to */
29564
30342
  locale: t.string,
30343
+ /** The data subject type associated with the request */
29565
30344
  subjectType: t.string,
30345
+ /** The workflow's V2 configuration ID to use */
29566
30346
  workflowConfigId: t.string
29567
30347
  });
29568
30348
  /**
29569
30349
  * The format for a preference store purpose
29570
30350
  */
29571
30351
  const PreferenceStorePurposeUpdate = t.intersection([PreferenceStorePurposeResponse, t.partial({
30352
+ /** Timestamp of when the purpose was last updated (ISO 8601) */
29572
30353
  timestamp: t.string,
30354
+ /** Additional tags to forward to the DSR event */
29573
30355
  attributes: t.array(CustomFieldApiInput),
30356
+ /** Consent workflow settings */
29574
30357
  workflowSettings: PreferenceStoreWorkflowSettings,
30358
+ /** Language to translate request to */
29575
30359
  locale: t.string
29576
30360
  })]);
29577
30361
  const PreferenceUpdateItem = t.intersection([PreferenceStoreKeyConditionals, t.partial({
30362
+ /** Primary identifier of the user. */
29578
30363
  userId: t.string,
30364
+ /** Identifiers associated to the user */
29579
30365
  identifiers: t.array(PreferenceStoreIdentifier),
30366
+ /** Preference store purposes */
29580
30367
  purposes: t.array(PreferenceStorePurposeUpdate),
30368
+ /** Consent management related fields */
29581
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
+ */
29582
30374
  locale: t.string,
30375
+ /** The metadata associated with the record */
29583
30376
  metadata: t.array(t.type({
30377
+ /** metadata key */
29584
30378
  key: t.string,
30379
+ /**
30380
+ * metadata value
30381
+ *
30382
+ * - **null**: to remove the metadata key
30383
+ * - **string**: to set the metadata key
30384
+ */
29585
30385
  value: t.union([t.string, t.null])
29586
30386
  })),
30387
+ /** User birthdate. Optional. Accepted formats: YYYY-MM-DD, YYYY-MM, or MM-YYYY. Format enforcement is in the main repo. */
29587
30388
  birthDate: t.string,
29588
- 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 })
29589
30403
  })]);
29590
30404
  /**
29591
30405
  * The supported preference topic types
@@ -29605,7 +30419,9 @@ const PreferenceStoreAuthLevel = makeEnum({
29605
30419
  });
29606
30420
  /** The standard scopes which are used to access the Sombra APIs */
29607
30421
  const SombraStandardScope = makeEnum({
30422
+ /** Access to Preference Management APIs */
29608
30423
  PreferenceManagement: "preferenceManagement",
30424
+ /** DSR Automation APIs */
29609
30425
  DSRAutomation: "dsrAutomation"
29610
30426
  });
29611
30427
  //#endregion
@@ -29614,8 +30430,11 @@ const SombraStandardScope = makeEnum({
29614
30430
  * The status of a DPIA with a particular processing activity
29615
30431
  */
29616
30432
  const DataProtectionImpactAssessmentStatus = makeEnum({
30433
+ /** There is a link associated with this processing activity's DPIA */
29617
30434
  Link: "LINK",
30435
+ /** There is no DPIA required for this processing activity */
29618
30436
  NotRequired: "NOT_REQUIRED",
30437
+ /** The DPIA for this processing activity is missing */
29619
30438
  Missing: "MISSING"
29620
30439
  });
29621
30440
  //#endregion
@@ -29693,10 +30512,10 @@ let PromptFilePurpose = /* @__PURE__ */ function(PromptFilePurpose) {
29693
30512
  return PromptFilePurpose;
29694
30513
  }({});
29695
30514
  const PROMPT_FILE_PURPOSE_TO_OPEN_AI = {
29696
- [PromptFilePurpose.Assistants]: "assistants",
29697
- [PromptFilePurpose.AssistantsOutput]: "assistants_output",
29698
- [PromptFilePurpose.FineTune]: "fine-tune",
29699
- [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"
29700
30519
  };
29701
30520
  //#endregion
29702
30521
  //#region src/promptAVendor.ts
@@ -29704,53 +30523,88 @@ const PROMPT_FILE_PURPOSE_TO_OPEN_AI = {
29704
30523
  * Prompt-a-Vendor email send type.
29705
30524
  */
29706
30525
  const PromptAVendorEmailSendType = makeEnum({
30526
+ /** Send a single email encapsulating all profiles, i.e. at the RequestDataSilo level. */
29707
30527
  PerDsr: "PER_DSR",
30528
+ /** Send an email for all DSRs, that the vendor has not been notified of yet. */
29708
30529
  CrossDsr: "CROSS_DSR"
29709
30530
  });
29710
30531
  /**
29711
30532
  * Prompt-a-Vendor Email Completion link type.
29712
30533
  */
29713
30534
  const PromptAVendorEmailCompletionLinkType = makeEnum({
30535
+ /** Present a link that requires a user logged into Transcend. */
29714
30536
  LoggedInUser: "LOGGED_IN_USER",
30537
+ /**
30538
+ * Present a link that allows an external, unauthenticated user
30539
+ * to access the Bulk Requests UI.
30540
+ */
29715
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
+ */
29716
30546
  NoLinkMarkDatapointAsResolved: "NO_LINK_MARK_DATAPOINT_AS_RESOLVED"
29717
30547
  });
29718
30548
  //#endregion
29719
30549
  //#region src/purposeSubCategories/additional.ts
29720
- const AdditionalPurposeSubCategory = makeEnum({ Additional: "ADDITIONAL" });
30550
+ const AdditionalPurposeSubCategory = makeEnum({
30551
+ /** Fallback sub purpose */
30552
+ Additional: "ADDITIONAL" });
29721
30553
  //#endregion
29722
30554
  //#region src/purposeSubCategories/advertising.ts
29723
- const AdvertisingPurposeSubCategory = makeEnum({ Advertising: "ADVERTISING" });
30555
+ const AdvertisingPurposeSubCategory = makeEnum({
30556
+ /** Fallback sub purpose */
30557
+ Advertising: "ADVERTISING" });
29724
30558
  //#endregion
29725
30559
  //#region src/purposeSubCategories/analytics.ts
29726
- const AnalyticsPurposeSubCategory = makeEnum({ Analytics: "ANALYTICS" });
30560
+ const AnalyticsPurposeSubCategory = makeEnum({
30561
+ /** Fallback sub purpose */
30562
+ Analytics: "ANALYTICS" });
29727
30563
  //#endregion
29728
30564
  //#region src/purposeSubCategories/essential.ts
29729
- const EssentialPurposeSubCategory = makeEnum({ Essential: "ESSENTIAL" });
30565
+ const EssentialPurposeSubCategory = makeEnum({
30566
+ /** Fallback sub purpose */
30567
+ Essential: "ESSENTIAL" });
29730
30568
  //#endregion
29731
30569
  //#region src/purposeSubCategories/hr.ts
29732
- const HRPurposeSubCategory = makeEnum({ HR: "HR" });
30570
+ const HRPurposeSubCategory = makeEnum({
30571
+ /** Fallback sub purpose */
30572
+ HR: "HR" });
29733
30573
  //#endregion
29734
30574
  //#region src/purposeSubCategories/legal.ts
29735
- const LegalPurposeSubCategory = makeEnum({ Legal: "LEGAL" });
30575
+ const LegalPurposeSubCategory = makeEnum({
30576
+ /** Fallback sub purpose */
30577
+ Legal: "LEGAL" });
29736
30578
  //#endregion
29737
30579
  //#region src/purposeSubCategories/marketing.ts
29738
- const MarketingPurposeSubCategory = makeEnum({ Marketing: "MARKETING" });
30580
+ const MarketingPurposeSubCategory = makeEnum({
30581
+ /** Fallback sub purpose */
30582
+ Marketing: "MARKETING" });
29739
30583
  //#endregion
29740
30584
  //#region src/purposeSubCategories/operationSecurity.ts
29741
- const OperationSecurityPurposeSubCategory = makeEnum({ OperationSecurity: "OPERATION_SECURITY" });
30585
+ const OperationSecurityPurposeSubCategory = makeEnum({
30586
+ /** Fallback sub purpose */
30587
+ OperationSecurity: "OPERATION_SECURITY" });
29742
30588
  //#endregion
29743
30589
  //#region src/purposeSubCategories/other.ts
29744
- const OtherPurposeSubCategory = makeEnum({ Other: "Other" });
30590
+ const OtherPurposeSubCategory = makeEnum({
30591
+ /** Fallback sub purpose */
30592
+ Other: "Other" });
29745
30593
  //#endregion
29746
30594
  //#region src/purposeSubCategories/personalization.ts
29747
- const PersonalizationPurposeSubCategory = makeEnum({ Personalization: "PERSONALIZATION" });
30595
+ const PersonalizationPurposeSubCategory = makeEnum({
30596
+ /** Fallback sub purpose */
30597
+ Personalization: "PERSONALIZATION" });
29748
30598
  //#endregion
29749
30599
  //#region src/purposeSubCategories/sale.ts
29750
- const SalePurposeSubCategory = makeEnum({ Sale: "SALE" });
30600
+ const SalePurposeSubCategory = makeEnum({
30601
+ /** Fallback sub purpose */
30602
+ Sale: "SALE" });
29751
30603
  //#endregion
29752
30604
  //#region src/purposeSubCategories/transfer.ts
29753
- const TransferPurposeSubCategory = makeEnum({ Transfer: "TRANSFER" });
30605
+ const TransferPurposeSubCategory = makeEnum({
30606
+ /** Fallback sub purpose */
30607
+ Transfer: "TRANSFER" });
29754
30608
  //#endregion
29755
30609
  //#region src/purposeSubCategories/index.ts
29756
30610
  const DefaultPurposeSubCategoryType = makeEnum({
@@ -29780,7 +30634,18 @@ const NORMALIZE_PHONE_NUMBER = /[-\s.]/g;
29780
30634
  * This is useful for the purposes of uploading a backlog
29781
30635
  */
29782
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
+ */
29783
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
+ */
29784
30649
  ON_HOLD: "ON_HOLD"
29785
30650
  });
29786
30651
  /**
@@ -29788,31 +30653,52 @@ const PreflightRequestStatus = makeEnum({
29788
30653
  * This is useful for the purposes of uploading a backlog
29789
30654
  */
29790
30655
  const CompletedRequestStatus = makeEnum({
30656
+ /** The data subject failed to verify at least one of the identifier they submit through the form */
29791
30657
  FailedVerification: "FAILED_VERIFICATION",
30658
+ /** The request has been approved and sent to the data subject with no secondary action */
29792
30659
  Completed: "COMPLETED",
30660
+ /** The request was canceled and the data subject was notified */
29793
30661
  Canceled: "CANCELED",
30662
+ /** The secondary request action completed compilation */
29794
30663
  SecondaryCompleted: "SECONDARY_COMPLETED",
30664
+ /** The request was revoked because it was a duplicate (another open request covers it) */
29795
30665
  Revoked: "REVOKED"
29796
30666
  });
29797
30667
  /**
29798
30668
  * The statuses that a request can take on
29799
30669
  */
29800
30670
  const RequestStatus = makeEnum({
30671
+ /** A data subject submits a DSR */
29801
30672
  RequestMade: "REQUEST_MADE",
30673
+ /** The data subject failed to verify at least one of the identifier they submit through the form */
29802
30674
  FailedVerification: "FAILED_VERIFICATION",
30675
+ /** The request identifiers have been verified and they are enriched to create other identifiers */
29803
30676
  Enriching: "ENRICHING",
30677
+ /** The request is temporarily placed on hold */
29804
30678
  OnHold: "ON_HOLD",
30679
+ /** The request is waiting to compile */
29805
30680
  Waiting: "WAITING",
30681
+ /** The request begins compiling across the organization's Connected Services, specific to the actions requested */
29806
30682
  Compiling: "COMPILING",
30683
+ /** The request is compiled and appending review before send */
29807
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 */
29808
30686
  Delayed: "DELAYED",
30687
+ /** The request has been approved and sent to the data subject with no secondary action */
29809
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 */
29810
30690
  Downloadable: "DOWNLOADABLE",
30691
+ /** The request is completed but not available for download, but its data categories are visible on the Privacy Center */
29811
30692
  ViewCategories: "VIEW_CATEGORIES",
30693
+ /** The request was canceled and the data subject was notified */
29812
30694
  Canceled: "CANCELED",
30695
+ /** The secondary request action begins compiling across the organization's Connected Services, i.e. erasure is actually called */
29813
30696
  Secondary: "SECONDARY",
30697
+ /** The secondary request action completed compilation */
29814
30698
  SecondaryCompleted: "SECONDARY_COMPLETED",
30699
+ /** The request is pending approval before final deletion request email is sent to the data subject */
29815
30700
  SecondaryApproving: "SECONDARY_APPROVING",
30701
+ /** The request was revoked because it was a duplicate (another open request covers it) */
29816
30702
  Revoked: "REVOKED"
29817
30703
  });
29818
30704
  /**
@@ -29835,12 +30721,30 @@ let RequestOrigin = /* @__PURE__ */ function(RequestOrigin) {
29835
30721
  * The statuses that a queue is expected to implement
29836
30722
  */
29837
30723
  const QueueStatus = makeEnum({
30724
+ /** The row is queued up to be processed by the service worker. */
29838
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
+ */
29839
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
+ */
29840
30737
  Skipped: "SKIPPED",
30738
+ /** An error occurred while processing the row. The error message is stored on the model. */
29841
30739
  Error: "ERROR",
30740
+ /** The service worker successfully processed the row. */
29842
30741
  Resolved: "RESOLVED",
30742
+ /** The item requires attention for some reason */
29843
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
+ */
29844
30748
  RemoteProcessing: "REMOTE_PROCESSING"
29845
30749
  });
29846
30750
  /**
@@ -29848,6 +30752,7 @@ const QueueStatus = makeEnum({
29848
30752
  */
29849
30753
  const RequestDataSiloStatus = makeEnum({
29850
30754
  ...QueueStatus,
30755
+ /** The request not processed due to some exception */
29851
30756
  SkippedDueToException: "SKIPPED_DUE_TO_EXCEPTION"
29852
30757
  });
29853
30758
  /**
@@ -29855,7 +30760,9 @@ const RequestDataSiloStatus = makeEnum({
29855
30760
  */
29856
30761
  const RequestEnricherStatus = makeEnum({
29857
30762
  ...QueueStatus,
30763
+ /** Waiting on dependencies in the enrichment step to finish running */
29858
30764
  WaitingOnDependencies: "WAITING_ON_DEPENDENCIES",
30765
+ /** Polling for result */
29859
30766
  Polling: "POLLING"
29860
30767
  });
29861
30768
  /**
@@ -29863,8 +30770,11 @@ const RequestEnricherStatus = makeEnum({
29863
30770
  * request submit.
29864
30771
  */
29865
30772
  const RegionDetectionMethod = makeEnum({
30773
+ /** Region detection is disabled */
29866
30774
  Disabled: "DISABLED",
30775
+ /** Auto detect the region and collect in form silently */
29867
30776
  Auto: "AUTO",
30777
+ /** Collect information about the user's region by presenting the user a form */
29868
30778
  Form: "FORM"
29869
30779
  });
29870
30780
  //#endregion
@@ -30014,834 +30924,834 @@ let TranscendProduct = /* @__PURE__ */ function(TranscendProduct) {
30014
30924
  * The action scope definitions
30015
30925
  */
30016
30926
  const SCOPES_WITHOUT_VIEW_ONLY = {
30017
- [ScopeName.FullAdmin]: {
30018
- dependencies: Object.values(ScopeName).filter((scope) => scope !== ScopeName.FullAdmin),
30927
+ ["fullAdmin"]: {
30928
+ dependencies: Object.values(ScopeName).filter((scope) => scope !== "fullAdmin"),
30019
30929
  description: "Full administrative access. All scopes are granted.",
30020
30930
  title: "Full Admin",
30021
- type: ScopeType.Modify,
30931
+ type: "MODIFY",
30022
30932
  products: getValues(TranscendProduct)
30023
30933
  },
30024
- [ScopeName.ManageSombraRootKeys]: {
30934
+ ["manageSombraRootKeys"]: {
30025
30935
  dependencies: [],
30026
30936
  description: "Ability to perform a key rotation on the encryption keys used within your account.",
30027
30937
  title: "Rotate Hosted Sombra keys",
30028
- type: ScopeType.Modify,
30029
- products: [TranscendProduct.Sombra]
30938
+ type: "MODIFY",
30939
+ products: ["SOMBRA"]
30030
30940
  },
30031
- [ScopeName.ManageGlobalAttributes]: {
30032
- dependencies: [ScopeName.ViewGlobalAttributes],
30941
+ ["manageGlobalAttributes"]: {
30942
+ dependencies: ["viewGlobalAttributes"],
30033
30943
  description: "Under the infrastructure tab, manage your custom attributes and select which views those attributes should display in.",
30034
30944
  title: "Manage Global Attributes",
30035
- type: ScopeType.Modify,
30945
+ type: "MODIFY",
30036
30946
  products: [
30037
- TranscendProduct.DsrAutomation,
30038
- TranscendProduct.DataInventory,
30039
- TranscendProduct.ConsentManagement,
30040
- TranscendProduct.StructuredDiscovery,
30041
- TranscendProduct.Administration,
30042
- TranscendProduct.Assessments,
30043
- TranscendProduct.Pathfinder,
30044
- TranscendProduct.PromptManagement,
30045
- TranscendProduct.WebAuditor,
30046
- TranscendProduct.ContractScanning
30947
+ "DSR_AUTOMATION",
30948
+ "DATA_INVENTORY",
30949
+ "CONSENT_MANAGEMENT",
30950
+ "STRUCTURED_DISCOVERY",
30951
+ "ADMINISTRATION",
30952
+ "ASSESSMENTS",
30953
+ "PATHFINDER",
30954
+ "PROMPT_MANAGER",
30955
+ "WEB_AUDITOR",
30956
+ "CONTRACT_SCANNING"
30047
30957
  ]
30048
30958
  },
30049
- [ScopeName.ManageAccessControl]: {
30050
- dependencies: [ScopeName.ViewEmployees, ScopeName.ViewScopes],
30959
+ ["manageAccessControl"]: {
30960
+ dependencies: ["viewEmployees", "viewScopes"],
30051
30961
  description: "Manage what employees in your organization can access within Transcend.",
30052
30962
  title: "Manage Access Controls",
30053
- type: ScopeType.Modify,
30054
- products: [TranscendProduct.Administration]
30963
+ type: "MODIFY",
30964
+ products: ["ADMINISTRATION"]
30055
30965
  },
30056
- [ScopeName.ManageBilling]: {
30966
+ ["manageBilling"]: {
30057
30967
  dependencies: [],
30058
30968
  description: "Manage billing details for your organization.",
30059
30969
  title: "Manage Billing",
30060
- type: ScopeType.Modify,
30061
- products: [TranscendProduct.Administration]
30970
+ type: "MODIFY",
30971
+ products: ["ADMINISTRATION"]
30062
30972
  },
30063
- [ScopeName.ManageSSO]: {
30064
- dependencies: [ScopeName.ViewSSO],
30973
+ ["manageSSO"]: {
30974
+ dependencies: ["viewSSO"],
30065
30975
  description: "Manage SSO configuration for members of your organization.",
30066
30976
  title: "Manage SSO",
30067
- type: ScopeType.Modify,
30068
- products: [TranscendProduct.Administration]
30977
+ type: "MODIFY",
30978
+ products: ["ADMINISTRATION"]
30069
30979
  },
30070
- [ScopeName.ManageApiKeys]: {
30071
- dependencies: [ScopeName.ViewApiKeys],
30980
+ ["manageApiKeys"]: {
30981
+ dependencies: ["viewApiKeys"],
30072
30982
  description: "Create, update and delete API keys for programmatic access to your Transcend organization.",
30073
30983
  title: "Manage API Keys",
30074
- type: ScopeType.Modify,
30075
- products: [TranscendProduct.Administration]
30984
+ type: "MODIFY",
30985
+ products: ["ADMINISTRATION"]
30076
30986
  },
30077
- [ScopeName.ManageOrganizationInfo]: {
30987
+ ["manageOrganizationInfo"]: {
30078
30988
  dependencies: [],
30079
30989
  description: "Edit the top-level organization settings details.",
30080
30990
  title: "Manage Organization Information",
30081
- type: ScopeType.Modify,
30082
- products: [TranscendProduct.Administration]
30991
+ type: "MODIFY",
30992
+ products: ["ADMINISTRATION"]
30083
30993
  },
30084
- [ScopeName.ManageEmailDomains]: {
30085
- dependencies: [ScopeName.ViewEmailDomains],
30994
+ ["manageEmailDomains"]: {
30995
+ dependencies: ["viewEmailDomains"],
30086
30996
  description: "Manage the domains from which Transcend can send emails on behalf of your organization.",
30087
30997
  title: "Manage Email Domains",
30088
- type: ScopeType.Modify,
30998
+ type: "MODIFY",
30089
30999
  products: [
30090
- TranscendProduct.Administration,
30091
- TranscendProduct.DsrAutomation,
30092
- TranscendProduct.PrivacyCenter,
30093
- TranscendProduct.Assessments
31000
+ "ADMINISTRATION",
31001
+ "DSR_AUTOMATION",
31002
+ "PRIVACY_CENTER",
31003
+ "ASSESSMENTS"
30094
31004
  ]
30095
31005
  },
30096
- [ScopeName.ManageDataSubCategories]: {
30097
- dependencies: [ScopeName.ViewDataSubCategories],
31006
+ ["manageDataSubCategories"]: {
31007
+ dependencies: ["viewDataSubCategories"],
30098
31008
  description: "Manage data sub categories mentioned in the data inventory",
30099
31009
  title: "Manage Data Sub Categories",
30100
- type: ScopeType.Modify,
30101
- products: [TranscendProduct.DataInventory]
31010
+ type: "MODIFY",
31011
+ products: ["DATA_INVENTORY"]
30102
31012
  },
30103
- [ScopeName.ViewCustomerDataPrivacyRequests]: {
31013
+ ["viewCustomerDataPrivacyRequests"]: {
30104
31014
  dependencies: [],
30105
31015
  description: "Give permissions for an employee to view the data in an access request.",
30106
31016
  title: "View Customer Data in Privacy Requests",
30107
- type: ScopeType.View,
30108
- products: [TranscendProduct.Administration, TranscendProduct.DsrAutomation]
31017
+ type: "VIEW",
31018
+ products: ["ADMINISTRATION", "DSR_AUTOMATION"]
30109
31019
  },
30110
- [ScopeName.ViewCustomerDataDataMapping]: {
31020
+ ["viewCustomerDataDataMapping"]: {
30111
31021
  dependencies: [],
30112
31022
  description: "Give permissions for an employee to view the sampled data in the data mapping product.",
30113
31023
  title: "View Customer Data in Data Mapping",
30114
- type: ScopeType.View,
31024
+ type: "VIEW",
30115
31025
  products: [
30116
- TranscendProduct.Administration,
30117
- TranscendProduct.StructuredDiscovery,
30118
- TranscendProduct.UnstructuredDiscovery
31026
+ "ADMINISTRATION",
31027
+ "STRUCTURED_DISCOVERY",
31028
+ "UNSTRUCTURED_DISCOVERY"
30119
31029
  ]
30120
31030
  },
30121
- [ScopeName.ViewApiKeys]: {
31031
+ ["viewApiKeys"]: {
30122
31032
  dependencies: [],
30123
31033
  description: "View the API keys on your account and see what scopes are assigned to them.",
30124
31034
  title: "View API Keys",
30125
- type: ScopeType.View,
30126
- products: [TranscendProduct.Administration]
31035
+ type: "VIEW",
31036
+ products: ["ADMINISTRATION"]
30127
31037
  },
30128
- [ScopeName.ViewAuditEvents]: {
31038
+ ["viewAuditEvents"]: {
30129
31039
  dependencies: [],
30130
31040
  description: "View any audit events made throughout the platform. This includes any of the \"Audit Trail\" tabs across the Admin Dashboard.",
30131
31041
  title: "View Audit Events",
30132
- type: ScopeType.View,
30133
- products: [TranscendProduct.Administration]
31042
+ type: "VIEW",
31043
+ products: ["ADMINISTRATION"]
30134
31044
  },
30135
- [ScopeName.ViewSSO]: {
31045
+ ["viewSSO"]: {
30136
31046
  dependencies: [],
30137
31047
  description: "View the SSO configuration for your organization.",
30138
31048
  title: "View SSO",
30139
- type: ScopeType.View,
30140
- products: [TranscendProduct.Administration]
31049
+ type: "VIEW",
31050
+ products: ["ADMINISTRATION"]
30141
31051
  },
30142
- [ScopeName.ViewScopes]: {
30143
- dependencies: [ScopeName.ViewEmployees],
31052
+ ["viewScopes"]: {
31053
+ dependencies: ["viewEmployees"],
30144
31054
  description: "View the potential access control scopes that can be assigned to members in the organization.",
30145
31055
  title: "View Scopes",
30146
- type: ScopeType.View,
30147
- products: [TranscendProduct.Administration]
31056
+ type: "VIEW",
31057
+ products: ["ADMINISTRATION"]
30148
31058
  },
30149
- [ScopeName.ViewAllActionItems]: {
31059
+ ["viewAllActionItems"]: {
30150
31060
  dependencies: [],
30151
31061
  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.",
30152
31062
  title: "View All Action Items",
30153
- type: ScopeType.View,
30154
- products: [TranscendProduct.Administration]
31063
+ type: "VIEW",
31064
+ products: ["ADMINISTRATION"]
30155
31065
  },
30156
- [ScopeName.ManageAllActionItems]: {
30157
- dependencies: [ScopeName.ViewAllActionItems, ScopeName.ViewGlobalAttributes],
31066
+ ["manageAllActionItems"]: {
31067
+ dependencies: ["viewAllActionItems", "viewGlobalAttributes"],
30158
31068
  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.",
30159
31069
  title: "Manage All Action Items",
30160
- type: ScopeType.Modify,
30161
- products: [TranscendProduct.Administration]
31070
+ type: "MODIFY",
31071
+ products: ["ADMINISTRATION"]
30162
31072
  },
30163
- [ScopeName.ViewEmployees]: {
31073
+ ["viewEmployees"]: {
30164
31074
  dependencies: [],
30165
31075
  description: "View the list of employees within your organization.",
30166
31076
  title: "View Employees",
30167
- type: ScopeType.View,
30168
- products: [TranscendProduct.Administration]
31077
+ type: "VIEW",
31078
+ products: ["ADMINISTRATION"]
30169
31079
  },
30170
- [ScopeName.ViewEmailDomains]: {
31080
+ ["viewEmailDomains"]: {
30171
31081
  dependencies: [],
30172
31082
  description: "View the domains from which Transcend can send emails on behalf of your organization.",
30173
31083
  title: "View Email Domains",
30174
- type: ScopeType.View,
31084
+ type: "VIEW",
30175
31085
  products: [
30176
- TranscendProduct.Administration,
30177
- TranscendProduct.DsrAutomation,
30178
- TranscendProduct.PrivacyCenter,
30179
- TranscendProduct.Assessments
31086
+ "ADMINISTRATION",
31087
+ "DSR_AUTOMATION",
31088
+ "PRIVACY_CENTER",
31089
+ "ASSESSMENTS"
30180
31090
  ]
30181
31091
  },
30182
- [ScopeName.ViewGlobalAttributes]: {
31092
+ ["viewGlobalAttributes"]: {
30183
31093
  dependencies: [],
30184
31094
  description: "View the attribute definition key/value pairs.",
30185
31095
  title: "View Global Attributes",
30186
- type: ScopeType.View,
31096
+ type: "VIEW",
30187
31097
  products: [
30188
- TranscendProduct.DsrAutomation,
30189
- TranscendProduct.DataInventory,
30190
- TranscendProduct.ConsentManagement,
30191
- TranscendProduct.StructuredDiscovery,
30192
- TranscendProduct.Administration,
30193
- TranscendProduct.Assessments,
30194
- TranscendProduct.Pathfinder,
30195
- TranscendProduct.PromptManagement,
30196
- TranscendProduct.WebAuditor,
30197
- TranscendProduct.ContractScanning
31098
+ "DSR_AUTOMATION",
31099
+ "DATA_INVENTORY",
31100
+ "CONSENT_MANAGEMENT",
31101
+ "STRUCTURED_DISCOVERY",
31102
+ "ADMINISTRATION",
31103
+ "ASSESSMENTS",
31104
+ "PATHFINDER",
31105
+ "PROMPT_MANAGER",
31106
+ "WEB_AUDITOR",
31107
+ "CONTRACT_SCANNING"
30198
31108
  ]
30199
31109
  },
30200
- [ScopeName.ViewLegalHold]: {
31110
+ ["viewLegalHold"]: {
30201
31111
  dependencies: [],
30202
31112
  description: "View the individuals that have been placed on legal holds.",
30203
31113
  title: "View Legal Hold",
30204
- type: ScopeType.View,
30205
- products: [TranscendProduct.DsrAutomation]
31114
+ type: "VIEW",
31115
+ products: ["DSR_AUTOMATION"]
30206
31116
  },
30207
- [ScopeName.ManageLegalHold]: {
30208
- dependencies: [ScopeName.ViewLegalHold],
31117
+ ["manageLegalHold"]: {
31118
+ dependencies: ["viewLegalHold"],
30209
31119
  description: "Manage and edit the individuals that have been placed on legal holds.",
30210
31120
  title: "Manage Legal Holds",
30211
- type: ScopeType.Modify,
30212
- products: [TranscendProduct.DsrAutomation]
31121
+ type: "MODIFY",
31122
+ products: ["DSR_AUTOMATION"]
30213
31123
  },
30214
- [ScopeName.ManageRequestSecurity]: {
31124
+ ["manageRequestSecurity"]: {
30215
31125
  dependencies: [],
30216
31126
  description: "ReSign expired request encryption contexts, and data silo contexts.",
30217
31127
  title: "Manage Request Security",
30218
- type: ScopeType.Modify,
30219
- products: [TranscendProduct.Administration, TranscendProduct.DsrAutomation]
31128
+ type: "MODIFY",
31129
+ products: ["ADMINISTRATION", "DSR_AUTOMATION"]
30220
31130
  },
30221
- [ScopeName.ManageRequestCompilation]: {
30222
- dependencies: [ScopeName.ViewRequests, ScopeName.ViewRequestCompilation],
31131
+ ["manageRequestCompilation"]: {
31132
+ dependencies: ["viewRequests", "viewRequestCompilation"],
30223
31133
  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.",
30224
31134
  title: "Manage Request Compilation",
30225
- type: ScopeType.Modify,
30226
- products: [TranscendProduct.DsrAutomation]
31135
+ type: "MODIFY",
31136
+ products: ["DSR_AUTOMATION"]
30227
31137
  },
30228
- [ScopeName.ManageAssignedRequests]: {
30229
- dependencies: [ScopeName.ViewAssignedRequests],
31138
+ ["managedAssignedRequests"]: {
31139
+ dependencies: ["viewAssignedRequests"],
30230
31140
  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.",
30231
31141
  title: "Manage Assigned Privacy Requests",
30232
- type: ScopeType.Modify,
30233
- products: [TranscendProduct.DsrAutomation]
31142
+ type: "MODIFY",
31143
+ products: ["DSR_AUTOMATION"]
30234
31144
  },
30235
- [ScopeName.ManageAssignedBulkRespond]: {
31145
+ ["manageAssignedBulkRespond"]: {
30236
31146
  dependencies: [],
30237
31147
  description: "Bulk respond to privacy requests assigned to you or your team.",
30238
31148
  title: "Manage Assigned Bulk Respond",
30239
- type: ScopeType.Modify,
30240
- products: [TranscendProduct.DsrAutomation]
31149
+ type: "MODIFY",
31150
+ products: ["DSR_AUTOMATION"]
30241
31151
  },
30242
- [ScopeName.MakeDataSubjectRequest]: {
30243
- dependencies: [ScopeName.ViewDataSubjectRequestSettings, ScopeName.ViewRequestIdentitySettings],
31152
+ ["makeDataSubjectRequest"]: {
31153
+ dependencies: ["viewDataSubjectRequestSettings", "viewRequestIdentitySettings"],
30244
31154
  description: "Submit a new privacy requests.",
30245
31155
  title: "Submit New Data Subject Request",
30246
- type: ScopeType.Modify,
30247
- products: [TranscendProduct.DsrAutomation]
31156
+ type: "MODIFY",
31157
+ products: ["DSR_AUTOMATION"]
30248
31158
  },
30249
- [ScopeName.ManageDataSubjectRequestSettings]: {
30250
- dependencies: [ScopeName.ViewDataSubjectRequestSettings],
31159
+ ["manageDataSubjectRequestSettings"]: {
31160
+ dependencies: ["viewDataSubjectRequestSettings"],
30251
31161
  description: "Make changes to the request actions that your organization allows, as well as what data subjects you will serve.",
30252
31162
  title: "Manage Data Subject Request Settings",
30253
- type: ScopeType.Modify,
30254
- products: [TranscendProduct.DsrAutomation]
31163
+ type: "MODIFY",
31164
+ products: ["DSR_AUTOMATION"]
30255
31165
  },
30256
- [ScopeName.ManageEmailTemplates]: {
30257
- dependencies: [ScopeName.ViewEmailTemplates],
31166
+ ["manageEmailTemplates"]: {
31167
+ dependencies: ["viewEmailTemplates"],
30258
31168
  description: "Manage the email communication templates that your organization uses to communicate with your data subjects.",
30259
31169
  title: "Manage Email Templates",
30260
- type: ScopeType.Modify,
31170
+ type: "MODIFY",
30261
31171
  products: [
30262
- TranscendProduct.DsrAutomation,
30263
- TranscendProduct.PrivacyCenter,
30264
- TranscendProduct.Assessments
31172
+ "DSR_AUTOMATION",
31173
+ "PRIVACY_CENTER",
31174
+ "ASSESSMENTS"
30265
31175
  ]
30266
31176
  },
30267
- [ScopeName.ManageRequestIdentities]: {
30268
- dependencies: [ScopeName.ViewRequestIdentitySettings],
31177
+ ["manageRequestIdentities"]: {
31178
+ dependencies: ["viewRequestIdentitySettings"],
30269
31179
  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.",
30270
31180
  title: "Manage Request Identity Verification",
30271
- type: ScopeType.Modify,
30272
- products: [TranscendProduct.DsrAutomation]
31181
+ type: "MODIFY",
31182
+ products: ["DSR_AUTOMATION"]
30273
31183
  },
30274
- [ScopeName.DeployPrivacyCenter]: {
30275
- dependencies: [ScopeName.ManagePrivacyCenter],
31184
+ ["deployPrivacyCenter"]: {
31185
+ dependencies: ["managePrivacyCenter"],
30276
31186
  description: "Launch the Privacy Center on your own domain, and publish new changes.",
30277
31187
  title: "Publish Privacy Center",
30278
- type: ScopeType.Modify,
30279
- products: [TranscendProduct.PrivacyCenter]
31188
+ type: "MODIFY",
31189
+ products: ["PRIVACY_CENTER"]
30280
31190
  },
30281
- [ScopeName.ManageDataMap]: {
30282
- dependencies: [ScopeName.ViewDataMap],
31191
+ ["manageDataMap"]: {
31192
+ dependencies: ["viewDataMap"],
30283
31193
  description: "Edit the configurations on your data silos and determine what information should be included in a request.",
30284
31194
  title: "Manage Data Map",
30285
- type: ScopeType.Modify,
31195
+ type: "MODIFY",
30286
31196
  products: [
30287
- TranscendProduct.DsrAutomation,
30288
- TranscendProduct.DataInventory,
30289
- TranscendProduct.StructuredDiscovery,
30290
- TranscendProduct.SiloDiscovery,
30291
- TranscendProduct.UnstructuredDiscovery
31197
+ "DSR_AUTOMATION",
31198
+ "DATA_INVENTORY",
31199
+ "STRUCTURED_DISCOVERY",
31200
+ "SILO_DISCOVERY",
31201
+ "UNSTRUCTURED_DISCOVERY"
30292
31202
  ]
30293
31203
  },
30294
- [ScopeName.ManagePrivacyCenter]: {
30295
- dependencies: [ScopeName.ViewPrivacyCenter, ScopeName.ManagePolicies],
31204
+ ["managePrivacyCenter"]: {
31205
+ dependencies: ["viewPrivacyCenter", "managePolicies"],
30296
31206
  description: "Make changes to the privacy center configuration and policies.",
30297
31207
  title: "Manage Privacy Center Layout",
30298
- type: ScopeType.Modify,
30299
- products: [TranscendProduct.PrivacyCenter]
31208
+ type: "MODIFY",
31209
+ products: ["PRIVACY_CENTER"]
30300
31210
  },
30301
- [ScopeName.ManagePolicies]: {
30302
- dependencies: [ScopeName.ViewPolicies],
31211
+ ["managePolicies"]: {
31212
+ dependencies: ["viewPolicies"],
30303
31213
  description: "Make changes to the policies defined underneath the privacy center.",
30304
31214
  title: "Manage Privacy Center Policies",
30305
- type: ScopeType.Modify,
30306
- products: [TranscendProduct.PrivacyCenter]
31215
+ type: "MODIFY",
31216
+ products: ["PRIVACY_CENTER"]
30307
31217
  },
30308
- [ScopeName.ViewPolicies]: {
31218
+ ["viewPolicies"]: {
30309
31219
  dependencies: [],
30310
31220
  description: "View the policies defined underneath the privacy center.",
30311
31221
  title: "View Privacy Center Policies",
30312
- type: ScopeType.View,
30313
- products: [TranscendProduct.PrivacyCenter]
31222
+ type: "VIEW",
31223
+ products: ["PRIVACY_CENTER"]
30314
31224
  },
30315
- [ScopeName.ViewPolicyEngineBundles]: {
31225
+ ["viewPolicyEngineBundles"]: {
30316
31226
  dependencies: [],
30317
31227
  description: "View Policy Engine policy bundles and their versions.",
30318
31228
  title: "View Policy",
30319
- type: ScopeType.View,
30320
- products: [TranscendProduct.PolicyEngine]
31229
+ type: "VIEW",
31230
+ products: ["POLICY_ENGINE"]
30321
31231
  },
30322
- [ScopeName.ManagePolicyEngineBundles]: {
30323
- dependencies: [ScopeName.ViewPolicyEngineBundles],
31232
+ ["managePolicyEngineBundles"]: {
31233
+ dependencies: ["viewPolicyEngineBundles"],
30324
31234
  description: "Create and upload Policy Engine policy bundles and versions. Uploaded versions are inert until activated.",
30325
31235
  title: "Manage Policy",
30326
- type: ScopeType.Modify,
30327
- products: [TranscendProduct.PolicyEngine]
31236
+ type: "MODIFY",
31237
+ products: ["POLICY_ENGINE"]
30328
31238
  },
30329
- [ScopeName.ActivatePolicyEngineBundles]: {
30330
- dependencies: [ScopeName.ViewPolicyEngineBundles],
31239
+ ["activatePolicyEngineBundles"]: {
31240
+ dependencies: ["viewPolicyEngineBundles"],
30331
31241
  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.",
30332
31242
  title: "Activate Policy",
30333
- type: ScopeType.Modify,
30334
- products: [TranscendProduct.PolicyEngine]
31243
+ type: "MODIFY",
31244
+ products: ["POLICY_ENGINE"]
30335
31245
  },
30336
- [ScopeName.ManageIntlMessages]: {
30337
- dependencies: [ScopeName.ViewIntlMessages],
31246
+ ["manageIntlMessages"]: {
31247
+ dependencies: ["viewIntlMessages"],
30338
31248
  description: "Manage the internationalization messages used in the privacy center.",
30339
31249
  title: "Manage Internationalization Messages",
30340
- type: ScopeType.Modify,
30341
- products: [TranscendProduct.PrivacyCenter, TranscendProduct.ConsentManagement]
31250
+ type: "MODIFY",
31251
+ products: ["PRIVACY_CENTER", "CONSENT_MANAGEMENT"]
30342
31252
  },
30343
- [ScopeName.ViewIntlMessages]: {
31253
+ ["viewIntlMessages"]: {
30344
31254
  dependencies: [],
30345
31255
  description: "View the internationalization messages used in the privacy center.",
30346
31256
  title: "View Internationalization Messages",
30347
- type: ScopeType.View,
30348
- products: [TranscendProduct.PrivacyCenter, TranscendProduct.ConsentManagement]
31257
+ type: "VIEW",
31258
+ products: ["PRIVACY_CENTER", "CONSENT_MANAGEMENT"]
30349
31259
  },
30350
- [ScopeName.RequestApproval]: {
31260
+ ["requestApproval"]: {
30351
31261
  dependencies: [
30352
- ScopeName.ViewRequests,
30353
- ScopeName.ViewRequestCompilation,
30354
- ScopeName.ManageRequestCompilation
31262
+ "viewRequests",
31263
+ "viewRequestCompilation",
31264
+ "manageRequestCompilation"
30355
31265
  ],
30356
31266
  description: "The ability to approve and manage the state of privacy requests, and communicate with the data subject.",
30357
31267
  title: "Request Approval and Communication",
30358
- type: ScopeType.Modify,
30359
- products: [TranscendProduct.DsrAutomation]
31268
+ type: "MODIFY",
31269
+ products: ["DSR_AUTOMATION"]
30360
31270
  },
30361
- [ScopeName.ViewDataSubjectRequestSettings]: {
31271
+ ["viewDataSubjectRequestSettings"]: {
30362
31272
  dependencies: [],
30363
31273
  description: "View the privacy request actions settings and data subject categories that your organization supports.",
30364
31274
  title: "View Data Subject Request Settings",
30365
- type: ScopeType.View,
30366
- products: [TranscendProduct.DsrAutomation]
31275
+ type: "VIEW",
31276
+ products: ["DSR_AUTOMATION"]
30367
31277
  },
30368
- [ScopeName.ViewRequestCompilation]: {
30369
- dependencies: [ScopeName.ViewRequests],
31278
+ ["viewRequestCompilation"]: {
31279
+ dependencies: ["viewRequests"],
30370
31280
  description: "View the status of requests as they compile across your Data Map.",
30371
31281
  title: "View the Request Compilation",
30372
- type: ScopeType.View,
30373
- products: [TranscendProduct.DsrAutomation]
31282
+ type: "VIEW",
31283
+ products: ["DSR_AUTOMATION"]
30374
31284
  },
30375
- [ScopeName.ViewRequestIdentitySettings]: {
31285
+ ["viewRequestIdentitySettings"]: {
30376
31286
  dependencies: [],
30377
31287
  description: "View the settings for data subject request identity verification.",
30378
31288
  title: "View Identity Verification Settings",
30379
- type: ScopeType.View,
30380
- products: [TranscendProduct.DsrAutomation]
31289
+ type: "VIEW",
31290
+ products: ["DSR_AUTOMATION"]
30381
31291
  },
30382
- [ScopeName.ViewRequests]: {
31292
+ ["viewRequests"]: {
30383
31293
  dependencies: [
30384
- ScopeName.ViewGlobalAttributes,
30385
- ScopeName.ViewDataSubjectRequestSettings,
30386
- ScopeName.ViewEmailTemplates
31294
+ "viewGlobalAttributes",
31295
+ "viewDataSubjectRequestSettings",
31296
+ "viewEmailTemplates"
30387
31297
  ],
30388
31298
  description: "View the stream of incoming requests, and any details submit through the form or later enriched.",
30389
31299
  title: "View Incoming Requests",
30390
- type: ScopeType.View,
30391
- products: [TranscendProduct.DsrAutomation]
31300
+ type: "VIEW",
31301
+ products: ["DSR_AUTOMATION"]
30392
31302
  },
30393
- [ScopeName.ViewAssignedRequests]: {
31303
+ ["viewAssignedRequests"]: {
30394
31304
  dependencies: [
30395
- ScopeName.ViewGlobalAttributes,
30396
- ScopeName.ViewDataSubjectRequestSettings,
30397
- ScopeName.ViewEmailTemplates
31305
+ "viewGlobalAttributes",
31306
+ "viewDataSubjectRequestSettings",
31307
+ "viewEmailTemplates"
30398
31308
  ],
30399
31309
  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.",
30400
31310
  title: "View Assigned Privacy Requests",
30401
- type: ScopeType.View,
30402
- products: [TranscendProduct.DsrAutomation]
31311
+ type: "VIEW",
31312
+ products: ["DSR_AUTOMATION"]
30403
31313
  },
30404
- [ScopeName.ViewPrivacyCenter]: {
31314
+ ["viewPrivacyCenter"]: {
30405
31315
  dependencies: [],
30406
31316
  description: "View the full configuration of the privacy center.",
30407
31317
  title: "View Privacy Center Layout",
30408
- type: ScopeType.View,
30409
- products: [TranscendProduct.PrivacyCenter]
31318
+ type: "VIEW",
31319
+ products: ["PRIVACY_CENTER"]
30410
31320
  },
30411
- [ScopeName.ViewEmailTemplates]: {
31321
+ ["viewEmailTemplates"]: {
30412
31322
  dependencies: [],
30413
31323
  description: "View the default email templates templates used to communicate with your data subjects.",
30414
31324
  title: "View Email Templates",
30415
- type: ScopeType.View,
31325
+ type: "VIEW",
30416
31326
  products: [
30417
- TranscendProduct.DsrAutomation,
30418
- TranscendProduct.PrivacyCenter,
30419
- TranscendProduct.Assessments
31327
+ "DSR_AUTOMATION",
31328
+ "PRIVACY_CENTER",
31329
+ "ASSESSMENTS"
30420
31330
  ]
30421
31331
  },
30422
- [ScopeName.ConnectDataSilos]: {
31332
+ ["connectDataSilos"]: {
30423
31333
  dependencies: [
30424
- ScopeName.ViewDataMap,
30425
- ScopeName.ManageDataMap,
30426
- ScopeName.ViewEmailTemplates
31334
+ "viewDataMap",
31335
+ "manageDataMap",
31336
+ "viewEmailTemplates"
30427
31337
  ],
30428
31338
  description: "Connect new data silos to your Data Map.",
30429
31339
  title: "Connect Data Silos",
30430
31340
  products: [
30431
- TranscendProduct.DsrAutomation,
30432
- TranscendProduct.SiloDiscovery,
30433
- TranscendProduct.StructuredDiscovery,
30434
- TranscendProduct.UnstructuredDiscovery
31341
+ "DSR_AUTOMATION",
31342
+ "SILO_DISCOVERY",
31343
+ "STRUCTURED_DISCOVERY",
31344
+ "UNSTRUCTURED_DISCOVERY"
30435
31345
  ],
30436
- type: ScopeType.Modify
31346
+ type: "MODIFY"
30437
31347
  },
30438
- [ScopeName.ManageDataInventory]: {
30439
- dependencies: [ScopeName.ViewDataInventory],
31348
+ ["manageDataInventory"]: {
31349
+ dependencies: ["viewDataInventory"],
30440
31350
  description: "Ability to manage and edit everything in the data mapping product. Includes the data inventory, ROPE, and content classification views.",
30441
31351
  title: "Manage Data Inventory",
30442
- type: ScopeType.Modify,
31352
+ type: "MODIFY",
30443
31353
  products: [
30444
- TranscendProduct.DataInventory,
30445
- TranscendProduct.StructuredDiscovery,
30446
- TranscendProduct.SiloDiscovery,
30447
- TranscendProduct.UnstructuredDiscovery
31354
+ "DATA_INVENTORY",
31355
+ "STRUCTURED_DISCOVERY",
31356
+ "SILO_DISCOVERY",
31357
+ "UNSTRUCTURED_DISCOVERY"
30448
31358
  ]
30449
31359
  },
30450
- [ScopeName.ManageAssignedDataInventory]: {
30451
- dependencies: [ScopeName.ViewAssignedDataInventory],
31360
+ ["managedAssignedDataInventory"]: {
31361
+ dependencies: ["viewAssignedDataInventory"],
30452
31362
  description: "Manage the data inventory rows in your organization's Data Map that are assigned to you or your team.",
30453
31363
  title: "Manage Assigned Data Inventory",
30454
- type: ScopeType.Modify,
31364
+ type: "MODIFY",
30455
31365
  products: [
30456
- TranscendProduct.DataInventory,
30457
- TranscendProduct.StructuredDiscovery,
30458
- TranscendProduct.SiloDiscovery,
30459
- TranscendProduct.UnstructuredDiscovery
31366
+ "DATA_INVENTORY",
31367
+ "STRUCTURED_DISCOVERY",
31368
+ "SILO_DISCOVERY",
31369
+ "UNSTRUCTURED_DISCOVERY"
30460
31370
  ]
30461
31371
  },
30462
- [ScopeName.ManageAssignedIntegrations]: {
30463
- dependencies: [ScopeName.ViewAssignedIntegrations],
31372
+ ["managedAssignedIntegrations"]: {
31373
+ dependencies: ["viewAssignedIntegrations"],
30464
31374
  description: "Manage the integrations in your organization's Data Map that are assigned to you or your team.",
30465
31375
  title: "Manage Assigned Integrations",
30466
- type: ScopeType.Modify,
31376
+ type: "MODIFY",
30467
31377
  products: [
30468
- TranscendProduct.DsrAutomation,
30469
- TranscendProduct.DataInventory,
30470
- TranscendProduct.StructuredDiscovery,
30471
- TranscendProduct.SiloDiscovery,
30472
- TranscendProduct.UnstructuredDiscovery
31378
+ "DSR_AUTOMATION",
31379
+ "DATA_INVENTORY",
31380
+ "STRUCTURED_DISCOVERY",
31381
+ "SILO_DISCOVERY",
31382
+ "UNSTRUCTURED_DISCOVERY"
30473
31383
  ]
30474
31384
  },
30475
- [ScopeName.ViewDataMap]: {
30476
- dependencies: [ScopeName.ViewGlobalAttributes],
31385
+ ["viewDataMap"]: {
31386
+ dependencies: ["viewGlobalAttributes"],
30477
31387
  description: "View your organization's Data Map and see the configuration settings for each action your support.",
30478
31388
  title: "View Data Map",
30479
- type: ScopeType.View,
31389
+ type: "VIEW",
30480
31390
  products: [
30481
- TranscendProduct.DsrAutomation,
30482
- TranscendProduct.DataInventory,
30483
- TranscendProduct.StructuredDiscovery,
30484
- TranscendProduct.SiloDiscovery,
30485
- TranscendProduct.UnstructuredDiscovery
31391
+ "DSR_AUTOMATION",
31392
+ "DATA_INVENTORY",
31393
+ "STRUCTURED_DISCOVERY",
31394
+ "SILO_DISCOVERY",
31395
+ "UNSTRUCTURED_DISCOVERY"
30486
31396
  ]
30487
31397
  },
30488
- [ScopeName.ViewAssignedIntegrations]: {
30489
- dependencies: [ScopeName.ViewGlobalAttributes],
31398
+ ["viewAssignedIntegrations"]: {
31399
+ dependencies: ["viewGlobalAttributes"],
30490
31400
  description: "View the integrations in your organization's Data Map that are assigned to you or your team.",
30491
31401
  title: "View Assigned Integrations",
30492
- type: ScopeType.View,
31402
+ type: "VIEW",
30493
31403
  products: [
30494
- TranscendProduct.DsrAutomation,
30495
- TranscendProduct.DataInventory,
30496
- TranscendProduct.StructuredDiscovery,
30497
- TranscendProduct.SiloDiscovery,
30498
- TranscendProduct.UnstructuredDiscovery
31404
+ "DSR_AUTOMATION",
31405
+ "DATA_INVENTORY",
31406
+ "STRUCTURED_DISCOVERY",
31407
+ "SILO_DISCOVERY",
31408
+ "UNSTRUCTURED_DISCOVERY"
30499
31409
  ]
30500
31410
  },
30501
- [ScopeName.ViewAssignedDataInventory]: {
30502
- dependencies: [ScopeName.ViewGlobalAttributes, ScopeName.ViewDataSubjectRequestSettings],
31411
+ ["viewAssignedDataInventory"]: {
31412
+ dependencies: ["viewGlobalAttributes", "viewDataSubjectRequestSettings"],
30503
31413
  description: "Ability to view the resources in the data mapping product that are assigned to your or your team.",
30504
31414
  title: "View Assigned Data Inventory",
30505
- type: ScopeType.View,
31415
+ type: "VIEW",
30506
31416
  products: [
30507
- TranscendProduct.DataInventory,
30508
- TranscendProduct.StructuredDiscovery,
30509
- TranscendProduct.SiloDiscovery,
30510
- TranscendProduct.UnstructuredDiscovery
31417
+ "DATA_INVENTORY",
31418
+ "STRUCTURED_DISCOVERY",
31419
+ "SILO_DISCOVERY",
31420
+ "UNSTRUCTURED_DISCOVERY"
30511
31421
  ]
30512
31422
  },
30513
- [ScopeName.ViewDataInventory]: {
31423
+ ["viewDataInventory"]: {
30514
31424
  dependencies: [
30515
- ScopeName.ViewDataMap,
30516
- ScopeName.ViewGlobalAttributes,
30517
- ScopeName.ViewDataSubjectRequestSettings
31425
+ "viewDataMap",
31426
+ "viewGlobalAttributes",
31427
+ "viewDataSubjectRequestSettings"
30518
31428
  ],
30519
31429
  description: "Ability to view all of the data mapping product. Includes the data inventory, ROPA, and content classification views.",
30520
31430
  title: "View Data Inventory",
30521
- type: ScopeType.View,
31431
+ type: "VIEW",
30522
31432
  products: [
30523
- TranscendProduct.DataInventory,
30524
- TranscendProduct.StructuredDiscovery,
30525
- TranscendProduct.SiloDiscovery,
30526
- TranscendProduct.UnstructuredDiscovery
31433
+ "DATA_INVENTORY",
31434
+ "STRUCTURED_DISCOVERY",
31435
+ "SILO_DISCOVERY",
31436
+ "UNSTRUCTURED_DISCOVERY"
30527
31437
  ]
30528
31438
  },
30529
- [ScopeName.ManageConsentManager]: {
31439
+ ["manageConsentManager"]: {
30530
31440
  dependencies: [
30531
- ScopeName.ViewConsentManager,
30532
- ScopeName.ManageDataFlow,
30533
- ScopeName.ManageConsentManagerDisplaySettings,
30534
- ScopeName.ManageConsentManagerDeveloperSettings,
30535
- ScopeName.DeployConsentManager,
30536
- ScopeName.DeployTestConsentManager,
30537
- ScopeName.ViewDataFlow
31441
+ "viewConsentManager",
31442
+ "manageDataFlow",
31443
+ "manageConsentManagerDisplaySettings",
31444
+ "manageConsentManagerDeveloperSettings",
31445
+ "deployConsentManager",
31446
+ "deployTestConsentManager",
31447
+ "viewDataFlow"
30538
31448
  ],
30539
31449
  description: "Manage & deploy the consent manager changes to your websites.",
30540
31450
  title: "Manage Consent Manager",
30541
- type: ScopeType.Modify,
30542
- products: [TranscendProduct.ConsentManagement]
31451
+ type: "MODIFY",
31452
+ products: ["CONSENT_MANAGEMENT"]
30543
31453
  },
30544
- [ScopeName.ManageConsentManagerDeveloperSettings]: {
30545
- dependencies: [ScopeName.ViewConsentManager],
31454
+ ["manageConsentManagerDeveloperSettings"]: {
31455
+ dependencies: ["viewConsentManager"],
30546
31456
  description: "Manage the developer settings for the Consent Manager. This does not allow for clicking the \"Set Changes Live\" button.",
30547
31457
  title: "Manage Consent Manager Developer Settings",
30548
- type: ScopeType.Modify,
30549
- products: [TranscendProduct.ConsentManagement]
31458
+ type: "MODIFY",
31459
+ products: ["CONSENT_MANAGEMENT"]
30550
31460
  },
30551
- [ScopeName.ManageConsentManagerDisplaySettings]: {
30552
- dependencies: [ScopeName.ViewConsentManager],
31461
+ ["manageConsentManagerDisplaySettings"]: {
31462
+ dependencies: ["viewConsentManager"],
30553
31463
  description: "Manage the display settings for the consent manager. This includes messages, styles and other UI settings.",
30554
31464
  title: "Manage Consent Manager Display Settings",
30555
- type: ScopeType.Modify,
30556
- products: [TranscendProduct.ConsentManagement]
31465
+ type: "MODIFY",
31466
+ products: ["CONSENT_MANAGEMENT"]
30557
31467
  },
30558
- [ScopeName.DeployTestConsentManager]: {
30559
- dependencies: [ScopeName.ViewConsentManager],
31468
+ ["deployTestConsentManager"]: {
31469
+ dependencies: ["viewConsentManager"],
30560
31470
  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.",
30561
31471
  title: "Deploy Test Consent Manager",
30562
- type: ScopeType.Modify,
30563
- products: [TranscendProduct.ConsentManagement]
31472
+ type: "MODIFY",
31473
+ products: ["CONSENT_MANAGEMENT"]
30564
31474
  },
30565
- [ScopeName.DeployConsentManager]: {
30566
- dependencies: [ScopeName.ViewConsentManager, ScopeName.DeployTestConsentManager],
31475
+ ["deployConsentManager"]: {
31476
+ dependencies: ["viewConsentManager", "deployTestConsentManager"],
30567
31477
  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.",
30568
31478
  title: "Deploy Consent Manager",
30569
- type: ScopeType.Modify,
30570
- products: [TranscendProduct.ConsentManagement]
31479
+ type: "MODIFY",
31480
+ products: ["CONSENT_MANAGEMENT"]
30571
31481
  },
30572
- [ScopeName.ManageAssignedConsentManager]: {
30573
- dependencies: [ScopeName.ViewAssignedConsentManager],
31482
+ ["managedAssignedConsentManager"]: {
31483
+ dependencies: ["viewAssignedConsentManager"],
30574
31484
  description: "Manage Data Flows & Cookies assigned to you or your team.",
30575
31485
  title: "Manage Assigned Consent Manager",
30576
- type: ScopeType.Modify,
30577
- products: [TranscendProduct.ConsentManagement]
31486
+ type: "MODIFY",
31487
+ products: ["CONSENT_MANAGEMENT"]
30578
31488
  },
30579
- [ScopeName.ManageDataFlow]: {
30580
- dependencies: [ScopeName.ViewDataFlow],
31489
+ ["manageDataFlow"]: {
31490
+ dependencies: ["viewDataFlow"],
30581
31491
  description: "Ability to manage and delete Data Flows and Cookies within the Consent Manager product.",
30582
31492
  title: "Manage Data Flows",
30583
- type: ScopeType.Modify,
30584
- products: [TranscendProduct.ConsentManagement]
31493
+ type: "MODIFY",
31494
+ products: ["CONSENT_MANAGEMENT"]
30585
31495
  },
30586
- [ScopeName.ViewDataFlow]: {
30587
- dependencies: [ScopeName.ViewConsentManager],
31496
+ ["viewDataFlow"]: {
31497
+ dependencies: ["viewConsentManager"],
30588
31498
  description: "View Data Flows (tracking purpose maps, site scans)",
30589
31499
  title: "View Data Flows",
30590
- type: ScopeType.View,
30591
- products: [TranscendProduct.ConsentManagement]
31500
+ type: "VIEW",
31501
+ products: ["CONSENT_MANAGEMENT"]
30592
31502
  },
30593
- [ScopeName.ViewAssignedConsentManager]: {
30594
- dependencies: [ScopeName.ViewGlobalAttributes],
31503
+ ["viewAssignedConsentManager"]: {
31504
+ dependencies: ["viewGlobalAttributes"],
30595
31505
  description: "View Data Flows and Cookies assigned to you or your team.",
30596
31506
  title: "View Assigned Consent Manager",
30597
- type: ScopeType.View,
30598
- products: [TranscendProduct.ConsentManagement]
31507
+ type: "VIEW",
31508
+ products: ["CONSENT_MANAGEMENT"]
30599
31509
  },
30600
- [ScopeName.ViewConsentManager]: {
31510
+ ["viewConsentManager"]: {
30601
31511
  title: "View Consent Manager",
30602
- type: ScopeType.View,
30603
- dependencies: [ScopeName.ViewGlobalAttributes, ScopeName.ViewManagedConsentDatabaseAdminApi],
31512
+ type: "VIEW",
31513
+ dependencies: ["viewGlobalAttributes", "viewManagedConsentDatabaseAdminApi"],
30604
31514
  description: "View the consent manager configuration.",
30605
- products: [TranscendProduct.ConsentManagement]
31515
+ products: ["CONSENT_MANAGEMENT"]
30606
31516
  },
30607
- [ScopeName.ViewAssessments]: {
31517
+ ["viewAssessments"]: {
30608
31518
  title: "View Assessments",
30609
31519
  dependencies: [],
30610
31520
  description: "View the assessments and assessment templates.",
30611
- type: ScopeType.View,
30612
- products: [TranscendProduct.Assessments, TranscendProduct.DataInventory]
31521
+ type: "VIEW",
31522
+ products: ["ASSESSMENTS", "DATA_INVENTORY"]
30613
31523
  },
30614
- [ScopeName.ManageAssessments]: {
31524
+ ["manageAssessments"]: {
30615
31525
  title: "Manage Assessments",
30616
- dependencies: [ScopeName.ViewAssessments],
31526
+ dependencies: ["viewAssessments"],
30617
31527
  description: "Manage and edit assessments and assessment templates",
30618
- type: ScopeType.Modify,
30619
- products: [TranscendProduct.Assessments, TranscendProduct.DataInventory]
31528
+ type: "MODIFY",
31529
+ products: ["ASSESSMENTS", "DATA_INVENTORY"]
30620
31530
  },
30621
- [ScopeName.ViewAssignedAssessments]: {
31531
+ ["viewAssignedAssessments"]: {
30622
31532
  title: "View Assigned Assessments",
30623
31533
  dependencies: [],
30624
31534
  description: "View the assigned assessments forms.",
30625
- type: ScopeType.View,
30626
- products: [TranscendProduct.Assessments, TranscendProduct.DataInventory]
31535
+ type: "VIEW",
31536
+ products: ["ASSESSMENTS", "DATA_INVENTORY"]
30627
31537
  },
30628
- [ScopeName.ManageAssignedAssessments]: {
31538
+ ["manageAssignedAssessments"]: {
30629
31539
  title: "Manage Assigned Assessments",
30630
- dependencies: [ScopeName.ViewAssignedAssessments],
31540
+ dependencies: ["viewAssignedAssessments"],
30631
31541
  description: "Manage and edit the assigned assessments.",
30632
- type: ScopeType.Modify,
30633
- products: [TranscendProduct.Assessments, TranscendProduct.DataInventory]
31542
+ type: "MODIFY",
31543
+ products: ["ASSESSMENTS", "DATA_INVENTORY"]
30634
31544
  },
30635
- [ScopeName.ViewPathfinder]: {
31545
+ ["viewPathfinder"]: {
30636
31546
  title: "View Pathfinder",
30637
- dependencies: [ScopeName.ViewGlobalAttributes],
31547
+ dependencies: ["viewGlobalAttributes"],
30638
31548
  description: "View the pathfinder settings.",
30639
- type: ScopeType.View,
30640
- products: [TranscendProduct.Pathfinder]
31549
+ type: "VIEW",
31550
+ products: ["PATHFINDER"]
30641
31551
  },
30642
- [ScopeName.ManagePathfinder]: {
31552
+ ["managePathfinder"]: {
30643
31553
  title: "Manage Pathfinder",
30644
- dependencies: [ScopeName.ViewPathfinder],
31554
+ dependencies: ["viewPathfinder"],
30645
31555
  description: "Manage the pathfinder settings under that pathfinder side menu",
30646
- type: ScopeType.Modify,
30647
- products: [TranscendProduct.Pathfinder]
31556
+ type: "MODIFY",
31557
+ products: ["PATHFINDER"]
30648
31558
  },
30649
- [ScopeName.ViewContractScanning]: {
31559
+ ["viewContractScanning"]: {
30650
31560
  title: "View Contract Scanning",
30651
- dependencies: [ScopeName.ViewGlobalAttributes],
31561
+ dependencies: ["viewGlobalAttributes"],
30652
31562
  description: "View the contract scanning side menu - including setting and contracts.",
30653
- type: ScopeType.View,
30654
- products: [TranscendProduct.ContractScanning]
31563
+ type: "VIEW",
31564
+ products: ["CONTRACT_SCANNING"]
30655
31565
  },
30656
- [ScopeName.ManageContractScanning]: {
31566
+ ["manageContractScanning"]: {
30657
31567
  title: "Manage Contract Scanning",
30658
- dependencies: [ScopeName.ViewContractScanning],
31568
+ dependencies: ["viewContractScanning"],
30659
31569
  description: "Upload and manage contracts under the contract scanning side menu",
30660
- type: ScopeType.Modify,
30661
- products: [TranscendProduct.ContractScanning]
31570
+ type: "MODIFY",
31571
+ products: ["CONTRACT_SCANNING"]
30662
31572
  },
30663
- [ScopeName.ViewPrompts]: {
31573
+ ["viewPrompts"]: {
30664
31574
  title: "View Prompts",
30665
- dependencies: [ScopeName.ViewGlobalAttributes],
31575
+ dependencies: ["viewGlobalAttributes"],
30666
31576
  description: "View the prompts and prompt templates.",
30667
- type: ScopeType.View,
30668
- products: [TranscendProduct.PromptManagement]
31577
+ type: "VIEW",
31578
+ products: ["PROMPT_MANAGER"]
30669
31579
  },
30670
- [ScopeName.ManagePrompts]: {
31580
+ ["managePrompts"]: {
30671
31581
  title: "Manage Prompts",
30672
- dependencies: [ScopeName.ViewPrompts],
31582
+ dependencies: ["viewPrompts"],
30673
31583
  description: "Manage and edit prompts and prompt templates",
30674
- type: ScopeType.Modify,
30675
- products: [TranscendProduct.PromptManagement]
31584
+ type: "MODIFY",
31585
+ products: ["PROMPT_MANAGER"]
30676
31586
  },
30677
- [ScopeName.ViewPromptRuns]: {
31587
+ ["viewPromptRuns"]: {
30678
31588
  title: "View Prompt Runs",
30679
- dependencies: [ScopeName.ViewPrompts],
31589
+ dependencies: ["viewPrompts"],
30680
31590
  description: "View the output run results for prompts.",
30681
- type: ScopeType.View,
30682
- products: [TranscendProduct.PromptManagement]
31591
+ type: "VIEW",
31592
+ products: ["PROMPT_MANAGER"]
30683
31593
  },
30684
- [ScopeName.ManagePromptRuns]: {
31594
+ ["managePromptRuns"]: {
30685
31595
  title: "Manage Prompt Runs",
30686
- dependencies: [ScopeName.ViewPromptRuns, ScopeName.ViewPrompts],
31596
+ dependencies: ["viewPromptRuns", "viewPrompts"],
30687
31597
  description: "Manage, edit and create prompt run results",
30688
- type: ScopeType.Modify,
30689
- products: [TranscendProduct.PromptManagement, TranscendProduct.Pathfinder]
31598
+ type: "MODIFY",
31599
+ products: ["PROMPT_MANAGER", "PATHFINDER"]
30690
31600
  },
30691
- [ScopeName.ViewCodeScanning]: {
31601
+ ["viewCodeScanning"]: {
30692
31602
  title: "View Code Scanning",
30693
- dependencies: [ScopeName.ViewGlobalAttributes],
31603
+ dependencies: ["viewGlobalAttributes"],
30694
31604
  description: "View the code scanning tables.",
30695
- type: ScopeType.View,
30696
- products: [TranscendProduct.DataInventory, TranscendProduct.ConsentManagement]
31605
+ type: "VIEW",
31606
+ products: ["DATA_INVENTORY", "CONSENT_MANAGEMENT"]
30697
31607
  },
30698
- [ScopeName.ManageCodeScanning]: {
31608
+ ["manageCodeScanning"]: {
30699
31609
  title: "Manage Code Scanning",
30700
- dependencies: [ScopeName.ViewCodeScanning],
31610
+ dependencies: ["viewCodeScanning"],
30701
31611
  description: "Manage, edit and create records in code scanning",
30702
- type: ScopeType.Modify,
30703
- products: [TranscendProduct.DataInventory, TranscendProduct.ConsentManagement]
31612
+ type: "MODIFY",
31613
+ products: ["DATA_INVENTORY", "CONSENT_MANAGEMENT"]
30704
31614
  },
30705
- [ScopeName.ExecutePrompt]: {
31615
+ ["executePrompt"]: {
30706
31616
  title: "Execute Prompt",
30707
- dependencies: [ScopeName.ViewPromptRuns, ScopeName.ViewPrompts],
31617
+ dependencies: ["viewPromptRuns", "viewPrompts"],
30708
31618
  description: "Ability to execute a prompt and view the outputs",
30709
- type: ScopeType.Modify,
30710
- products: [TranscendProduct.PromptManagement]
31619
+ type: "MODIFY",
31620
+ products: ["PROMPT_MANAGER"]
30711
31621
  },
30712
- [ScopeName.ViewAuditorRuns]: {
31622
+ ["viewAuditorRuns"]: {
30713
31623
  title: "View Auditor Runs",
30714
31624
  dependencies: [],
30715
31625
  description: "View the output run results for Auditor.",
30716
- type: ScopeType.View,
30717
- products: [TranscendProduct.WebAuditor]
31626
+ type: "VIEW",
31627
+ products: ["WEB_AUDITOR"]
30718
31628
  },
30719
- [ScopeName.ManageAuditor]: {
31629
+ ["manageAuditor"]: {
30720
31630
  title: "Manage Auditor Runs and Schedules",
30721
- dependencies: [ScopeName.ViewAuditorRuns],
31631
+ dependencies: ["viewAuditorRuns"],
30722
31632
  description: "Manage, edit and create prompt run results",
30723
- type: ScopeType.Modify,
30724
- products: [TranscendProduct.WebAuditor]
31633
+ type: "MODIFY",
31634
+ products: ["WEB_AUDITOR"]
30725
31635
  },
30726
- [ScopeName.ExecuteAuditor]: {
31636
+ ["executeAuditor"]: {
30727
31637
  title: "Execute Auditor",
30728
- dependencies: [ScopeName.ViewAuditorRuns],
31638
+ dependencies: ["viewAuditorRuns"],
30729
31639
  description: "Ability to execute or schedule Auditor and view the outputs",
30730
- type: ScopeType.Modify,
30731
- products: [TranscendProduct.WebAuditor]
31640
+ type: "MODIFY",
31641
+ products: ["WEB_AUDITOR"]
30732
31642
  },
30733
- [ScopeName.ApprovePrompts]: {
31643
+ ["approvePrompts"]: {
30734
31644
  title: "Approve Prompts",
30735
- dependencies: [ScopeName.ViewPrompts],
31645
+ dependencies: ["viewPrompts"],
30736
31646
  description: "Approve the prompts and prompt templates",
30737
- type: ScopeType.Modify,
30738
- products: [TranscendProduct.PromptManagement]
31647
+ type: "MODIFY",
31648
+ products: ["PROMPT_MANAGER"]
30739
31649
  },
30740
- [ScopeName.ManageActionItemCollections]: {
31650
+ ["manageActionItemCollections"]: {
30741
31651
  title: "Manage Action Item Collections",
30742
31652
  dependencies: [],
30743
31653
  description: "Manage and edit action item collections",
30744
- type: ScopeType.Modify,
30745
- products: [TranscendProduct.Administration]
31654
+ type: "MODIFY",
31655
+ products: ["ADMINISTRATION"]
30746
31656
  },
30747
- [ScopeName.ViewManagedConsentDatabaseAdminApi]: {
31657
+ ["viewManagedConsentDatabaseAdminApi"]: {
30748
31658
  title: "View Managed Consent Database Admin API",
30749
31659
  dependencies: [],
30750
31660
  description: "Ability to query user consent preferences with the Managed Consent Database Admin API",
30751
- type: ScopeType.View,
30752
- products: [TranscendProduct.ConsentManagement, TranscendProduct.PreferenceManagement]
31661
+ type: "VIEW",
31662
+ products: ["CONSENT_MANAGEMENT", "PREFERENCE_MANAGEMENT"]
30753
31663
  },
30754
- [ScopeName.ManageStoredPreferences]: {
31664
+ ["manageStoredPreferences"]: {
30755
31665
  title: "Modify User Stored Preferences",
30756
- dependencies: [ScopeName.ViewManagedConsentDatabaseAdminApi],
31666
+ dependencies: ["viewManagedConsentDatabaseAdminApi"],
30757
31667
  description: "Ability to make updates to user stored consent preferences",
30758
- type: ScopeType.Modify,
30759
- products: [TranscendProduct.ConsentManagement, TranscendProduct.PreferenceManagement]
31668
+ type: "MODIFY",
31669
+ products: ["CONSENT_MANAGEMENT", "PREFERENCE_MANAGEMENT"]
30760
31670
  },
30761
- [ScopeName.ManagePreferenceStoreSettings]: {
31671
+ ["managePreferenceStoreSettings"]: {
30762
31672
  title: "Manage Preference Store Settings",
30763
- dependencies: [ScopeName.ViewPreferenceStoreSettings],
31673
+ dependencies: ["viewPreferenceStoreSettings"],
30764
31674
  description: "Ability to make updates to preference store settings",
30765
- type: ScopeType.Modify,
30766
- products: [TranscendProduct.PreferenceManagement]
31675
+ type: "MODIFY",
31676
+ products: ["PREFERENCE_MANAGEMENT"]
30767
31677
  },
30768
- [ScopeName.ViewPreferenceStoreSettings]: {
31678
+ ["viewPreferenceStoreSettings"]: {
30769
31679
  title: "View Preference Store Settings",
30770
- dependencies: [ScopeName.ViewPreferenceStoreSettings],
31680
+ dependencies: ["viewPreferenceStoreSettings"],
30771
31681
  description: "Ability to view preference store settings",
30772
- type: ScopeType.Modify,
30773
- products: [TranscendProduct.PreferenceManagement]
31682
+ type: "MODIFY",
31683
+ products: ["PREFERENCE_MANAGEMENT"]
30774
31684
  },
30775
- [ScopeName.LLMLogTransfer]: {
31685
+ ["llmLogTransfer"]: {
30776
31686
  title: "LLM Log Transfer",
30777
- dependencies: [ScopeName.ManageDataInventory],
31687
+ dependencies: ["manageDataInventory"],
30778
31688
  description: "Ability to transfer logs from LLM to Transcend",
30779
- type: ScopeType.Modify,
30780
- products: [TranscendProduct.StructuredDiscovery, TranscendProduct.UnstructuredDiscovery]
31689
+ type: "MODIFY",
31690
+ products: ["STRUCTURED_DISCOVERY", "UNSTRUCTURED_DISCOVERY"]
30781
31691
  },
30782
- [ScopeName.ManageWorkflows]: {
31692
+ ["manageWorkflows"]: {
30783
31693
  title: "Manage Workflows",
30784
31694
  description: "Ability to make updates to Workflows and their settings",
30785
31695
  dependencies: [],
30786
- type: ScopeType.Modify,
30787
- products: [TranscendProduct.DsrAutomation]
31696
+ type: "MODIFY",
31697
+ products: ["DSR_AUTOMATION"]
30788
31698
  },
30789
- [ScopeName.ViewDataSubCategories]: {
31699
+ ["viewDataSubCategories"]: {
30790
31700
  title: "View Data Sub Categories",
30791
31701
  dependencies: [],
30792
31702
  description: "View Data Sub Categories from Data Inventory",
30793
- type: ScopeType.View,
30794
- products: [TranscendProduct.DataInventory]
31703
+ type: "VIEW",
31704
+ products: ["DATA_INVENTORY"]
30795
31705
  },
30796
- [ScopeName.GeneratePreferenceAccessTokens]: {
31706
+ ["generatePreferenceAccessTokens"]: {
30797
31707
  title: "Generate Preference Access Tokens",
30798
31708
  dependencies: [],
30799
31709
  description: "Ability to generate access tokens for user preferences",
30800
- type: ScopeType.Modify,
30801
- products: [TranscendProduct.PreferenceManagement, TranscendProduct.PrivacyCenter]
31710
+ type: "MODIFY",
31711
+ products: ["PREFERENCE_MANAGEMENT", "PRIVACY_CENTER"]
30802
31712
  },
30803
- [ScopeName.ViewRules]: {
31713
+ ["viewRules"]: {
30804
31714
  title: "View Rules",
30805
31715
  dependencies: [],
30806
31716
  description: "View rules, their triggers, actions, and execution history.",
30807
- type: ScopeType.View,
30808
- products: [TranscendProduct.RulesAutomation]
31717
+ type: "VIEW",
31718
+ products: ["RULES_AUTOMATION"]
30809
31719
  },
30810
- [ScopeName.ManageRules]: {
31720
+ ["manageRules"]: {
30811
31721
  title: "Manage Rules",
30812
- dependencies: [ScopeName.ViewRules],
31722
+ dependencies: ["viewRules"],
30813
31723
  description: "Create, update, and delete rules and their configurations.",
30814
- type: ScopeType.Modify,
30815
- products: [TranscendProduct.RulesAutomation]
31724
+ type: "MODIFY",
31725
+ products: ["RULES_AUTOMATION"]
30816
31726
  },
30817
- [ScopeName.ViewAssignedRules]: {
31727
+ ["viewAssignedRules"]: {
30818
31728
  title: "View Assigned Rules",
30819
31729
  dependencies: [],
30820
31730
  description: "View rules assigned to you or your team.",
30821
- type: ScopeType.View,
30822
- products: [TranscendProduct.RulesAutomation]
31731
+ type: "VIEW",
31732
+ products: ["RULES_AUTOMATION"]
30823
31733
  },
30824
- [ScopeName.ManageAssignedRules]: {
31734
+ ["manageAssignedRules"]: {
30825
31735
  title: "Manage Assigned Rules",
30826
- dependencies: [ScopeName.ViewAssignedRules],
31736
+ dependencies: ["viewAssignedRules"],
30827
31737
  description: "Manage and edit rules assigned to you or your team.",
30828
- type: ScopeType.Modify,
30829
- products: [TranscendProduct.RulesAutomation]
31738
+ type: "MODIFY",
31739
+ products: ["RULES_AUTOMATION"]
30830
31740
  },
30831
- [ScopeName.ExecuteRules]: {
31741
+ ["executeRules"]: {
30832
31742
  title: "Execute Rules",
30833
- dependencies: [ScopeName.ViewRules],
31743
+ dependencies: ["viewRules"],
30834
31744
  description: "Trigger rule execution and view the outputs.",
30835
- type: ScopeType.Modify,
30836
- products: [TranscendProduct.RulesAutomation]
31745
+ type: "MODIFY",
31746
+ products: ["RULES_AUTOMATION"]
30837
31747
  }
30838
31748
  };
30839
31749
  const TRANSCEND_SCOPES = {
30840
- [ScopeName.ReadOnly]: {
30841
- dependencies: getEntries(SCOPES_WITHOUT_VIEW_ONLY).filter(([, v]) => v.type === ScopeType.View).map(([k]) => k),
31750
+ ["readOnly"]: {
31751
+ dependencies: getEntries(SCOPES_WITHOUT_VIEW_ONLY).filter(([, v]) => v.type === "VIEW").map(([k]) => k),
30842
31752
  description: "Access is granted to all of the scopes of type \"View\".",
30843
31753
  title: "View Only",
30844
- type: ScopeType.View,
31754
+ type: "VIEW",
30845
31755
  products: getValues(TranscendProduct)
30846
31756
  },
30847
31757
  ...SCOPES_WITHOUT_VIEW_ONLY
@@ -30853,31 +31763,48 @@ const TRANSCEND_SCOPES = {
30853
31763
  * identifiers needed to establish a connection for the current browsing session.
30854
31764
  */
30855
31765
  const ConnectionSubCategory = makeEnum({
31766
+ /** A Media Access Control address */
30856
31767
  MACAddress: "MAC_ADDRESS",
31768
+ /** An internet protocol address */
30857
31769
  IPAddress: "IP_ADDRESS",
31770
+ /** The User-Agent request header */
30858
31771
  UserAgent: "USER_AGENT",
31772
+ /** Fallback subcategory */
30859
31773
  Connection: "CONNECTION"
30860
31774
  });
30861
31775
  //#endregion
30862
31776
  //#region src/subcategories/contact.ts
30863
31777
  const ContactSubCategory = makeEnum({
31778
+ /** An email address */
30864
31779
  Email: "EMAIL",
31780
+ /** A phone number */
30865
31781
  Phone: "PHONE",
31782
+ /** Fallback subcategory */
30866
31783
  Contact: "CONTACT"
30867
31784
  });
30868
31785
  //#endregion
30869
31786
  //#region src/subcategories/demographic.ts
30870
31787
  /** Information about the features or characteristics of a user */
30871
31788
  const DemographicSubCategory = makeEnum({
31789
+ /** Information about an individual's racial or ethnic origin */
30872
31790
  RaceOrEthnicity: "RACE_OR_ETHNICITY",
31791
+ /** An individual's gender */
30873
31792
  Gender: "GENDER",
31793
+ /** An individual's date of birth */
30874
31794
  DateOfBirth: "DATE_OF_BIRTH",
31795
+ /** An individual's country, city, or other static location information */
30875
31796
  Region: "REGION",
31797
+ /** The industry in which an individual works */
30876
31798
  Industry: "INDUSTRY",
31799
+ /** An individual's sexual orientation */
30877
31800
  SexualOrientation: "SEXUAL_ORIENTATION",
31801
+ /** Information about an individual's union membership */
30878
31802
  UnionMembership: "UNION_MEMBERSHIP",
31803
+ /** Information about an individual's religious beliefs */
30879
31804
  Religion: "RELIGION",
31805
+ /** Information about an individual's political beliefs or party membership */
30880
31806
  PoliticalAffiliation: "POLITICAL_AFFILIATION",
31807
+ /** Fallback subcategory */
30881
31808
  Demographic: "DEMOGRAPHIC"
30882
31809
  });
30883
31810
  //#endregion
@@ -30886,73 +31813,109 @@ const DemographicSubCategory = makeEnum({
30886
31813
  * The type of operating system (OS) or web browser that the user uses, or similar computer or device information.
30887
31814
  */
30888
31815
  const DeviceSubCategory = makeEnum({
31816
+ /** A unique device identifier */
30889
31817
  SerialNumber: "SERIAL_NUMBER",
31818
+ /** Fallback subcategory */
30890
31819
  Device: "DEVICE"
30891
31820
  });
30892
31821
  //#endregion
30893
31822
  //#region src/subcategories/financial.ts
30894
31823
  /** Information about an individual's finances */
30895
31824
  const FinancialSubCategory = makeEnum({
31825
+ /** Account number */
30896
31826
  AccountNumber: "ACCOUNT_NUMBER",
31827
+ /** Credit Card Number */
30897
31828
  CreditCardNumber: "CREDIT_CARD_NUMBER",
31829
+ /** Income */
30898
31830
  Income: "INCOME",
31831
+ /** Tax information */
30899
31832
  Tax: "TAX",
31833
+ /** Routing number */
30900
31834
  RoutingNumber: "ROUTING_NUMBER",
31835
+ /** Fallback subcategory */
30901
31836
  Financial: "FINANCIAL"
30902
31837
  });
30903
31838
  //#endregion
30904
31839
  //#region src/subcategories/health.ts
30905
31840
  /** Information about an individual's health */
30906
- const HealthSubCategory = makeEnum({ Health: "HEALTH" });
31841
+ const HealthSubCategory = makeEnum({
31842
+ /** Fallback subcategory */
31843
+ Health: "HEALTH" });
30907
31844
  //#endregion
30908
31845
  //#region src/subcategories/id.ts
30909
31846
  /** Information that can be used to identify an individual */
30910
31847
  const IdSubCategory = makeEnum({
31848
+ /** A username associated with an individual */
30911
31849
  Username: "USERNAME",
31850
+ /** A person's name */
30912
31851
  Name: "NAME",
31852
+ /** An individual's (US) Social security number */
30913
31853
  SocialSecurityNumber: "SOCIAL_SECURITY_NUMBER",
31854
+ /** Driver's license */
30914
31855
  DriversLicense: "DRIVERS_LICENSE",
31856
+ /** Passport number */
30915
31857
  PassportNumber: "PASSPORT_NUMBER",
31858
+ /** A digital representation of an individual's unique physical characteristics (e.g. fingerprint, retina or iris image, etc.) */
30916
31859
  BiometricIdentifier: "BIOMETRIC_IDENTIFIER",
31860
+ /** The user ID */
30917
31861
  UserId: "USER_ID",
31862
+ /** Fallback subcategory */
30918
31863
  Id: "ID"
30919
31864
  });
30920
31865
  //#endregion
30921
31866
  //#region src/subcategories/location.ts
30922
31867
  const LocationSubCategory = makeEnum({
31868
+ /** Approximate geolocation */
30923
31869
  ApproximateLocation: "APPROXIMATE_LOCATION",
31870
+ /** Fallback subcategory */
30924
31871
  Location: "LOCATION"
30925
31872
  });
30926
31873
  //#endregion
30927
31874
  //#region src/subcategories/notPersonalData.ts
30928
31875
  /** Information that does not belong to an individual */
30929
- const NotPersonalDataSubCategory = makeEnum({ NotPersonalData: "NOT_PERSONAL_DATA" });
31876
+ const NotPersonalDataSubCategory = makeEnum({
31877
+ /** Fallback subcategory */
31878
+ NotPersonalData: "NOT_PERSONAL_DATA" });
30930
31879
  //#endregion
30931
31880
  //#region src/subcategories/onlineActivity.ts
30932
31881
  const OnlineActivitySubCategory = makeEnum({
31882
+ /** Declared interests */
30933
31883
  DeclaredInterests: "DECLARED_INTERESTS",
31884
+ /** Page views */
30934
31885
  PageViews: "PAGE_VIEWS",
31886
+ /** Interaction events */
30935
31887
  InteractionEvents: "INTERACTION_EVENTS",
31888
+ /** Fallback subcategory */
30936
31889
  OnlineActivity: "ONLINE_ACTIVITY"
30937
31890
  });
30938
31891
  //#endregion
30939
31892
  //#region src/subcategories/socialMedia.ts
30940
31893
  const SocialMediaSubCategory = makeEnum({
31894
+ /** A link to an individual's social media profile */
30941
31895
  ProfileURL: "PROFILE_URL",
31896
+ /** Fallback subcategory */
30942
31897
  SocialMedia: "SOCIAL_MEDIA"
30943
31898
  });
30944
31899
  //#endregion
30945
31900
  //#region src/subcategories/survey.ts
30946
- const SurveySubCategory = makeEnum({ Survey: "SURVEY" });
31901
+ const SurveySubCategory = makeEnum({
31902
+ /** Fallback subcategory */
31903
+ Survey: "SURVEY" });
30947
31904
  //#endregion
30948
31905
  //#region src/subcategories/tracking.ts
30949
- const TrackingSubCategory = makeEnum({ Tracking: "TRACKING" });
31906
+ const TrackingSubCategory = makeEnum({
31907
+ /** Fallback subcategory */
31908
+ Tracking: "TRACKING" });
30950
31909
  //#endregion
30951
31910
  //#region src/subcategories/userProfile.ts
30952
31911
  const UserProfileSubCategory = makeEnum({
31912
+ /** A link to an individual's profile picture */
30953
31913
  ProfilePictureURL: "PROFILE_PICTURE_URL",
31914
+ /** An individual's profile picture */
30954
31915
  ProfilePictureImage: "PROFILE_PICTURE_IMAGE",
31916
+ /** The user's stated preferences while using an app */
30955
31917
  UserPreferences: "USER_PREFERENCES",
31918
+ /** Fallback subcategory */
30956
31919
  UserProfile: "USER_PROFILE"
30957
31920
  });
30958
31921
  //#endregion
@@ -31048,30 +32011,70 @@ let CustomizableText = /* @__PURE__ */ function(CustomizableText) {
31048
32011
  * The color palette that must be defined
31049
32012
  */
31050
32013
  const RequiredConfigurableColorPaletteColor = makeEnum({
32014
+ /**
32015
+ * Used everywhere...
32016
+ *
32017
+ * The primary color chosen by Company X will be applied by default to the following elements of the Privacy Center:
32018
+ * 1. **Hero background**
32019
+ * 2. **Sidebar navigation background**
32020
+ * 3. **Primary CTA (call to action)**
32021
+ * 4. **Primary links and active states**
32022
+ */
31051
32023
  Primary: "primary",
32024
+ /**
32025
+ * Used everywhere...
32026
+ *
32027
+ * The secondary color chosen by Company X will be applied by default to the following elements of the Privacy Center::
32028
+ * 1. **Secondary CTAs**
32029
+ * 2. **Secondary links**
32030
+ */
31052
32031
  Secondary: "secondary"
31053
32032
  });
31054
32033
  /**
31055
32034
  * The optional color pallette colors
31056
32035
  */
31057
32036
  const OptionalConfigurableColorPaletteColor = makeEnum({
32037
+ /**
32038
+ * The background color will be set by the primary color by default with the ability to change it to secondary color, black or white.
32039
+ */
31058
32040
  SidebarNavBg: "sidebarNavBg",
32041
+ /**
32042
+ * The hero background color
32043
+ */
31059
32044
  HeroBg: "heroBg",
32045
+ /**
32046
+ * The background of the widget
32047
+ */
31060
32048
  WidgetBg: "widgetBg",
32049
+ /** The main text color to use when text is shown on an object colored bg */
31061
32050
  TextOnBg: "textOnBg",
32051
+ /** A lighter text color to use when text is shown on an object colored bg */
31062
32052
  TextLightOnBg: "textLightOnBg",
32053
+ /** The main text color to use when text is shown on an object colored primary */
31063
32054
  TextOnPrimary: "textOnPrimary",
32055
+ /** Text on sidebar */
31064
32056
  TextOnSidebar: "textOnSidebar",
32057
+ /** Accent on sidebar */
31065
32058
  AccentOnSidebar: "accentOnSidebar",
32059
+ /** Text to use on hero */
31066
32060
  TextOnHero: "textOnHero",
32061
+ /** Text to use on About Transcend widget */
31067
32062
  TextOnAboutTranscend: "textOnAboutTranscend",
32063
+ /** Used to highlight text */
31068
32064
  Highlight: "highlight",
32065
+ /** The color of the table outline */
31069
32066
  TableOutline: "tableOutline",
32067
+ /** The page's accent background color (used in call-outs and asides) */
31070
32068
  BgAccent: "bgAccent",
32069
+ /** Error color -- something went wrong */
31071
32070
  Error: "error",
32071
+ /** White color */
31072
32072
  White: "white",
32073
+ /** Black color */
31073
32074
  Black: "black",
32075
+ /** Light gray color */
31074
32076
  Gray1: "gray1",
32077
+ /** Medium gray color */
31075
32078
  Gray4: "gray4"
31076
32079
  });
31077
32080
  /**
@@ -31105,13 +32108,17 @@ const PrivacyCenterTextStyles = t.partial(applyEnum(CustomizableText, () => Priv
31105
32108
  * Input for defining a new theme
31106
32109
  */
31107
32110
  const PrivacyCenterThemePartial = t.intersection([t.type({
32111
+ /** The display name of the theme */
31108
32112
  name: t.string,
32113
+ /** The theme colors */
31109
32114
  colors: PrivacyCenterConfigurableColorPalette
31110
32115
  }), t.partial({
32116
+ /** Styles to apply to components */
31111
32117
  componentStyles: PrivacyCenterComponentStyles,
32118
+ /** Override styles */
31112
32119
  textStyles: PrivacyCenterTextStyles
31113
32120
  })]);
31114
32121
  //#endregion
31115
- 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, 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, FooterConfig, FooterTheme, FullWidthContentLayout, HeaderTheme, 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, SemicolonDelimitedRegimeKeyString, ShadowRootOptions, SharedTopLevelConfig, SharedTopLevelTheme, SignedIabAgreementOption, SombraStandardScope, StaticTeamType, SubDataPointAttribute, SubDataPointAttributeSyncColumn, SubDataPointDataSubCategoryGuessStatus, TRANSCEND_SCOPES, TableEncryptionType, TelemetryPartitionStrategy, TemplateVariableModelName, Text, ThemeConfiguration, ThemeConfigurationBannerIntoModal, ThemeConfigurationBannerOnly, ThemeConfigurationModalOnly, ThemeKey, ToggleTheme, TranscendProduct, TriageAction, UIConfiguration, UIConfigurationBannerIntoModal, UIConfigurationBannerOnly, UIConfigurationModalOnly, UnknownRequestPolicy, UnstructuredSubDataPointRecommendationStatus, UspapiOption, VariantKey, VendorAttribute, VendorAttributeSyncColumn, VerticalAlign, getRegistryLink };
32122
+ 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, 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 };
31116
32123
 
31117
32124
  //# sourceMappingURL=index.mjs.map