feat: feat: DLP-3878 Switch DLP Predefined Profile endpoints

* feat: DLP-3878 Switch DLP Predefined Profile endpoints

The new endpoints contain a new field `enabled_entries` which will be
the preferred way to manage entries within a predefined profile. The
existing `entries` field will be supported but now be computed optional

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 1908
+configured_endpoints: 1907
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-cc732ca8d1d7f1c11a1ee579060ddfd8f953a3ad94fd5053056b53370129d040.yml
 openapi_spec_hash: a3e1e833dfe13845abd1e2227993a979
-config_hash: 0c4384f215154a287ab7fbe937bf1621
+config_hash: 6b8d4cb6cfb2bdcc28988fb6e9769676

api.md

@@ -5886,10 +5886,9 @@ Types:
 
 Methods:
 
-- <code title="post /accounts/{account_id}/dlp/profiles/predefined">client.zeroTrust.dlp.profiles.predefined.<a href="./src/resources/zero-trust/dlp/profiles/predefined.ts">create</a>({ ...params }) -> Profile</code>
-- <code title="put /accounts/{account_id}/dlp/profiles/predefined/{profile_id}">client.zeroTrust.dlp.profiles.predefined.<a href="./src/resources/zero-trust/dlp/profiles/predefined.ts">update</a>(profileId, { ...params }) -> Profile</code>
+- <code title="put /accounts/{account_id}/dlp/profiles/predefined/{profile_id}/config">client.zeroTrust.dlp.profiles.predefined.<a href="./src/resources/zero-trust/dlp/profiles/predefined.ts">update</a>(profileId, { ...params }) -> PredefinedProfile</code>
 - <code title="delete /accounts/{account_id}/dlp/profiles/predefined/{profile_id}">client.zeroTrust.dlp.profiles.predefined.<a href="./src/resources/zero-trust/dlp/profiles/predefined.ts">delete</a>(profileId, { ...params }) -> PredefinedDeleteResponse | null</code>
-- <code title="get /accounts/{account_id}/dlp/profiles/predefined/{profile_id}">client.zeroTrust.dlp.profiles.predefined.<a href="./src/resources/zero-trust/dlp/profiles/predefined.ts">get</a>(profileId, { ...params }) -> Profile</code>
+- <code title="get /accounts/{account_id}/dlp/profiles/predefined/{profile_id}/config">client.zeroTrust.dlp.profiles.predefined.<a href="./src/resources/zero-trust/dlp/profiles/predefined.ts">get</a>(profileId, { ...params }) -> PredefinedProfile</code>
 
 ### Limits
 

src/resources/zero-trust/dlp/profiles/index.ts

@@ -14,7 +14,6 @@ export {
   Predefined,
   type PredefinedProfile,
   type PredefinedDeleteResponse,
-  type PredefinedCreateParams,
   type PredefinedUpdateParams,
   type PredefinedDeleteParams,
   type PredefinedGetParams,

src/resources/zero-trust/dlp/profiles/predefined.ts

@@ -3,40 +3,16 @@
 import { APIResource } from '../../../../resource';
 import * as Core from '../../../../core';
 import * as CustomAPI from './custom';
-import * as ProfilesAPI from './profiles';
 
 export class Predefined extends APIResource {
   /**
-   * Creates a DLP predefined profile. Only supports enabling/disabling entries.
+   * This is similar to `update_predefined` but only returns entries that are
+   * enabled. This is needed for our terraform API Updates a DLP predefined profile.
+   * Only supports enabling/disabling entries.
    *
    * @example
    * ```ts
-   * const profile =
-   *   await client.zeroTrust.dlp.profiles.predefined.create({
-   *     account_id: 'account_id',
-   *     profile_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *   });
-   * ```
-   */
-  create(
-    params: PredefinedCreateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ProfilesAPI.Profile> {
-    const { account_id, ...body } = params;
-    return (
-      this._client.post(`/accounts/${account_id}/dlp/profiles/predefined`, {
-        body,
-        ...options,
-      }) as Core.APIPromise<{ result: ProfilesAPI.Profile }>
-    )._thenUnwrap((obj) => obj.result);
-  }
-
-  /**
-   * Updates a DLP predefined profile. Only supports enabling/disabling entries.
-   *
-   * @example
-   * ```ts
-   * const profile =
+   * const predefinedProfile =
    *   await client.zeroTrust.dlp.profiles.predefined.update(
    *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    *     { account_id: 'account_id' },
@@ -47,13 +23,13 @@ export class Predefined extends APIResource {
     profileId: string,
     params: PredefinedUpdateParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<ProfilesAPI.Profile> {
+  ): Core.APIPromise<PredefinedProfile> {
     const { account_id, ...body } = params;
     return (
-      this._client.put(`/accounts/${account_id}/dlp/profiles/predefined/${profileId}`, {
+      this._client.put(`/accounts/${account_id}/dlp/profiles/predefined/${profileId}/config`, {
         body,
         ...options,
-      }) as Core.APIPromise<{ result: ProfilesAPI.Profile }>
+      }) as Core.APIPromise<{ result: PredefinedProfile }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -85,11 +61,12 @@ export class Predefined extends APIResource {
   }
 
   /**
-   * Fetches a predefined DLP profile by id.
+   * This is similar to `get_predefined` but only returns entries that are enabled.
+   * This is needed for our terraform API Fetches a predefined DLP profile by id.
    *
    * @example
    * ```ts
-   * const profile =
+   * const predefinedProfile =
    *   await client.zeroTrust.dlp.profiles.predefined.get(
    *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    *     { account_id: 'account_id' },
@@ -100,13 +77,13 @@ export class Predefined extends APIResource {
     profileId: string,
     params: PredefinedGetParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<ProfilesAPI.Profile> {
+  ): Core.APIPromise<PredefinedProfile> {
     const { account_id } = params;
     return (
       this._client.get(
-        `/accounts/${account_id}/dlp/profiles/predefined/${profileId}`,
+        `/accounts/${account_id}/dlp/profiles/predefined/${profileId}/config`,
         options,
-      ) as Core.APIPromise<{ result: ProfilesAPI.Profile }>
+      ) as Core.APIPromise<{ result: PredefinedProfile }>
     )._thenUnwrap((obj) => obj.result);
   }
 }
@@ -119,6 +96,13 @@ export interface PredefinedProfile {
 
   allowed_match_count: number;
 
+  confidence_threshold: string | null;
+
+  enabled_entries: Array<string>;
+
+  /**
+   * @deprecated
+   */
   entries: Array<
     | PredefinedProfile.CustomEntry
     | PredefinedProfile.PredefinedEntry
@@ -135,14 +119,6 @@ export interface PredefinedProfile {
 
   ai_context_enabled?: boolean;
 
-  confidence_threshold?: 'low' | 'medium' | 'high' | 'very_high';
-
-  /**
-   * @deprecated Scan the context of predefined entries to only return matches
-   * surrounded by keywords.
-   */
-  context_awareness?: ProfilesAPI.ContextAwareness;
-
   ocr_enabled?: boolean;
 
   /**
@@ -282,57 +258,6 @@ export namespace PredefinedProfile {
 
 export type PredefinedDeleteResponse = unknown;
 
-export interface PredefinedCreateParams {
-  /**
-   * Path param:
-   */
-  account_id: string;
-
-  /**
-   * Body param:
-   */
-  profile_id: string;
-
-  /**
-   * Body param:
-   */
-  ai_context_enabled?: boolean;
-
-  /**
-   * Body param:
-   */
-  allowed_match_count?: number | null;
-
-  /**
-   * Body param:
-   */
-  confidence_threshold?: string | null;
-
-  /**
-   * @deprecated Body param: Scan the context of predefined entries to only return
-   * matches surrounded by keywords.
-   */
-  context_awareness?: ProfilesAPI.ContextAwarenessParam;
-
-  /**
-   * @deprecated Body param:
-   */
-  entries?: Array<PredefinedCreateParams.Entry>;
-
-  /**
-   * Body param:
-   */
-  ocr_enabled?: boolean;
-}
-
-export namespace PredefinedCreateParams {
-  export interface Entry {
-    id: string;
-
-    enabled: boolean;
-  }
-}
-
 export interface PredefinedUpdateParams {
   /**
    * Path param:
@@ -355,10 +280,9 @@ export interface PredefinedUpdateParams {
   confidence_threshold?: string | null;
 
   /**
-   * @deprecated Body param: Scan the context of predefined entries to only return
-   * matches surrounded by keywords.
+   * Body param:
    */
-  context_awareness?: ProfilesAPI.ContextAwarenessParam;
+  enabled_entries?: Array<string> | null;
 
   /**
    * @deprecated Body param:
@@ -391,7 +315,6 @@ export declare namespace Predefined {
   export {
     type PredefinedProfile as PredefinedProfile,
     type PredefinedDeleteResponse as PredefinedDeleteResponse,
-    type PredefinedCreateParams as PredefinedCreateParams,
     type PredefinedUpdateParams as PredefinedUpdateParams,
     type PredefinedDeleteParams as PredefinedDeleteParams,
     type PredefinedGetParams as PredefinedGetParams,

src/resources/zero-trust/dlp/profiles/profiles.ts

@@ -17,7 +17,6 @@ import {
 import * as PredefinedAPI from './predefined';
 import {
   Predefined,
-  PredefinedCreateParams,
   PredefinedDeleteParams,
   PredefinedDeleteResponse,
   PredefinedGetParams,
@@ -691,7 +690,6 @@ export declare namespace Profiles {
     Predefined as Predefined,
     type PredefinedAPIPredefinedProfile as PredefinedProfile,
     type PredefinedDeleteResponse as PredefinedDeleteResponse,
-    type PredefinedCreateParams as PredefinedCreateParams,
     type PredefinedUpdateParams as PredefinedUpdateParams,
     type PredefinedDeleteParams as PredefinedDeleteParams,
     type PredefinedGetParams as PredefinedGetParams,

tests/api-resources/zero-trust/dlp/profiles/predefined.test.ts

@@ -10,33 +10,6 @@ const client = new Cloudflare({
 });
 
 describe('resource predefined', () => {
-  test('create: only required params', async () => {
-    const responsePromise = client.zeroTrust.dlp.profiles.predefined.create({
-      account_id: 'account_id',
-      profile_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-    });
-    const rawResponse = await responsePromise.asResponse();
-    expect(rawResponse).toBeInstanceOf(Response);
-    const response = await responsePromise;
-    expect(response).not.toBeInstanceOf(Response);
-    const dataAndResponse = await responsePromise.withResponse();
-    expect(dataAndResponse.data).toBe(response);
-    expect(dataAndResponse.response).toBe(rawResponse);
-  });
-
-  test('create: required and optional params', async () => {
-    const response = await client.zeroTrust.dlp.profiles.predefined.create({
-      account_id: 'account_id',
-      profile_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-      ai_context_enabled: true,
-      allowed_match_count: 5,
-      confidence_threshold: 'confidence_threshold',
-      context_awareness: { enabled: true, skip: { files: true } },
-      entries: [{ id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', enabled: true }],
-      ocr_enabled: true,
-    });
-  });
-
   test('update: only required params', async () => {
     const responsePromise = client.zeroTrust.dlp.profiles.predefined.update(
       '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
@@ -59,7 +32,7 @@ describe('resource predefined', () => {
         ai_context_enabled: true,
         allowed_match_count: 5,
         confidence_threshold: 'confidence_threshold',
-        context_awareness: { enabled: true, skip: { files: true } },
+        enabled_entries: ['182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'],
         entries: [{ id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', enabled: true }],
         ocr_enabled: true,
       },