Class: DataPatternsClient

Defined in: src/management/dlp/data-patterns.ts:39

Client for the DLP Data Patterns resource (/v2/api/data-patterns).

Full CRUD surface: list, create, get, replace (PUT), patch (JSON Merge Patch), delete. DELETE soft-deletes (archives) the pattern server-side.

Constructors

Constructor

new DataPatternsClient(opts): DataPatternsClient;

Defined in: src/management/dlp/data-patterns.ts:44

Parameters

Parameter	Type
`opts`	`DataPatternsClientOptions`

Returns

DataPatternsClient

Methods

list()

list(params?): Promise<objectOutputType<{
  content: ZodArray<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<...>;
        supported_confidence_levels: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        technique: ...;
        supported_confidence_levels: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        technique: ...;
        supported_confidence_levels: ...;
     }, ZodTypeAny, "passthrough">>>>;
     matching_rules: ZodOptional<ZodNullable<ZodObject<{
        delimiter: ZodOptional<...>;
        proximity_distance: ZodOptional<...>;
        proximity_keywords: ZodOptional<...>;
        regexes: ZodOptional<...>;
        metadata_criteria: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        delimiter: ...;
        proximity_distance: ...;
        proximity_keywords: ...;
        regexes: ...;
        metadata_criteria: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        delimiter: ...;
        proximity_distance: ...;
        proximity_keywords: ...;
        regexes: ...;
        metadata_criteria: ...;
     }, ZodTypeAny, "passthrough">>>>;
     tags: ZodOptional<ZodNullable<ZodObject<{
        classification: ZodOptional<...>;
        compliance: ZodOptional<...>;
        geography: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        classification: ...;
        compliance: ...;
        geography: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        classification: ...;
        compliance: ...;
        geography: ...;
     }, ZodTypeAny, "passthrough">>>>;
     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>>;
     tenant_id: ZodOptional<ZodNullable<ZodString>>;
     type: ZodOptional<ZodNullable<ZodEnum<[..., ..., ...]>>>;
     status: ZodOptional<ZodNullable<ZodEnum<[..., ..., ..., ..., ...]>>>;
     license_type: ZodOptional<ZodNullable<ZodEnum<[..., ..., ...]>>>;
     is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
     version: ZodOptional<ZodNullable<ZodNumber>>;
     detection_config: ZodOptional<ZodNullable<ZodObject<{
        technique: ...;
        supported_confidence_levels: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
     matching_rules: ZodOptional<ZodNullable<ZodObject<{
        delimiter: ...;
        proximity_distance: ...;
        proximity_keywords: ...;
        regexes: ...;
        metadata_criteria: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
     tags: ZodOptional<ZodNullable<ZodObject<{
        classification: ...;
        compliance: ...;
        geography: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
     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>>;
     tenant_id: ZodOptional<ZodNullable<ZodString>>;
     type: ZodOptional<ZodNullable<ZodEnum<[..., ..., ...]>>>;
     status: ZodOptional<ZodNullable<ZodEnum<[..., ..., ..., ..., ...]>>>;
     license_type: ZodOptional<ZodNullable<ZodEnum<[..., ..., ...]>>>;
     is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
     version: ZodOptional<ZodNullable<ZodNumber>>;
     detection_config: ZodOptional<ZodNullable<ZodObject<{
        technique: ...;
        supported_confidence_levels: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
     matching_rules: ZodOptional<ZodNullable<ZodObject<{
        delimiter: ...;
        proximity_distance: ...;
        proximity_keywords: ...;
        regexes: ...;
        metadata_criteria: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
     tags: ZodOptional<ZodNullable<ZodObject<{
        classification: ...;
        compliance: ...;
        geography: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
     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/data-patterns.ts:66

List data patterns. Returns the Spring Page<> envelope verbatim so callers can inspect totalElements, pageable, etc.

Parameters

Parameter	Type
`params`	`DataPatternListParams`

Returns

Promise<objectOutputType<{ content: ZodArray<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<...>; supported_confidence_levels: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ technique: ...; supported_confidence_levels: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ technique: ...; supported_confidence_levels: ...; }, ZodTypeAny, "passthrough">>>>; matching_rules: ZodOptional<ZodNullable<ZodObject<{ delimiter: ZodOptional<...>; proximity_distance: ZodOptional<...>; proximity_keywords: ZodOptional<...>; regexes: ZodOptional<...>; metadata_criteria: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ delimiter: ...; proximity_distance: ...; proximity_keywords: ...; regexes: ...; metadata_criteria: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ delimiter: ...; proximity_distance: ...; proximity_keywords: ...; regexes: ...; metadata_criteria: ...; }, ZodTypeAny, "passthrough">>>>; tags: ZodOptional<ZodNullable<ZodObject<{ classification: ZodOptional<...>; compliance: ZodOptional<...>; geography: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ classification: ...; compliance: ...; geography: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ classification: ...; compliance: ...; geography: ...; }, ZodTypeAny, "passthrough">>>>; 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>>; tenant_id: ZodOptional<ZodNullable<ZodString>>; type: ZodOptional<ZodNullable<ZodEnum<[..., ..., ...]>>>; status: ZodOptional<ZodNullable<ZodEnum<[..., ..., ..., ..., ...]>>>; license_type: ZodOptional<ZodNullable<ZodEnum<[..., ..., ...]>>>; is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>; version: ZodOptional<ZodNullable<ZodNumber>>; detection_config: ZodOptional<ZodNullable<ZodObject<{ technique: ...; supported_confidence_levels: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>; matching_rules: ZodOptional<ZodNullable<ZodObject<{ delimiter: ...; proximity_distance: ...; proximity_keywords: ...; regexes: ...; metadata_criteria: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>; tags: ZodOptional<ZodNullable<ZodObject<{ classification: ...; compliance: ...; geography: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>; 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>>; tenant_id: ZodOptional<ZodNullable<ZodString>>; type: ZodOptional<ZodNullable<ZodEnum<[..., ..., ...]>>>; status: ZodOptional<ZodNullable<ZodEnum<[..., ..., ..., ..., ...]>>>; license_type: ZodOptional<ZodNullable<ZodEnum<[..., ..., ...]>>>; is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>; version: ZodOptional<ZodNullable<ZodNumber>>; detection_config: ZodOptional<ZodNullable<ZodObject<{ technique: ...; supported_confidence_levels: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>; matching_rules: ZodOptional<ZodNullable<ZodObject<{ delimiter: ...; proximity_distance: ...; proximity_keywords: ...; regexes: ...; metadata_criteria: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>; tags: ZodOptional<ZodNullable<ZodObject<{ classification: ...; compliance: ...; geography: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>; 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.dataPatterns.list({ size: 5, sort: ['name,asc'] });
// page =>
// {
//   content: [{ id: 'dp-1', name: 'SSN', type: 'custom', status: 'active' }],
//   totalElements: 1, totalPages: 1, number: 0, size: 20, first: true, last: true
// }

create()

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

Defined in: src/management/dlp/data-patterns.ts:100

Create a new custom data pattern.

Parameters

Parameter	Type
`body`	`objectOutputType`

Returns

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

Example

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

const created = await mgmt.dlp.dataPatterns.create({
  name: 'example-pattern',
  type: 'custom',
  detection_config: { technique: 'regex' },
  matching_rules: { regexes: [{ regex: '\\bexample\\b', weight: 1.0 }] },
});
// created =>
// { id: 'dp-1', name: 'example-pattern', type: 'custom', status: 'active' }

get()

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

Defined in: src/management/dlp/data-patterns.ts:124

Get a single data pattern by resource ID.

Parameters

Parameter	Type
`resourceId`	`string`

Returns

Example

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

const pattern = await mgmt.dlp.dataPatterns.get('dp-1');
// pattern =>
// { id: 'dp-1', name: 'SSN', type: 'custom', status: 'active', detection_config: { technique: 'regex' } }

replace()

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

Defined in: src/management/dlp/data-patterns.ts:153

Full-replace (PUT) the pattern at resourceId. Returns the updated resource as the API echoes it back.

Parameters

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

Returns

Example

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

const updated = await mgmt.dlp.dataPatterns.replace('dp-1', {
  name: 'SSN',
  type: 'custom',
  detection_config: { technique: 'regex' },
  matching_rules: { regexes: [{ regex: '\\d{3}-\\d{2}-\\d{4}', weight: 1.0 }] },
});
// updated =>
// { id: 'dp-1', name: 'SSN', type: 'custom', status: 'active' }

patch()

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

Defined in: src/management/dlp/data-patterns.ts:184

Partial update via JSON Merge Patch (RFC 7396). Sent with Content-Type: application/merge-patch+json. Fields set to null clear server-side; omitted fields are left unchanged.

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.dataPatterns.patch('dp-1', {
  name: 'SSN',
  type: 'custom',
  detection_config: { technique: 'regex' },
  description: 'Updated by SDK',
});
// patched =>
// { id: 'dp-1', name: 'SSN', type: 'custom', description: 'Updated by SDK' }

delete()

delete(resourceId): Promise<void>;

Defined in: src/management/dlp/data-patterns.ts:208

Soft-delete (archive) a data pattern. Resolves 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.dataPatterns.delete('dp-1');
// resolves to undefined (204 No Content) — the pattern is archived server-side

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