Skip to main content

Variable: DictionaryResponseSchema

const DictionaryResponseSchema: ZodObject<{
  id: ZodOptional<ZodNullable<ZodString>>;
  name: ZodOptional<ZodNullable<ZodString>>;
  description: ZodOptional<ZodNullable<ZodString>>;
  category: ZodOptional<ZodNullable<ZodString>>;
  region_name: ZodOptional<ZodNullable<ZodString>>;
  type: ZodOptional<ZodNullable<ZodEnum<["predefined", "custom"]>>>;
  is_case_sensitive: ZodOptional<ZodNullable<ZodBoolean>>;
  is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
  detection_technique: ZodOptional<ZodNullable<ZodEnum<["edm", "document_fingerprint", "trainable_classifier", "ml_document", "regex", "weighted_regex", "ml", "titus_tag", "wildfire", "file_property", "dictionary", "pab", "document_classifier"]>>>;
  detection_sub_technique: ZodOptional<ZodNullable<ZodEnum<["dnn", "gamma", "ml_gateway", "encoding", "password_protected", "encryption", "compression", "threshold"]>>>;
  dictionary_metadata: ZodOptional<ZodNullable<ZodObject<{
     number_of_keywords: ZodOptional<ZodNullable<ZodNumber>>;
     original_file_name: ZodOptional<ZodNullable<ZodString>>;
     original_file_size_in_byte: ZodOptional<ZodNullable<ZodNumber>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     number_of_keywords: ZodOptional<ZodNullable<ZodNumber>>;
     original_file_name: ZodOptional<ZodNullable<ZodString>>;
     original_file_size_in_byte: ZodOptional<ZodNullable<ZodNumber>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     number_of_keywords: ZodOptional<ZodNullable<ZodNumber>>;
     original_file_name: ZodOptional<ZodNullable<ZodString>>;
     original_file_size_in_byte: ZodOptional<ZodNullable<ZodNumber>>;
  }, ZodTypeAny, "passthrough">>>>;
  keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
  tags: ZodOptional<ZodNullable<ZodObject<{
     classification: ZodOptional<ZodNullable<ZodArray<ZodEnum<[..., ...]>, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     classification: ZodOptional<ZodNullable<ZodArray<ZodEnum<...>, "many">>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     classification: ZodOptional<ZodNullable<ZodArray<ZodEnum<...>, "many">>>;
  }, ZodTypeAny, "passthrough">>>>;
  attributes: ZodOptional<ZodNullable<ZodArray<ZodObject<{
     key: ZodOptional<ZodNullable<ZodString>>;
     value: ZodOptional<ZodNullable<ZodString>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     key: ZodOptional<ZodNullable<ZodString>>;
     value: ZodOptional<ZodNullable<ZodString>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     key: ZodOptional<ZodNullable<ZodString>>;
     value: ZodOptional<ZodNullable<ZodString>>;
  }, ZodTypeAny, "passthrough">>, "many">>>;
  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>>;
  category: ZodOptional<ZodNullable<ZodString>>;
  region_name: ZodOptional<ZodNullable<ZodString>>;
  type: ZodOptional<ZodNullable<ZodEnum<["predefined", "custom"]>>>;
  is_case_sensitive: ZodOptional<ZodNullable<ZodBoolean>>;
  is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
  detection_technique: ZodOptional<ZodNullable<ZodEnum<["edm", "document_fingerprint", "trainable_classifier", "ml_document", "regex", "weighted_regex", "ml", "titus_tag", "wildfire", "file_property", "dictionary", "pab", "document_classifier"]>>>;
  detection_sub_technique: ZodOptional<ZodNullable<ZodEnum<["dnn", "gamma", "ml_gateway", "encoding", "password_protected", "encryption", "compression", "threshold"]>>>;
  dictionary_metadata: ZodOptional<ZodNullable<ZodObject<{
     number_of_keywords: ZodOptional<ZodNullable<ZodNumber>>;
     original_file_name: ZodOptional<ZodNullable<ZodString>>;
     original_file_size_in_byte: ZodOptional<ZodNullable<ZodNumber>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     number_of_keywords: ZodOptional<ZodNullable<ZodNumber>>;
     original_file_name: ZodOptional<ZodNullable<ZodString>>;
     original_file_size_in_byte: ZodOptional<ZodNullable<ZodNumber>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     number_of_keywords: ZodOptional<ZodNullable<ZodNumber>>;
     original_file_name: ZodOptional<ZodNullable<ZodString>>;
     original_file_size_in_byte: ZodOptional<ZodNullable<ZodNumber>>;
  }, ZodTypeAny, "passthrough">>>>;
  keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
  tags: ZodOptional<ZodNullable<ZodObject<{
     classification: ZodOptional<ZodNullable<ZodArray<ZodEnum<...>, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     classification: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     classification: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
  attributes: ZodOptional<ZodNullable<ZodArray<ZodObject<{
     key: ZodOptional<ZodNullable<ZodString>>;
     value: ZodOptional<ZodNullable<ZodString>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     key: ZodOptional<ZodNullable<...>>;
     value: ZodOptional<ZodNullable<...>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     key: ZodOptional<ZodNullable<...>>;
     value: ZodOptional<ZodNullable<...>>;
  }, ZodTypeAny, "passthrough">>, "many">>>;
  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>>;
  category: ZodOptional<ZodNullable<ZodString>>;
  region_name: ZodOptional<ZodNullable<ZodString>>;
  type: ZodOptional<ZodNullable<ZodEnum<["predefined", "custom"]>>>;
  is_case_sensitive: ZodOptional<ZodNullable<ZodBoolean>>;
  is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
  detection_technique: ZodOptional<ZodNullable<ZodEnum<["edm", "document_fingerprint", "trainable_classifier", "ml_document", "regex", "weighted_regex", "ml", "titus_tag", "wildfire", "file_property", "dictionary", "pab", "document_classifier"]>>>;
  detection_sub_technique: ZodOptional<ZodNullable<ZodEnum<["dnn", "gamma", "ml_gateway", "encoding", "password_protected", "encryption", "compression", "threshold"]>>>;
  dictionary_metadata: ZodOptional<ZodNullable<ZodObject<{
     number_of_keywords: ZodOptional<ZodNullable<ZodNumber>>;
     original_file_name: ZodOptional<ZodNullable<ZodString>>;
     original_file_size_in_byte: ZodOptional<ZodNullable<ZodNumber>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     number_of_keywords: ZodOptional<ZodNullable<ZodNumber>>;
     original_file_name: ZodOptional<ZodNullable<ZodString>>;
     original_file_size_in_byte: ZodOptional<ZodNullable<ZodNumber>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     number_of_keywords: ZodOptional<ZodNullable<ZodNumber>>;
     original_file_name: ZodOptional<ZodNullable<ZodString>>;
     original_file_size_in_byte: ZodOptional<ZodNullable<ZodNumber>>;
  }, ZodTypeAny, "passthrough">>>>;
  keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
  tags: ZodOptional<ZodNullable<ZodObject<{
     classification: ZodOptional<ZodNullable<ZodArray<ZodEnum<...>, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     classification: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     classification: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
  attributes: ZodOptional<ZodNullable<ZodArray<ZodObject<{
     key: ZodOptional<ZodNullable<ZodString>>;
     value: ZodOptional<ZodNullable<ZodString>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     key: ZodOptional<ZodNullable<...>>;
     value: ZodOptional<ZodNullable<...>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     key: ZodOptional<ZodNullable<...>>;
     value: ZodOptional<ZodNullable<...>>;
  }, ZodTypeAny, "passthrough">>, "many">>>;
  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-dictionary.ts:130

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

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