Class: DictionariesClient

Defined in: src/management/dlp/dictionaries.ts:72

Client for the DLP Dictionaries resource (/v2/api/dictionaries).

POST and PUT take a multipart body with json (the metadata) and file (the keyword file) parts. PATCH uses JSON Merge Patch. DELETE returns 204 No Content. PUT can return either a 200 with the resource or a 204 with no body, so DictionariesClient.replace returns DictionaryResponse | undefined.

Constructors

Constructor

new DictionariesClient(opts): DictionariesClient;

Defined in: src/management/dlp/dictionaries.ts:77

Parameters

Parameter	Type
`opts`	`DictionariesClientOptions`

Returns

DictionariesClient

Methods

list()

list(params?): Promise<objectOutputType<{
  content: ZodArray<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<...>;
        original_file_name: ZodOptional<...>;
        original_file_size_in_byte: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        number_of_keywords: ...;
        original_file_name: ...;
        original_file_size_in_byte: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        number_of_keywords: ...;
        original_file_name: ...;
        original_file_size_in_byte: ...;
     }, ZodTypeAny, "passthrough">>>>;
     keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     tags: ZodOptional<ZodNullable<ZodObject<{
        classification: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        classification: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        classification: ...;
     }, ZodTypeAny, "passthrough">>>>;
     attributes: ZodOptional<ZodNullable<ZodArray<ZodObject<{
        key: ...;
        value: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>>;
     audit_metadata: ZodOptional<ZodNullable<ZodObject<{
        created_at: ZodOptional<...>;
        created_by: ZodOptional<...>;
        updated_at: ZodOptional<...>;
        updated_by: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        created_at: ...;
        created_by: ...;
        updated_at: ...;
        updated_by: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        created_at: ...;
        created_by: ...;
        updated_at: ...;
        updated_by: ...;
     }, 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<[..., ...]>>>;
     is_case_sensitive: ZodOptional<ZodNullable<ZodBoolean>>;
     is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
     detection_technique: ZodOptional<ZodNullable<ZodEnum<[..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ...]>>>;
     detection_sub_technique: ZodOptional<ZodNullable<ZodEnum<[..., ..., ..., ..., ..., ..., ..., ...]>>>;
     dictionary_metadata: ZodOptional<ZodNullable<ZodObject<{
        number_of_keywords: ...;
        original_file_name: ...;
        original_file_size_in_byte: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
     keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     tags: ZodOptional<ZodNullable<ZodObject<{
        classification: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
     attributes: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
     audit_metadata: ZodOptional<ZodNullable<ZodObject<{
        created_at: ...;
        created_by: ...;
        updated_at: ...;
        updated_by: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
   }, 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<[..., ...]>>>;
     is_case_sensitive: ZodOptional<ZodNullable<ZodBoolean>>;
     is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
     detection_technique: ZodOptional<ZodNullable<ZodEnum<[..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ...]>>>;
     detection_sub_technique: ZodOptional<ZodNullable<ZodEnum<[..., ..., ..., ..., ..., ..., ..., ...]>>>;
     dictionary_metadata: ZodOptional<ZodNullable<ZodObject<{
        number_of_keywords: ...;
        original_file_name: ...;
        original_file_size_in_byte: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
     keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     tags: ZodOptional<ZodNullable<ZodObject<{
        classification: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
     attributes: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
     audit_metadata: ZodOptional<ZodNullable<ZodObject<{
        created_at: ...;
        created_by: ...;
        updated_at: ...;
        updated_by: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
  }, ZodTypeAny, "passthrough">>, "many">;
  empty: ZodOptional<ZodBoolean>;
  first: ZodOptional<ZodBoolean>;
  last: ZodOptional<ZodBoolean>;
  number: ZodOptional<ZodNumber>;
  numberOfElements: ZodOptional<ZodNumber>;
  pageable: ZodOptional<ZodObject<{
     offset: ZodOptional<ZodNumber>;
     pageNumber: ZodOptional<ZodNumber>;
     pageSize: ZodOptional<ZodNumber>;
     paged: ZodOptional<ZodBoolean>;
     unpaged: ZodOptional<ZodBoolean>;
     sort: ZodOptional<ZodObject<{
        empty: ZodOptional<ZodBoolean>;
        sorted: ZodOptional<ZodBoolean>;
        unsorted: ZodOptional<ZodBoolean>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        empty: ZodOptional<...>;
        sorted: ZodOptional<...>;
        unsorted: ZodOptional<...>;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        empty: ZodOptional<...>;
        sorted: ZodOptional<...>;
        unsorted: ZodOptional<...>;
     }, ZodTypeAny, "passthrough">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     offset: ZodOptional<ZodNumber>;
     pageNumber: ZodOptional<ZodNumber>;
     pageSize: ZodOptional<ZodNumber>;
     paged: ZodOptional<ZodBoolean>;
     unpaged: ZodOptional<ZodBoolean>;
     sort: ZodOptional<ZodObject<{
        empty: ZodOptional<...>;
        sorted: ZodOptional<...>;
        unsorted: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        empty: ...;
        sorted: ...;
        unsorted: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        empty: ...;
        sorted: ...;
        unsorted: ...;
     }, ZodTypeAny, "passthrough">>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     offset: ZodOptional<ZodNumber>;
     pageNumber: ZodOptional<ZodNumber>;
     pageSize: ZodOptional<ZodNumber>;
     paged: ZodOptional<ZodBoolean>;
     unpaged: ZodOptional<ZodBoolean>;
     sort: ZodOptional<ZodObject<{
        empty: ZodOptional<...>;
        sorted: ZodOptional<...>;
        unsorted: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        empty: ...;
        sorted: ...;
        unsorted: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        empty: ...;
        sorted: ...;
        unsorted: ...;
     }, ZodTypeAny, "passthrough">>>;
  }, ZodTypeAny, "passthrough">>>;
  size: ZodOptional<ZodNumber>;
  sort: ZodOptional<ZodObject<{
     empty: ZodOptional<ZodBoolean>;
     sorted: ZodOptional<ZodBoolean>;
     unsorted: ZodOptional<ZodBoolean>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     empty: ZodOptional<ZodBoolean>;
     sorted: ZodOptional<ZodBoolean>;
     unsorted: ZodOptional<ZodBoolean>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     empty: ZodOptional<ZodBoolean>;
     sorted: ZodOptional<ZodBoolean>;
     unsorted: ZodOptional<ZodBoolean>;
  }, ZodTypeAny, "passthrough">>>;
  totalElements: ZodOptional<ZodNumber>;
  totalPages: ZodOptional<ZodNumber>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/management/dlp/dictionaries.ts:98

List dictionaries. Returns the Spring Page<> envelope verbatim.

Parameters

Parameter	Type
`params`	`DictionaryListParams`

Returns

Promise<objectOutputType<{ content: ZodArray<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<...>; original_file_name: ZodOptional<...>; original_file_size_in_byte: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ number_of_keywords: ...; original_file_name: ...; original_file_size_in_byte: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ number_of_keywords: ...; original_file_name: ...; original_file_size_in_byte: ...; }, ZodTypeAny, "passthrough">>>>; keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; tags: ZodOptional<ZodNullable<ZodObject<{ classification: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ classification: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ classification: ...; }, ZodTypeAny, "passthrough">>>>; attributes: ZodOptional<ZodNullable<ZodArray<ZodObject<{ key: ...; value: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>>; audit_metadata: ZodOptional<ZodNullable<ZodObject<{ created_at: ZodOptional<...>; created_by: ZodOptional<...>; updated_at: ZodOptional<...>; updated_by: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ created_at: ...; created_by: ...; updated_at: ...; updated_by: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ created_at: ...; created_by: ...; updated_at: ...; updated_by: ...; }, 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<[..., ...]>>>; is_case_sensitive: ZodOptional<ZodNullable<ZodBoolean>>; is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>; detection_technique: ZodOptional<ZodNullable<ZodEnum<[..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ...]>>>; detection_sub_technique: ZodOptional<ZodNullable<ZodEnum<[..., ..., ..., ..., ..., ..., ..., ...]>>>; dictionary_metadata: ZodOptional<ZodNullable<ZodObject<{ number_of_keywords: ...; original_file_name: ...; original_file_size_in_byte: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>; keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; tags: ZodOptional<ZodNullable<ZodObject<{ classification: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>; attributes: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>; audit_metadata: ZodOptional<ZodNullable<ZodObject<{ created_at: ...; created_by: ...; updated_at: ...; updated_by: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>; }, 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<[..., ...]>>>; is_case_sensitive: ZodOptional<ZodNullable<ZodBoolean>>; is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>; detection_technique: ZodOptional<ZodNullable<ZodEnum<[..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ...]>>>; detection_sub_technique: ZodOptional<ZodNullable<ZodEnum<[..., ..., ..., ..., ..., ..., ..., ...]>>>; dictionary_metadata: ZodOptional<ZodNullable<ZodObject<{ number_of_keywords: ...; original_file_name: ...; original_file_size_in_byte: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>; keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; tags: ZodOptional<ZodNullable<ZodObject<{ classification: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>; attributes: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>; audit_metadata: ZodOptional<ZodNullable<ZodObject<{ created_at: ...; created_by: ...; updated_at: ...; updated_by: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>; }, ZodTypeAny, "passthrough">>, "many">; empty: ZodOptional<ZodBoolean>; first: ZodOptional<ZodBoolean>; last: ZodOptional<ZodBoolean>; number: ZodOptional<ZodNumber>; numberOfElements: ZodOptional<ZodNumber>; pageable: ZodOptional<ZodObject<{ offset: ZodOptional<ZodNumber>; pageNumber: ZodOptional<ZodNumber>; pageSize: ZodOptional<ZodNumber>; paged: ZodOptional<ZodBoolean>; unpaged: ZodOptional<ZodBoolean>; sort: ZodOptional<ZodObject<{ empty: ZodOptional<ZodBoolean>; sorted: ZodOptional<ZodBoolean>; unsorted: ZodOptional<ZodBoolean>; }, "passthrough", ZodTypeAny, objectOutputType<{ empty: ZodOptional<...>; sorted: ZodOptional<...>; unsorted: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ empty: ZodOptional<...>; sorted: ZodOptional<...>; unsorted: ZodOptional<...>; }, ZodTypeAny, "passthrough">>>; }, "passthrough", ZodTypeAny, objectOutputType<{ offset: ZodOptional<ZodNumber>; pageNumber: ZodOptional<ZodNumber>; pageSize: ZodOptional<ZodNumber>; paged: ZodOptional<ZodBoolean>; unpaged: ZodOptional<ZodBoolean>; sort: ZodOptional<ZodObject<{ empty: ZodOptional<...>; sorted: ZodOptional<...>; unsorted: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ empty: ...; sorted: ...; unsorted: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ empty: ...; sorted: ...; unsorted: ...; }, ZodTypeAny, "passthrough">>>; }, ZodTypeAny, "passthrough">, objectInputType<{ offset: ZodOptional<ZodNumber>; pageNumber: ZodOptional<ZodNumber>; pageSize: ZodOptional<ZodNumber>; paged: ZodOptional<ZodBoolean>; unpaged: ZodOptional<ZodBoolean>; sort: ZodOptional<ZodObject<{ empty: ZodOptional<...>; sorted: ZodOptional<...>; unsorted: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ empty: ...; sorted: ...; unsorted: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ empty: ...; sorted: ...; unsorted: ...; }, ZodTypeAny, "passthrough">>>; }, ZodTypeAny, "passthrough">>>; size: ZodOptional<ZodNumber>; sort: ZodOptional<ZodObject<{ empty: ZodOptional<ZodBoolean>; sorted: ZodOptional<ZodBoolean>; unsorted: ZodOptional<ZodBoolean>; }, "passthrough", ZodTypeAny, objectOutputType<{ empty: ZodOptional<ZodBoolean>; sorted: ZodOptional<ZodBoolean>; unsorted: ZodOptional<ZodBoolean>; }, ZodTypeAny, "passthrough">, objectInputType<{ empty: ZodOptional<ZodBoolean>; sorted: ZodOptional<ZodBoolean>; unsorted: ZodOptional<ZodBoolean>; }, ZodTypeAny, "passthrough">>>; totalElements: ZodOptional<ZodNumber>; totalPages: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>

Example

import { ManagementClient } from '@cdot65/prisma-airs-sdk';
const mgmt = new ManagementClient();

const page = await mgmt.dlp.dictionaries.list({ size: 5 });
// page =>
// {
//   content: [{ id: 'dict-1', name: 'PII', category: 'Confidential', region_name: 'us', type: 'custom' }],
//   totalElements: 1, totalPages: 1, number: 0, size: 20, first: true, last: true
// }

create()

create(__namedParameters): Promise<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">>;

Defined in: src/management/dlp/dictionaries.ts:139

Create a dictionary by uploading a keyword file. Sends a multipart body — the SDK does not set Content-Type so the runtime can write the correct boundary.

Parameters

Parameter	Type
`__namedParameters`	`DictionaryUploadParams`

Returns

Promise<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">>

Example

import { ManagementClient } from '@cdot65/prisma-airs-sdk';
const mgmt = new ManagementClient();

const created = await mgmt.dlp.dictionaries.create({
  metadata: {
    category: 'Confidential',
    name: 'PII',
    original_file_name: 'keywords.txt',
    region_name: 'us-west-2',
    type: 'custom',
  },
  file: 'alpha\nbravo\ncharlie\n',
  includeKeywords: true,
});
// created =>
// { id: 'dict-1', name: 'PII', category: 'Confidential', region_name: 'us-west-2', type: 'custom' }

get()

get(resourceId, params?): Promise<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">>;

Defined in: src/management/dlp/dictionaries.ts:171

Get a single dictionary by resource ID, optionally including its keyword list.

Parameters

Parameter	Type
`resourceId`	`string`
`params`	`DictionaryGetParams`

Returns

Example

import { ManagementClient } from '@cdot65/prisma-airs-sdk';
const mgmt = new ManagementClient();

const dict = await mgmt.dlp.dictionaries.get('dict-1', { includeKeywords: true });
// dict =>
// { id: 'dict-1', name: 'PII', category: 'Confidential', type: 'custom', keywords: ['alpha', 'bravo'] }

replace()

replace(resourceId, __namedParameters): Promise<
  | 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<...>>;
     original_file_name: ZodOptional<ZodNullable<...>>;
     original_file_size_in_byte: ZodOptional<ZodNullable<...>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     number_of_keywords: ZodOptional<ZodNullable<...>>;
     original_file_name: ZodOptional<ZodNullable<...>>;
     original_file_size_in_byte: ZodOptional<ZodNullable<...>>;
  }, ZodTypeAny, "passthrough">>>>;
  keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
  tags: ZodOptional<ZodNullable<ZodObject<{
     classification: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     classification: ZodOptional<ZodNullable<...>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     classification: ZodOptional<ZodNullable<...>>;
  }, ZodTypeAny, "passthrough">>>>;
  attributes: ZodOptional<ZodNullable<ZodArray<ZodObject<{
     key: ZodOptional<ZodNullable<...>>;
     value: ZodOptional<ZodNullable<...>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     key: ZodOptional<...>;
     value: ZodOptional<...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     key: ZodOptional<...>;
     value: ZodOptional<...>;
  }, 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<...>>;
     created_by: ZodOptional<ZodNullable<...>>;
     updated_at: ZodOptional<ZodNullable<...>>;
     updated_by: ZodOptional<ZodNullable<...>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     created_at: ZodOptional<ZodNullable<...>>;
     created_by: ZodOptional<ZodNullable<...>>;
     updated_at: ZodOptional<ZodNullable<...>>;
     updated_by: ZodOptional<ZodNullable<...>>;
  }, ZodTypeAny, "passthrough">>>>;
}, ZodTypeAny, "passthrough">
| undefined>;

Defined in: src/management/dlp/dictionaries.ts:209

Full-replace the dictionary at resourceId via multipart upload.

The API may respond with either 200 + body or 204 + no body — both are normal. Returns the parsed body on 200 and undefined on 204.

Parameters

Parameter	Type
`resourceId`	`string`
`__namedParameters`	`DictionaryUploadParams`

Returns

Promise< | 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<...>>; original_file_name: ZodOptional<ZodNullable<...>>; original_file_size_in_byte: ZodOptional<ZodNullable<...>>; }, ZodTypeAny, "passthrough">, objectInputType<{ number_of_keywords: ZodOptional<ZodNullable<...>>; original_file_name: ZodOptional<ZodNullable<...>>; original_file_size_in_byte: ZodOptional<ZodNullable<...>>; }, ZodTypeAny, "passthrough">>>>; keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; tags: ZodOptional<ZodNullable<ZodObject<{ classification: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, "passthrough", ZodTypeAny, objectOutputType<{ classification: ZodOptional<ZodNullable<...>>; }, ZodTypeAny, "passthrough">, objectInputType<{ classification: ZodOptional<ZodNullable<...>>; }, ZodTypeAny, "passthrough">>>>; attributes: ZodOptional<ZodNullable<ZodArray<ZodObject<{ key: ZodOptional<ZodNullable<...>>; value: ZodOptional<ZodNullable<...>>; }, "passthrough", ZodTypeAny, objectOutputType<{ key: ZodOptional<...>; value: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ key: ZodOptional<...>; value: ZodOptional<...>; }, 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<...>>; created_by: ZodOptional<ZodNullable<...>>; updated_at: ZodOptional<ZodNullable<...>>; updated_by: ZodOptional<ZodNullable<...>>; }, ZodTypeAny, "passthrough">, objectInputType<{ created_at: ZodOptional<ZodNullable<...>>; created_by: ZodOptional<ZodNullable<...>>; updated_at: ZodOptional<ZodNullable<...>>; updated_by: ZodOptional<ZodNullable<...>>; }, ZodTypeAny, "passthrough">>>>; }, ZodTypeAny, "passthrough"> | undefined>

Example

import { ManagementClient } from '@cdot65/prisma-airs-sdk';
const mgmt = new ManagementClient();

const replaced = await mgmt.dlp.dictionaries.replace('dict-1', {
  metadata: {
    category: 'Confidential',
    name: 'PII',
    original_file_name: 'keywords.txt',
    region_name: 'us-west-2',
    type: 'custom',
  },
  file: 'alpha\nbravo\ncharlie\ndelta\n',
});
// replaced => { id: 'dict-1', name: 'PII', ... } on 200, or undefined on 204

patch()

patch(resourceId, body): Promise<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">>;

Defined in: src/management/dlp/dictionaries.ts:247

Partial update via JSON Merge Patch (RFC 7396). Sent with Content-Type: application/merge-patch+json.

Parameters

Parameter	Type
`resourceId`	`string`
`body`	`objectOutputType`

Returns

Example

import { ManagementClient } from '@cdot65/prisma-airs-sdk';
const mgmt = new ManagementClient();

const patched = await mgmt.dlp.dictionaries.patch('dict-1', {
  category: 'Confidential',
  name: 'PII',
  original_file_name: 'keywords.txt',
  description: 'Updated by SDK',
});
// patched =>
// { id: 'dict-1', name: 'PII', category: 'Confidential', description: 'Updated by SDK' }

delete()

delete(resourceId): Promise<void>;

Defined in: src/management/dlp/dictionaries.ts:271

Delete a dictionary. Resolves to undefined on the 204 No Content response.

Parameters

Parameter	Type
`resourceId`	`string`

Returns

Promise<void>

Example

import { ManagementClient } from '@cdot65/prisma-airs-sdk';
const mgmt = new ManagementClient();

await mgmt.dlp.dictionaries.delete('dict-1');
// resolves to undefined (204 No Content)

Constructors​

Constructor​

Parameters​

Returns​

Methods​

list()​

Parameters​

Returns​

Example​

create()​

Parameters​

Returns​

Example​

get()​

Parameters​

Returns​

Example​

replace()​

Parameters​

Returns​

Example​

patch()​

Parameters​

Returns​

Example​

delete()​

Parameters​

Returns​

Example​

Constructors

Constructor

Parameters

Returns

Methods

list()

Parameters

Returns

Example

create()

Parameters

Returns

Example

get()

Parameters

Returns

Example

replace()

Parameters

Returns

Example

patch()

Parameters

Returns

Example

delete()

Parameters

Returns

Example