Skip to main content

Variable: DataPatternResponseSchema

const DataPatternResponseSchema: ZodObject<{
  id: ZodOptional<ZodNullable<ZodString>>;
  name: ZodOptional<ZodNullable<ZodString>>;
  description: ZodOptional<ZodNullable<ZodString>>;
  tenant_id: ZodOptional<ZodNullable<ZodString>>;
  type: ZodOptional<ZodNullable<ZodEnum<["predefined", "custom", "file_property"]>>>;
  status: ZodOptional<ZodNullable<ZodEnum<["active", "disabled", "deleted", "deprecated", "silent"]>>>;
  license_type: ZodOptional<ZodNullable<ZodEnum<["standard", "enterprise", "essentials"]>>>;
  is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
  version: ZodOptional<ZodNullable<ZodNumber>>;
  detection_config: ZodOptional<ZodNullable<ZodObject<{
     technique: ZodEnum<["edm", "document_fingerprint", "trainable_classifier", "ml_document", "regex", "weighted_regex", "ml", "titus_tag", "wildfire", "file_property", "dictionary", "pab", "document_classifier"]>;
     supported_confidence_levels: ZodOptional<ZodNullable<ZodArray<ZodEnum<[..., ..., ...]>, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     technique: ZodEnum<["edm", "document_fingerprint", "trainable_classifier", "ml_document", "regex", "weighted_regex", "ml", "titus_tag", "wildfire", "file_property", "dictionary", "pab", "document_classifier"]>;
     supported_confidence_levels: ZodOptional<ZodNullable<ZodArray<ZodEnum<...>, "many">>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     technique: ZodEnum<["edm", "document_fingerprint", "trainable_classifier", "ml_document", "regex", "weighted_regex", "ml", "titus_tag", "wildfire", "file_property", "dictionary", "pab", "document_classifier"]>;
     supported_confidence_levels: ZodOptional<ZodNullable<ZodArray<ZodEnum<...>, "many">>>;
  }, ZodTypeAny, "passthrough">>>>;
  matching_rules: ZodOptional<ZodNullable<ZodObject<{
     delimiter: ZodOptional<ZodNullable<ZodString>>;
     proximity_distance: ZodOptional<ZodNullable<ZodNumber>>;
     proximity_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     regexes: ZodOptional<ZodNullable<ZodArray<ZodObject<{
        regex: ...;
        weight: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>>;
     metadata_criteria: ZodOptional<ZodNullable<ZodArray<ZodObject<{
        comparisonOperatorType: ...;
        name: ...;
        type: ...;
        value: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     delimiter: ZodOptional<ZodNullable<ZodString>>;
     proximity_distance: ZodOptional<ZodNullable<ZodNumber>>;
     proximity_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     regexes: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
     metadata_criteria: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     delimiter: ZodOptional<ZodNullable<ZodString>>;
     proximity_distance: ZodOptional<ZodNullable<ZodNumber>>;
     proximity_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     regexes: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
     metadata_criteria: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
  }, ZodTypeAny, "passthrough">>>>;
  tags: ZodOptional<ZodNullable<ZodObject<{
     classification: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     compliance: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     geography: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     classification: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     compliance: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     geography: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     classification: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     compliance: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     geography: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
  }, ZodTypeAny, "passthrough">>>>;
  audit_metadata: ZodOptional<ZodNullable<ZodObject<{
     created_at: ZodOptional<ZodNullable<ZodUnion<[ZodString, ZodNumber]>>>;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodUnion<[ZodString, ZodNumber]>>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     created_at: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     created_at: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
  }, ZodTypeAny, "passthrough">>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
  id: ZodOptional<ZodNullable<ZodString>>;
  name: ZodOptional<ZodNullable<ZodString>>;
  description: ZodOptional<ZodNullable<ZodString>>;
  tenant_id: ZodOptional<ZodNullable<ZodString>>;
  type: ZodOptional<ZodNullable<ZodEnum<["predefined", "custom", "file_property"]>>>;
  status: ZodOptional<ZodNullable<ZodEnum<["active", "disabled", "deleted", "deprecated", "silent"]>>>;
  license_type: ZodOptional<ZodNullable<ZodEnum<["standard", "enterprise", "essentials"]>>>;
  is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
  version: ZodOptional<ZodNullable<ZodNumber>>;
  detection_config: ZodOptional<ZodNullable<ZodObject<{
     technique: ZodEnum<["edm", "document_fingerprint", "trainable_classifier", "ml_document", "regex", "weighted_regex", "ml", "titus_tag", "wildfire", "file_property", "dictionary", "pab", "document_classifier"]>;
     supported_confidence_levels: ZodOptional<ZodNullable<ZodArray<ZodEnum<...>, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     technique: ZodEnum<["edm", "document_fingerprint", "trainable_classifier", "ml_document", "regex", "weighted_regex", "ml", "titus_tag", "wildfire", "file_property", "dictionary", "pab", "document_classifier"]>;
     supported_confidence_levels: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     technique: ZodEnum<["edm", "document_fingerprint", "trainable_classifier", "ml_document", "regex", "weighted_regex", "ml", "titus_tag", "wildfire", "file_property", "dictionary", "pab", "document_classifier"]>;
     supported_confidence_levels: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
  matching_rules: ZodOptional<ZodNullable<ZodObject<{
     delimiter: ZodOptional<ZodNullable<ZodString>>;
     proximity_distance: ZodOptional<ZodNullable<ZodNumber>>;
     proximity_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     regexes: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
     metadata_criteria: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     delimiter: ZodOptional<ZodNullable<ZodString>>;
     proximity_distance: ZodOptional<ZodNullable<ZodNumber>>;
     proximity_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     regexes: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     metadata_criteria: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     delimiter: ZodOptional<ZodNullable<ZodString>>;
     proximity_distance: ZodOptional<ZodNullable<ZodNumber>>;
     proximity_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     regexes: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     metadata_criteria: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
  tags: ZodOptional<ZodNullable<ZodObject<{
     classification: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     compliance: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     geography: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     classification: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     compliance: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     geography: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     classification: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     compliance: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     geography: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
  audit_metadata: ZodOptional<ZodNullable<ZodObject<{
     created_at: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     created_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     created_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
  }, ZodTypeAny, "passthrough">>>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
  id: ZodOptional<ZodNullable<ZodString>>;
  name: ZodOptional<ZodNullable<ZodString>>;
  description: ZodOptional<ZodNullable<ZodString>>;
  tenant_id: ZodOptional<ZodNullable<ZodString>>;
  type: ZodOptional<ZodNullable<ZodEnum<["predefined", "custom", "file_property"]>>>;
  status: ZodOptional<ZodNullable<ZodEnum<["active", "disabled", "deleted", "deprecated", "silent"]>>>;
  license_type: ZodOptional<ZodNullable<ZodEnum<["standard", "enterprise", "essentials"]>>>;
  is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
  version: ZodOptional<ZodNullable<ZodNumber>>;
  detection_config: ZodOptional<ZodNullable<ZodObject<{
     technique: ZodEnum<["edm", "document_fingerprint", "trainable_classifier", "ml_document", "regex", "weighted_regex", "ml", "titus_tag", "wildfire", "file_property", "dictionary", "pab", "document_classifier"]>;
     supported_confidence_levels: ZodOptional<ZodNullable<ZodArray<ZodEnum<...>, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     technique: ZodEnum<["edm", "document_fingerprint", "trainable_classifier", "ml_document", "regex", "weighted_regex", "ml", "titus_tag", "wildfire", "file_property", "dictionary", "pab", "document_classifier"]>;
     supported_confidence_levels: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     technique: ZodEnum<["edm", "document_fingerprint", "trainable_classifier", "ml_document", "regex", "weighted_regex", "ml", "titus_tag", "wildfire", "file_property", "dictionary", "pab", "document_classifier"]>;
     supported_confidence_levels: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
  matching_rules: ZodOptional<ZodNullable<ZodObject<{
     delimiter: ZodOptional<ZodNullable<ZodString>>;
     proximity_distance: ZodOptional<ZodNullable<ZodNumber>>;
     proximity_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     regexes: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
     metadata_criteria: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     delimiter: ZodOptional<ZodNullable<ZodString>>;
     proximity_distance: ZodOptional<ZodNullable<ZodNumber>>;
     proximity_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     regexes: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     metadata_criteria: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     delimiter: ZodOptional<ZodNullable<ZodString>>;
     proximity_distance: ZodOptional<ZodNullable<ZodNumber>>;
     proximity_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     regexes: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     metadata_criteria: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
  tags: ZodOptional<ZodNullable<ZodObject<{
     classification: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     compliance: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     geography: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     classification: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     compliance: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     geography: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     classification: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     compliance: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     geography: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
  audit_metadata: ZodOptional<ZodNullable<ZodObject<{
     created_at: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     created_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     created_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
  }, ZodTypeAny, "passthrough">>>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/models/dlp-data-pattern.ts:158

Response payload returned by GET / POST / PUT / PATCH on a data pattern.

Every optional field is .nullish() — the live API emits null (not undefined) for unset values.