cloudflare 4.5.0 → 5.1.0

package/src/resources/zero-trust/dlp/entries/predefined.ts

@@ -2,10 +2,13 @@
 
 import { APIResource } from '../../../../resource';
 import * as Core from '../../../../core';
+import * as CustomAPI from '../profiles/custom';
+import { SinglePage } from '../../../../pagination';
 
 export class Predefined extends APIResource {
   /**
-   * This will update an existing predefined entry
+   * Predefined entries can't be created, this will update an existing predefined
+   * entry This is needed for our generated terraform API
    *
    * @example
    * ```ts
@@ -56,6 +59,31 @@ export class Predefined extends APIResource {
     )._thenUnwrap((obj) => obj.result);
   }
 
+  /**
+   * Lists all DLP entries in an account.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const predefinedListResponse of client.zeroTrust.dlp.entries.predefined.list(
+   *   { account_id: 'account_id' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    params: PredefinedListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<PredefinedListResponsesSinglePage, PredefinedListResponse> {
+    const { account_id } = params;
+    return this._client.getAPIList(
+      `/accounts/${account_id}/dlp/entries`,
+      PredefinedListResponsesSinglePage,
+      options,
+    );
+  }
+
   /**
    * This is a no-op as predefined entires can't be deleted but is needed for our
    * generated terraform API
@@ -82,8 +110,35 @@ export class Predefined extends APIResource {
       ) as Core.APIPromise<{ result: PredefinedDeleteResponse | null }>
     )._thenUnwrap((obj) => obj.result);
   }
+
+  /**
+   * Fetches a DLP entry by ID.
+   *
+   * @example
+   * ```ts
+   * const predefined =
+   *   await client.zeroTrust.dlp.entries.predefined.get(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     { account_id: 'account_id' },
+   *   );
+   * ```
+   */
+  get(
+    entryId: string,
+    params: PredefinedGetParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PredefinedGetResponse> {
+    const { account_id } = params;
+    return (
+      this._client.get(`/accounts/${account_id}/dlp/entries/${entryId}`, options) as Core.APIPromise<{
+        result: PredefinedGetResponse;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
 }
 
+export class PredefinedListResponsesSinglePage extends SinglePage<PredefinedListResponse> {}
+
 export interface PredefinedCreateResponse {
   id: string;
 
@@ -94,6 +149,8 @@ export interface PredefinedCreateResponse {
   name: string;
 
   profile_id?: string | null;
+
+  variant?: PredefinedCreateResponse.Variant;
 }
 
 export namespace PredefinedCreateResponse {
@@ -109,6 +166,14 @@ export namespace PredefinedCreateResponse {
      */
     available: boolean;
   }
+
+  export interface Variant {
+    topic_type: 'Intent' | 'Content';
+
+    type: 'PromptTopic';
+
+    description?: string | null;
+  }
 }
 
 export interface PredefinedUpdateResponse {
@@ -121,6 +186,8 @@ export interface PredefinedUpdateResponse {
   name: string;
 
   profile_id?: string | null;
+
+  variant?: PredefinedUpdateResponse.Variant;
 }
 
 export namespace PredefinedUpdateResponse {
@@ -136,10 +203,292 @@ export namespace PredefinedUpdateResponse {
      */
     available: boolean;
   }
+
+  export interface Variant {
+    topic_type: 'Intent' | 'Content';
+
+    type: 'PromptTopic';
+
+    description?: string | null;
+  }
+}
+
+export type PredefinedListResponse =
+  | PredefinedListResponse.CustomEntry
+  | PredefinedListResponse.PredefinedEntry
+  | PredefinedListResponse.IntegrationEntry
+  | PredefinedListResponse.ExactDataEntry
+  | PredefinedListResponse.DocumentFingerprintEntry
+  | PredefinedListResponse.WordListEntry;
+
+export namespace PredefinedListResponse {
+  export interface CustomEntry {
+    id: string;
+
+    created_at: string;
+
+    enabled: boolean;
+
+    name: string;
+
+    pattern: CustomAPI.Pattern;
+
+    type: 'custom';
+
+    updated_at: string;
+
+    profile_id?: string | null;
+  }
+
+  export interface PredefinedEntry {
+    id: string;
+
+    confidence: PredefinedEntry.Confidence;
+
+    enabled: boolean;
+
+    name: string;
+
+    type: 'predefined';
+
+    profile_id?: string | null;
+
+    variant?: PredefinedEntry.Variant;
+  }
+
+  export namespace PredefinedEntry {
+    export interface Confidence {
+      /**
+       * Indicates whether this entry has AI remote service validation.
+       */
+      ai_context_available: boolean;
+
+      /**
+       * Indicates whether this entry has any form of validation that is not an AI remote
+       * service.
+       */
+      available: boolean;
+    }
+
+    export interface Variant {
+      topic_type: 'Intent' | 'Content';
+
+      type: 'PromptTopic';
+
+      description?: string | null;
+    }
+  }
+
+  export interface IntegrationEntry {
+    id: string;
+
+    created_at: string;
+
+    enabled: boolean;
+
+    name: string;
+
+    type: 'integration';
+
+    updated_at: string;
+
+    profile_id?: string | null;
+  }
+
+  export interface ExactDataEntry {
+    id: string;
+
+    /**
+     * Only applies to custom word lists. Determines if the words should be matched in
+     * a case-sensitive manner Cannot be set to false if secret is true
+     */
+    case_sensitive: boolean;
+
+    created_at: string;
+
+    enabled: boolean;
+
+    name: string;
+
+    secret: boolean;
+
+    type: 'exact_data';
+
+    updated_at: string;
+  }
+
+  export interface DocumentFingerprintEntry {
+    id: string;
+
+    created_at: string;
+
+    enabled: boolean;
+
+    name: string;
+
+    type: 'document_fingerprint';
+
+    updated_at: string;
+  }
+
+  export interface WordListEntry {
+    id: string;
+
+    created_at: string;
+
+    enabled: boolean;
+
+    name: string;
+
+    type: 'word_list';
+
+    updated_at: string;
+
+    word_list: unknown;
+
+    profile_id?: string | null;
+  }
 }
 
 export type PredefinedDeleteResponse = unknown;
 
+export type PredefinedGetResponse =
+  | PredefinedGetResponse.CustomEntry
+  | PredefinedGetResponse.PredefinedEntry
+  | PredefinedGetResponse.IntegrationEntry
+  | PredefinedGetResponse.ExactDataEntry
+  | PredefinedGetResponse.DocumentFingerprintEntry
+  | PredefinedGetResponse.WordListEntry;
+
+export namespace PredefinedGetResponse {
+  export interface CustomEntry {
+    id: string;
+
+    created_at: string;
+
+    enabled: boolean;
+
+    name: string;
+
+    pattern: CustomAPI.Pattern;
+
+    type: 'custom';
+
+    updated_at: string;
+
+    profile_id?: string | null;
+  }
+
+  export interface PredefinedEntry {
+    id: string;
+
+    confidence: PredefinedEntry.Confidence;
+
+    enabled: boolean;
+
+    name: string;
+
+    type: 'predefined';
+
+    profile_id?: string | null;
+
+    variant?: PredefinedEntry.Variant;
+  }
+
+  export namespace PredefinedEntry {
+    export interface Confidence {
+      /**
+       * Indicates whether this entry has AI remote service validation.
+       */
+      ai_context_available: boolean;
+
+      /**
+       * Indicates whether this entry has any form of validation that is not an AI remote
+       * service.
+       */
+      available: boolean;
+    }
+
+    export interface Variant {
+      topic_type: 'Intent' | 'Content';
+
+      type: 'PromptTopic';
+
+      description?: string | null;
+    }
+  }
+
+  export interface IntegrationEntry {
+    id: string;
+
+    created_at: string;
+
+    enabled: boolean;
+
+    name: string;
+
+    type: 'integration';
+
+    updated_at: string;
+
+    profile_id?: string | null;
+  }
+
+  export interface ExactDataEntry {
+    id: string;
+
+    /**
+     * Only applies to custom word lists. Determines if the words should be matched in
+     * a case-sensitive manner Cannot be set to false if secret is true
+     */
+    case_sensitive: boolean;
+
+    created_at: string;
+
+    enabled: boolean;
+
+    name: string;
+
+    secret: boolean;
+
+    type: 'exact_data';
+
+    updated_at: string;
+  }
+
+  export interface DocumentFingerprintEntry {
+    id: string;
+
+    created_at: string;
+
+    enabled: boolean;
+
+    name: string;
+
+    type: 'document_fingerprint';
+
+    updated_at: string;
+  }
+
+  export interface WordListEntry {
+    id: string;
+
+    created_at: string;
+
+    enabled: boolean;
+
+    name: string;
+
+    type: 'word_list';
+
+    updated_at: string;
+
+    word_list: unknown;
+
+    profile_id?: string | null;
+  }
+}
+
 export interface PredefinedCreateParams {
   /**
    * Path param:
@@ -175,17 +524,32 @@ export interface PredefinedUpdateParams {
   enabled: boolean;
 }
 
+export interface PredefinedListParams {
+  account_id: string;
+}
+
 export interface PredefinedDeleteParams {
   account_id: string;
 }
 
+export interface PredefinedGetParams {
+  account_id: string;
+}
+
+Predefined.PredefinedListResponsesSinglePage = PredefinedListResponsesSinglePage;
+
 export declare namespace Predefined {
   export {
     type PredefinedCreateResponse as PredefinedCreateResponse,
     type PredefinedUpdateResponse as PredefinedUpdateResponse,
+    type PredefinedListResponse as PredefinedListResponse,
     type PredefinedDeleteResponse as PredefinedDeleteResponse,
+    type PredefinedGetResponse as PredefinedGetResponse,
+    PredefinedListResponsesSinglePage as PredefinedListResponsesSinglePage,
     type PredefinedCreateParams as PredefinedCreateParams,
     type PredefinedUpdateParams as PredefinedUpdateParams,
+    type PredefinedListParams as PredefinedListParams,
     type PredefinedDeleteParams as PredefinedDeleteParams,
+    type PredefinedGetParams as PredefinedGetParams,
   };
 }

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

@@ -14,13 +14,6 @@ export class Custom extends APIResource {
    * const profile =
    *   await client.zeroTrust.dlp.profiles.custom.create({
    *     account_id: 'account_id',
-   *     entries: [
-   *       {
-   *         enabled: true,
-   *         name: 'name',
-   *         pattern: { regex: 'regex' },
-   *       },
-   *     ],
    *     name: 'name',
    *   });
    * ```
@@ -125,26 +118,11 @@ export interface CustomProfile {
    */
   allowed_match_count: number;
 
-  /**
-   * Scan the context of predefined entries to only return matches surrounded by
-   * keywords.
-   */
-  context_awareness: ProfilesAPI.ContextAwareness;
-
   /**
    * When the profile was created.
    */
   created_at: string;
 
-  entries: Array<
-    | CustomProfile.CustomEntry
-    | CustomProfile.PredefinedEntry
-    | CustomProfile.IntegrationEntry
-    | CustomProfile.ExactDataEntry
-    | CustomProfile.DocumentFingerprintEntry
-    | CustomProfile.WordListEntry
-  >;
-
   /**
    * The name of the profile.
    */
@@ -161,10 +139,25 @@ export interface CustomProfile {
 
   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;
+
   /**
    * The description of the profile.
    */
   description?: string | null;
+
+  entries?: Array<
+    | CustomProfile.CustomEntry
+    | CustomProfile.PredefinedEntry
+    | CustomProfile.IntegrationEntry
+    | CustomProfile.ExactDataEntry
+    | CustomProfile.DocumentFingerprintEntry
+    | CustomProfile.WordListEntry
+  >;
 }
 
 export namespace CustomProfile {
@@ -198,6 +191,8 @@ export namespace CustomProfile {
     type: 'predefined';
 
     profile_id?: string | null;
+
+    variant?: PredefinedEntry.Variant;
   }
 
   export namespace PredefinedEntry {
@@ -213,6 +208,14 @@ export namespace CustomProfile {
        */
       available: boolean;
     }
+
+    export interface Variant {
+      topic_type: 'Intent' | 'Content';
+
+      type: 'PromptTopic';
+
+      description?: string | null;
+    }
   }
 
   export interface IntegrationEntry {
@@ -312,11 +315,6 @@ export interface CustomCreateParams {
    */
   account_id: string;
 
-  /**
-   * Body param:
-   */
-  entries: Array<CustomCreateParams.DLPNewCustomEntry | CustomCreateParams.DLPNewWordListEntry>;
-
   /**
    * Body param:
    */
@@ -339,8 +337,8 @@ export interface CustomCreateParams {
   confidence_threshold?: string | null;
 
   /**
-   * Body param: Scan the context of predefined entries to only return matches
-   * surrounded by keywords.
+   * @deprecated Body param: Scan the context of predefined entries to only return
+   * matches surrounded by keywords.
    */
   context_awareness?: ProfilesAPI.ContextAwarenessParam;
 
@@ -349,6 +347,11 @@ export interface CustomCreateParams {
    */
   description?: string | null;
 
+  /**
+   * Body param:
+   */
+  entries?: Array<CustomCreateParams.DLPNewCustomEntry | CustomCreateParams.DLPNewWordListEntry>;
+
   /**
    * Body param:
    */
@@ -452,8 +455,8 @@ export interface CustomUpdateParams {
   confidence_threshold?: string | null;
 
   /**
-   * Body param: Scan the context of predefined entries to only return matches
-   * surrounded by keywords.
+   * @deprecated Body param: Scan the context of predefined entries to only return
+   * matches surrounded by keywords.
    */
   context_awareness?: ProfilesAPI.ContextAwarenessParam;
 

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

@@ -138,8 +138,8 @@ export interface PredefinedProfile {
   confidence_threshold?: 'low' | 'medium' | 'high' | 'very_high';
 
   /**
-   * Scan the context of predefined entries to only return matches surrounded by
-   * keywords.
+   * @deprecated Scan the context of predefined entries to only return matches
+   * surrounded by keywords.
    */
   context_awareness?: ProfilesAPI.ContextAwareness;
 
@@ -182,6 +182,8 @@ export namespace PredefinedProfile {
     type: 'predefined';
 
     profile_id?: string | null;
+
+    variant?: PredefinedEntry.Variant;
   }
 
   export namespace PredefinedEntry {
@@ -197,6 +199,14 @@ export namespace PredefinedProfile {
        */
       available: boolean;
     }
+
+    export interface Variant {
+      topic_type: 'Intent' | 'Content';
+
+      type: 'PromptTopic';
+
+      description?: string | null;
+    }
   }
 
   export interface IntegrationEntry {
@@ -299,8 +309,8 @@ export interface PredefinedCreateParams {
   confidence_threshold?: string | null;
 
   /**
-   * Body param: Scan the context of predefined entries to only return matches
-   * surrounded by keywords.
+   * @deprecated Body param: Scan the context of predefined entries to only return
+   * matches surrounded by keywords.
    */
   context_awareness?: ProfilesAPI.ContextAwarenessParam;
 
@@ -345,8 +355,8 @@ export interface PredefinedUpdateParams {
   confidence_threshold?: string | null;
 
   /**
-   * Body param: Scan the context of predefined entries to only return matches
-   * surrounded by keywords.
+   * @deprecated Body param: Scan the context of predefined entries to only return
+   * matches surrounded by keywords.
    */
   context_awareness?: ProfilesAPI.ContextAwarenessParam;