@transcend-io/privacy-types 5.17.0 → 5.19.0

package/dist/index.d.mts

@@ -10660,6 +10660,48 @@ declare const UIConfiguration: t.UnionC<[t.IntersectionC<[t.TypeC<{
 /** Type override */
 type UIConfiguration = t.TypeOf<typeof UIConfiguration>;
 //#endregion
+//#region src/customFunction.d.ts
+/**
+ * The product-facing type of a custom function.
+ */
+declare const CustomFunctionType: {
+  /** DSR pre-flight enricher and datapoint resolver */Dsr: "DSR"; /** General purpose code execution */
+  General: "GENERAL";
+};
+/** Overload CustomFunctionType as a type */
+type CustomFunctionType = (typeof CustomFunctionType)[keyof typeof CustomFunctionType];
+/**
+ * The lifecycle state of a custom function.
+ */
+declare const CustomFunctionLifecycleState: {
+  /** The function exists but has no active version */Inactive: "INACTIVE"; /** The function has an active version */
+  Active: "ACTIVE"; /** The function is archived */
+  Archived: "ARCHIVED";
+};
+/** Overload CustomFunctionLifecycleState as a type */
+type CustomFunctionLifecycleState = (typeof CustomFunctionLifecycleState)[keyof typeof CustomFunctionLifecycleState];
+/**
+ * The lifecycle state of a custom function version.
+ */
+declare const CustomFunctionVersionLifecycleState: {
+  /** The version is the function's active version */Active: "ACTIVE"; /** The version is a draft pending promotion */
+  Draft: "DRAFT"; /** The version was superseded by a newer version */
+  Inactive: "INACTIVE";
+};
+/** Overload CustomFunctionVersionLifecycleState as a type */
+type CustomFunctionVersionLifecycleState = (typeof CustomFunctionVersionLifecycleState)[keyof typeof CustomFunctionVersionLifecycleState];
+/**
+ * The payload types a custom function can be invoked with, selecting which
+ * export the runtime executes.
+ */
+declare const CustomFunctionPayloadType: {
+  /** DSR datapoint resolver — invokes the `default` export */DataPoint: "DATA_POINT"; /** DSR pre-flight request enricher — invokes the `enricher` export */
+  RequestEnricher: "REQUEST_ENRICHER"; /** General purpose (Maestro) custom function */
+  Maestro: "MAESTRO";
+};
+/** Overload CustomFunctionPayloadType as a type */
+type CustomFunctionPayloadType = (typeof CustomFunctionPayloadType)[keyof typeof CustomFunctionPayloadType];
+//#endregion
 //#region src/database.d.ts
 /**
  * The database integrations
@@ -10889,6 +10931,23 @@ declare const DsrErrorCode: {
    * workflow config. `dataSiloIds` may only narrow the workflow's connected set.
    */
   DataSiloNotInWorkflow: "DATA_SILO_NOT_IN_WORKFLOW";
+  /**
+   * The `type` asserted on this request does not match the workflow config's
+   * request action. `type` is optional; omit it to derive from the workflow.
+   */
+  TypeNotMatchingWorkflow: "TYPE_NOT_MATCHING_WORKFLOW";
+  /**
+   * The `subjectType` asserted on this request does not match the workflow
+   * config's data subject type. `subjectType` is optional; omit it to derive
+   * from the workflow.
+   */
+  SubjectTypeNotMatchingWorkflow: "SUBJECT_TYPE_NOT_MATCHING_WORKFLOW";
+  /**
+   * The request region is not eligible for the workflow config's regionList.
+   * The supplied country or subdivision must match an entry in regionList when
+   * the workflow collects regions and regionList is non-empty.
+   */
+  RegionNotInWorkflow: "REGION_NOT_IN_WORKFLOW";
 };
 /** Type override */
 type DsrErrorCode = (typeof DsrErrorCode)[keyof typeof DsrErrorCode];
@@ -10934,6 +10993,31 @@ interface DataSiloNotInWorkflowMessageInput {
   /** dataSiloIds that are not connected to that workflow config */
   dataSiloIds: readonly string[];
 }
+/** Inputs for the {@link DsrErrorCode.TypeNotMatchingWorkflow} message builder. */
+interface TypeNotMatchingWorkflowMessageInput {
+  /** Workflow config the submission targeted */
+  workflowConfigId: string;
+  /** The request action (`type`) asserted on the input */
+  providedType: string;
+  /** The workflow config's actual request action */
+  workflowType: string;
+}
+/** Inputs for the {@link DsrErrorCode.SubjectTypeNotMatchingWorkflow} message builder. */
+interface SubjectTypeNotMatchingWorkflowMessageInput {
+  /** Workflow config the submission targeted */
+  workflowConfigId: string;
+  /** The data subject type asserted on the input */
+  providedSubjectType: string;
+  /** The workflow config's actual data subject type */
+  workflowSubjectType: string;
+}
+/** Inputs for the {@link DsrErrorCode.RegionNotInWorkflow} message builder. */
+interface RegionNotInWorkflowMessageInput {
+  /** Human-readable rejected region (e.g. `GB` or `US/US-CA`) */
+  region: string;
+  /** Workflow regionList entries that are eligible */
+  supportedRegions: readonly string[];
+}
 /** Canonical message builder for each {@link DsrErrorCode}. */
 type DsrErrorMessageMap = {
   [DsrErrorCode.InvalidWorkflowConfigId]: () => string;
@@ -10953,6 +11037,9 @@ type DsrErrorMessageMap = {
   [DsrErrorCode.UnsupportedIdentifierName]: (name: string) => string;
   [DsrErrorCode.MissingRequiredEmail]: () => string;
   [DsrErrorCode.DataSiloNotInWorkflow]: (input: DataSiloNotInWorkflowMessageInput) => string;
+  [DsrErrorCode.TypeNotMatchingWorkflow]: (input: TypeNotMatchingWorkflowMessageInput) => string;
+  [DsrErrorCode.SubjectTypeNotMatchingWorkflow]: (input: SubjectTypeNotMatchingWorkflowMessageInput) => string;
+  [DsrErrorCode.RegionNotInWorkflow]: (input: RegionNotInWorkflowMessageInput) => string;
 };
 /**
  * Canonical per-input DSR bulk submission error messages.
@@ -10993,6 +11080,20 @@ declare const DSR_ERROR_MESSAGE: {
     workflowConfigId,
     dataSiloIds
   }: DataSiloNotInWorkflowMessageInput) => string;
+  readonly TYPE_NOT_MATCHING_WORKFLOW: ({
+    workflowConfigId,
+    providedType,
+    workflowType
+  }: TypeNotMatchingWorkflowMessageInput) => string;
+  readonly SUBJECT_TYPE_NOT_MATCHING_WORKFLOW: ({
+    workflowConfigId,
+    providedSubjectType,
+    workflowSubjectType
+  }: SubjectTypeNotMatchingWorkflowMessageInput) => string;
+  readonly REGION_NOT_IN_WORKFLOW: ({
+    region,
+    supportedRegions
+  }: RegionNotInWorkflowMessageInput) => string;
 };
 //#endregion
 //#region src/dsrRequestOutcome.d.ts
@@ -64712,5 +64813,5 @@ declare const CollectDataSubjectRegions: {
 /** Override type */
 type CollectDataSubjectRegions = (typeof CollectDataSubjectRegions)[keyof typeof CollectDataSubjectRegions];
 //#endregion
-export { AbsoluteUrlString, ActionItemCode, ActionItemPriorityOverride, AirgapBundleAnalyticsBinInterval, AirgapBundleAnalyticsDimension, AirgapBundleAnalyticsMetric, AssessmentFormStatus, AssessmentFormTemplateSource, AssessmentFormTemplateStatus, AssessmentQuestionSubType, AssessmentQuestionType, AssessmentSyncColumn, AssessmentSyncColumnAttribute, AssessmentSyncColumnImmutable, 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, CollectDataSubjectRegions, 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, DROP_RECORD_ID_MAX_LENGTH, DSR_BULK_ERROR_MESSAGE, DSR_BULK_SUBMISSION_REJECTED_MESSAGE, DSR_ERROR_MESSAGE, DataCategoryType, DataFlowOrderField, DataFlowScope, DataFlowType, DataProtectionImpactAssessmentStatus, DataSiloAttribute, DataSiloAttributeSyncColumn, DataSiloNotInWorkflowMessageInput, DataSubCategoryAttribute, DataSubCategoryAttributeSyncColumn, DatabaseDriver, DatabaseIntegration, DatabaseSqlVariablesForPrivacyRequest, DatabaseVariables, DecryptionStatus, DefaultConsentOption, DefaultDataSubCategoryType, DefaultPurposeSubCategoryType, DescriptionTextTheme, DropListType, DsrBulkErrorCode, DsrBulkErrorMessageMap, DsrErrorCode, DsrErrorMessageMap, DsrRequestOutcome, 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, MAX_DROP_RECORDS_PER_REQUEST, MAX_UNKNOWN_DROP_RECORDS_IN_ERROR, MacroRegion, MobileUiLoadOptions, 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, OneTrustUserGroups, OneTrustUserMetadata, OneTrustUserName, OptionalConfigurableColorPaletteColor, OrderDirection, PROMPT_FILE_PURPOSE_TO_OPEN_AI, PaddedContentLayout, PolicyType, Preference, PreferenceQueryResponseItem, PreferenceStoreAuthLevel, PreferenceStoreConsentFields, PreferenceStoreIdentifier, PreferenceStoreKeyConditionals, PreferenceStorePurposeResponse, PreferenceStorePurposeUpdate, PreferenceStoreSystemAttributes, PreferenceStoreWorkflowSettings, PreferenceTopicType, PreferenceUpdateItem, PreflightRequestStatus, PrivacyCenterComponentStyles, PrivacyCenterConfigurableColorPalette, PrivacyCenterFont, PrivacyCenterFontBasic, PrivacyCenterFooterLayout, 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, REQUEST_SUBMISSION_LIMIT, RegimeKey, RegionDetectionMethod, RegionsOperator, RequestAction, RequestActionObjectResolver, RequestActionOptIn, RequestActionOptOut, RequestDataSiloStatus, RequestEnricherStatus, RequestOrigin, RequestStatus, RequiredConfigurableColorPaletteColor, RestartIdentifierStrategy, RestartTimeLimitExceededMessageInput, RetentionScheduleOperation, RetentionScheduleType, RetentionType, RgbHexString, RgbaHexString, SQLDriverWithDataMapping, ScopeDefinition, 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, URLHostString, UiVariantStatus, UnknownDropRecordsMessageInput, UnknownRequestPolicy, UnstructuredSubDataPointRecommendationStatus, UspapiOption, VariantKey, VendorAttribute, VendorAttributeSyncColumn, VerticalAlign, WorkflowConfigType, WorkflowConfigVisibility, getRegistryLink };
+export { AbsoluteUrlString, ActionItemCode, ActionItemPriorityOverride, AirgapBundleAnalyticsBinInterval, AirgapBundleAnalyticsDimension, AirgapBundleAnalyticsMetric, AssessmentFormStatus, AssessmentFormTemplateSource, AssessmentFormTemplateStatus, AssessmentQuestionSubType, AssessmentQuestionType, AssessmentSyncColumn, AssessmentSyncColumnAttribute, AssessmentSyncColumnImmutable, 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, CollectDataSubjectRegions, 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, CustomFunctionLifecycleState, CustomFunctionPayloadType, CustomFunctionType, CustomFunctionVersionLifecycleState, CustomizableComponent, CustomizableText, DEFAULT_MACROREGIONS_MAP, DOMElementId, DROP_RECORD_ID_MAX_LENGTH, DSR_BULK_ERROR_MESSAGE, DSR_BULK_SUBMISSION_REJECTED_MESSAGE, DSR_ERROR_MESSAGE, DataCategoryType, DataFlowOrderField, DataFlowScope, DataFlowType, DataProtectionImpactAssessmentStatus, DataSiloAttribute, DataSiloAttributeSyncColumn, DataSiloNotInWorkflowMessageInput, DataSubCategoryAttribute, DataSubCategoryAttributeSyncColumn, DatabaseDriver, DatabaseIntegration, DatabaseSqlVariablesForPrivacyRequest, DatabaseVariables, DecryptionStatus, DefaultConsentOption, DefaultDataSubCategoryType, DefaultPurposeSubCategoryType, DescriptionTextTheme, DropListType, DsrBulkErrorCode, DsrBulkErrorMessageMap, DsrErrorCode, DsrErrorMessageMap, DsrRequestOutcome, 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, MAX_DROP_RECORDS_PER_REQUEST, MAX_UNKNOWN_DROP_RECORDS_IN_ERROR, MacroRegion, MobileUiLoadOptions, 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, OneTrustUserGroups, OneTrustUserMetadata, OneTrustUserName, OptionalConfigurableColorPaletteColor, OrderDirection, PROMPT_FILE_PURPOSE_TO_OPEN_AI, PaddedContentLayout, PolicyType, Preference, PreferenceQueryResponseItem, PreferenceStoreAuthLevel, PreferenceStoreConsentFields, PreferenceStoreIdentifier, PreferenceStoreKeyConditionals, PreferenceStorePurposeResponse, PreferenceStorePurposeUpdate, PreferenceStoreSystemAttributes, PreferenceStoreWorkflowSettings, PreferenceTopicType, PreferenceUpdateItem, PreflightRequestStatus, PrivacyCenterComponentStyles, PrivacyCenterConfigurableColorPalette, PrivacyCenterFont, PrivacyCenterFontBasic, PrivacyCenterFooterLayout, 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, REQUEST_SUBMISSION_LIMIT, RegimeKey, RegionDetectionMethod, RegionNotInWorkflowMessageInput, RegionsOperator, RequestAction, RequestActionObjectResolver, RequestActionOptIn, RequestActionOptOut, RequestDataSiloStatus, RequestEnricherStatus, RequestOrigin, RequestStatus, RequiredConfigurableColorPaletteColor, RestartIdentifierStrategy, RestartTimeLimitExceededMessageInput, RetentionScheduleOperation, RetentionScheduleType, RetentionType, RgbHexString, RgbaHexString, SQLDriverWithDataMapping, ScopeDefinition, ScopeName, ScopeType, SecondLayerConfig, SecondLayerTheme, SecondLayerThemeMinimal, SemicolonDelimitedRegimeKeyString, ShadowRootOptions, SharedTopLevelConfig, SharedTopLevelTheme, SignedIabAgreementOption, SombraStandardScope, StaticTeamType, SubDataPointAttribute, SubDataPointAttributeSyncColumn, SubDataPointDataSubCategoryGuessStatus, SubjectTypeNotMatchingWorkflowMessageInput, TRANSCEND_SCOPES, TableEncryptionType, TelemetryPartitionStrategy, TemplateVariableModelName, Text, ThemeConfiguration, ThemeConfigurationBannerIntoModal, ThemeConfigurationBannerIntoModalMinimal, ThemeConfigurationBannerOnly, ThemeConfigurationBannerOnlyMinimal, ThemeConfigurationMinimal, ThemeConfigurationModalOnly, ThemeConfigurationModalOnlyMinimal, ThemeKey, ToggleTheme, TranscendProduct, TriageAction, TypeNotMatchingWorkflowMessageInput, UIConfiguration, UIConfigurationBannerIntoModal, UIConfigurationBannerOnly, UIConfigurationModalOnly, URLHostString, UiVariantStatus, UnknownDropRecordsMessageInput, UnknownRequestPolicy, UnstructuredSubDataPointRecommendationStatus, UspapiOption, VariantKey, VendorAttribute, VendorAttributeSyncColumn, VerticalAlign, WorkflowConfigType, WorkflowConfigVisibility, getRegistryLink };
 //# sourceMappingURL=index.d.mts.map