cloudflare 4.3.0 → 4.4.1

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

@@ -11,31 +11,27 @@ export class Custom extends APIResource {
    *
    * @example
    * ```ts
-   * const custom =
+   * const profile =
    *   await client.zeroTrust.dlp.profiles.custom.create({
    *     account_id: 'account_id',
-   *     profiles: [
+   *     entries: [
    *       {
-   *         entries: [
-   *           {
-   *             enabled: true,
-   *             name: 'name',
-   *             pattern: { regex: 'regex' },
-   *           },
-   *         ],
+   *         enabled: true,
    *         name: 'name',
+   *         pattern: { regex: 'regex' },
    *       },
    *     ],
+   *     name: 'name',
    *   });
    * ```
    */
-  create(params: CustomCreateParams, options?: Core.RequestOptions): Core.APIPromise<CustomCreateResponse> {
+  create(params: CustomCreateParams, options?: Core.RequestOptions): Core.APIPromise<ProfilesAPI.Profile> {
     const { account_id, ...body } = params;
     return (
       this._client.post(`/accounts/${account_id}/dlp/profiles/custom`, {
         body,
         ...options,
-      }) as Core.APIPromise<{ result: CustomCreateResponse }>
+      }) as Core.APIPromise<{ result: ProfilesAPI.Profile }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -145,6 +141,7 @@ export interface CustomProfile {
     | CustomProfile.PredefinedEntry
     | CustomProfile.IntegrationEntry
     | CustomProfile.ExactDataEntry
+    | CustomProfile.DocumentTemplateEntry
     | CustomProfile.WordListEntry
   >;
 
@@ -256,6 +253,20 @@ export namespace CustomProfile {
     updated_at: string;
   }
 
+  export interface DocumentTemplateEntry {
+    id: string;
+
+    created_at: string;
+
+    enabled: boolean;
+
+    name: string;
+
+    type: 'document_template';
+
+    updated_at: string;
+  }
+
   export interface WordListEntry {
     id: string;
 
@@ -293,662 +304,115 @@ export interface PatternParam {
   validation?: 'luhn';
 }
 
-export type CustomCreateResponse =
-  | CustomCreateResponse.CustomProfile
-  | CustomCreateResponse.PredefinedProfile
-  | CustomCreateResponse.IntegrationProfile
-  | Array<ProfilesAPI.Profile>;
-
-export namespace CustomCreateResponse {
-  export interface CustomProfile {
-    /**
-     * The id of the profile (uuid).
-     */
-    id: string;
-
-    /**
-     * Related DLP policies will trigger when the match count exceeds the number set.
-     */
-    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.WordListEntry
-    >;
-
-    /**
-     * The name of the profile.
-     */
-    name: string;
-
-    ocr_enabled: boolean;
-
-    type: 'custom';
-
-    /**
-     * When the profile was lasted updated.
-     */
-    updated_at: string;
-
-    ai_context_enabled?: boolean;
-
-    confidence_threshold?: 'low' | 'medium' | 'high' | 'very_high';
-
-    /**
-     * The description of the profile.
-     */
-    description?: string | null;
-  }
-
-  export namespace CustomProfile {
-    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;
-    }
-
-    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 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 type CustomDeleteResponse = unknown;
 
-    export interface WordListEntry {
-      id: string;
+export interface CustomCreateParams {
+  /**
+   * Path param:
+   */
+  account_id: string;
 
-      created_at: string;
+  /**
+   * Body param:
+   */
+  entries: Array<CustomCreateParams.DLPNewCustomEntry | CustomCreateParams.DLPNewWordListEntry>;
 
-      enabled: boolean;
+  /**
+   * Body param:
+   */
+  name: string;
 
-      name: string;
+  /**
+   * Body param:
+   */
+  ai_context_enabled?: boolean;
 
-      type: 'word_list';
+  /**
+   * Body param: Related DLP policies will trigger when the match count exceeds the
+   * number set.
+   */
+  allowed_match_count?: number;
 
-      updated_at: string;
+  /**
+   * Body param:
+   */
+  confidence_threshold?: string | null;
 
-      word_list: unknown;
+  /**
+   * Body param: Scan the context of predefined entries to only return matches
+   * surrounded by keywords.
+   */
+  context_awareness?: ProfilesAPI.ContextAwarenessParam;
 
-      profile_id?: string | null;
-    }
-  }
+  /**
+   * Body param: The description of the profile.
+   */
+  description?: string | null;
 
-  export interface PredefinedProfile {
-    /**
-     * The id of the predefined profile (uuid).
-     */
-    id: string;
+  /**
+   * Body param:
+   */
+  ocr_enabled?: boolean;
 
-    allowed_match_count: number;
+  /**
+   * Body param: Entries from other profiles (e.g. pre-defined Cloudflare profiles,
+   * or your Microsoft Information Protection profiles).
+   */
+  shared_entries?: Array<
+    | CustomCreateParams.Custom
+    | CustomCreateParams.Predefined
+    | CustomCreateParams.Integration
+    | CustomCreateParams.ExactData
+  >;
+}
 
-    entries: Array<
-      | PredefinedProfile.CustomEntry
-      | PredefinedProfile.PredefinedEntry
-      | PredefinedProfile.IntegrationEntry
-      | PredefinedProfile.ExactDataEntry
-      | PredefinedProfile.WordListEntry
-    >;
+export namespace CustomCreateParams {
+  export interface DLPNewCustomEntry {
+    enabled: boolean;
 
-    /**
-     * The name of the predefined profile.
-     */
     name: string;
 
-    type: 'predefined';
-
-    ai_context_enabled?: boolean;
-
-    confidence_threshold?: 'low' | 'medium' | 'high' | 'very_high';
-
-    /**
-     * Scan the context of predefined entries to only return matches surrounded by
-     * keywords.
-     */
-    context_awareness?: ProfilesAPI.ContextAwareness;
-
-    ocr_enabled?: boolean;
-
-    /**
-     * Whether this profile can be accessed by anyone.
-     */
-    open_access?: boolean;
-  }
-
-  export namespace PredefinedProfile {
-    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;
-    }
-
-    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 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 WordListEntry {
-      id: string;
-
-      created_at: string;
-
-      enabled: boolean;
-
-      name: string;
-
-      type: 'word_list';
-
-      updated_at: string;
-
-      word_list: unknown;
-
-      profile_id?: string | null;
-    }
+    pattern: CustomAPI.PatternParam;
   }
 
-  export interface IntegrationProfile {
-    id: string;
-
-    created_at: string;
-
-    entries: Array<
-      | IntegrationProfile.CustomEntry
-      | IntegrationProfile.PredefinedEntry
-      | IntegrationProfile.IntegrationEntry
-      | IntegrationProfile.ExactDataEntry
-      | IntegrationProfile.WordListEntry
-    >;
+  export interface DLPNewWordListEntry {
+    enabled: boolean;
 
     name: string;
 
-    type: 'integration';
-
-    updated_at: string;
-
-    /**
-     * The description of the profile.
-     */
-    description?: string | null;
-  }
-
-  export namespace IntegrationProfile {
-    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;
-    }
-
-    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 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 WordListEntry {
-      id: string;
-
-      created_at: string;
-
-      enabled: boolean;
-
-      name: string;
-
-      type: 'word_list';
-
-      updated_at: string;
-
-      word_list: unknown;
-
-      profile_id?: string | null;
-    }
+    words: Array<string>;
   }
-}
-
-export type CustomDeleteResponse = unknown;
 
-export type CustomCreateParams = CustomCreateParams.Variant0 | CustomCreateParams.DLPNewCustomProfile;
+  export interface Custom {
+    enabled: boolean;
 
-export declare namespace CustomCreateParams {
-  export interface Variant0 {
-    /**
-     * Path param:
-     */
-    account_id: string;
+    entry_id: string;
 
-    /**
-     * Body param:
-     */
-    profiles: Array<Variant0.Profile>;
+    entry_type: 'custom';
   }
 
-  export namespace Variant0 {
-    export interface Profile {
-      entries: Array<Profile.DLPNewCustomEntry | Profile.DLPNewWordListEntry>;
-
-      name: string;
-
-      ai_context_enabled?: boolean;
-
-      /**
-       * Related DLP policies will trigger when the match count exceeds the number set.
-       */
-      allowed_match_count?: number;
-
-      confidence_threshold?: string | null;
-
-      /**
-       * Scan the context of predefined entries to only return matches surrounded by
-       * keywords.
-       */
-      context_awareness?: ProfilesAPI.ContextAwarenessParam;
-
-      /**
-       * The description of the profile.
-       */
-      description?: string | null;
-
-      ocr_enabled?: boolean;
-
-      /**
-       * Entries from other profiles (e.g. pre-defined Cloudflare profiles, or your
-       * Microsoft Information Protection profiles).
-       */
-      shared_entries?: Array<
-        Profile.UnionMember0 | Profile.UnionMember1 | Profile.UnionMember2 | Profile.UnionMember3
-      >;
-    }
-
-    export namespace Profile {
-      export interface DLPNewCustomEntry {
-        enabled: boolean;
-
-        name: string;
-
-        pattern: CustomAPI.PatternParam;
-      }
-
-      export interface DLPNewWordListEntry {
-        enabled: boolean;
-
-        name: string;
-
-        words: Array<string>;
-      }
-
-      export interface UnionMember0 {
-        enabled: boolean;
-
-        entry_id: string;
-
-        entry_type: 'custom';
-      }
-
-      export interface UnionMember1 {
-        enabled: boolean;
-
-        entry_id: string;
-
-        entry_type: 'predefined';
-      }
-
-      export interface UnionMember2 {
-        enabled: boolean;
-
-        entry_id: string;
-
-        entry_type: 'integration';
-      }
-
-      export interface UnionMember3 {
-        enabled: boolean;
+  export interface Predefined {
+    enabled: boolean;
 
-        entry_id: string;
+    entry_id: string;
 
-        entry_type: 'exact_data';
-      }
-    }
+    entry_type: 'predefined';
   }
 
-  export interface DLPNewCustomProfile {
-    /**
-     * Path param:
-     */
-    account_id: string;
-
-    /**
-     * Body param:
-     */
-    entries: Array<DLPNewCustomProfile.DLPNewCustomEntry | DLPNewCustomProfile.DLPNewWordListEntry>;
-
-    /**
-     * Body param:
-     */
-    name: string;
-
-    /**
-     * Body param:
-     */
-    ai_context_enabled?: boolean;
-
-    /**
-     * Body param: Related DLP policies will trigger when the match count exceeds the
-     * number set.
-     */
-    allowed_match_count?: number;
-
-    /**
-     * Body param:
-     */
-    confidence_threshold?: string | null;
-
-    /**
-     * Body param: Scan the context of predefined entries to only return matches
-     * surrounded by keywords.
-     */
-    context_awareness?: ProfilesAPI.ContextAwarenessParam;
-
-    /**
-     * Body param: The description of the profile.
-     */
-    description?: string | null;
+  export interface Integration {
+    enabled: boolean;
 
-    /**
-     * Body param:
-     */
-    ocr_enabled?: boolean;
+    entry_id: string;
 
-    /**
-     * Body param: Entries from other profiles (e.g. pre-defined Cloudflare profiles,
-     * or your Microsoft Information Protection profiles).
-     */
-    shared_entries?: Array<
-      | DLPNewCustomProfile.UnionMember0
-      | DLPNewCustomProfile.UnionMember1
-      | DLPNewCustomProfile.UnionMember2
-      | DLPNewCustomProfile.UnionMember3
-    >;
+    entry_type: 'integration';
   }
 
-  export namespace DLPNewCustomProfile {
-    export interface DLPNewCustomEntry {
-      enabled: boolean;
-
-      name: string;
-
-      pattern: CustomAPI.PatternParam;
-    }
-
-    export interface DLPNewWordListEntry {
-      enabled: boolean;
-
-      name: string;
-
-      words: Array<string>;
-    }
-
-    export interface UnionMember0 {
-      enabled: boolean;
-
-      entry_id: string;
-
-      entry_type: 'custom';
-    }
-
-    export interface UnionMember1 {
-      enabled: boolean;
-
-      entry_id: string;
-
-      entry_type: 'predefined';
-    }
-
-    export interface UnionMember2 {
-      enabled: boolean;
-
-      entry_id: string;
-
-      entry_type: 'integration';
-    }
-
-    export interface UnionMember3 {
-      enabled: boolean;
+  export interface ExactData {
+    enabled: boolean;
 
-      entry_id: string;
+    entry_id: string;
 
-      entry_type: 'exact_data';
-    }
+    entry_type: 'exact_data';
   }
 }
 
@@ -1004,7 +468,7 @@ export interface CustomUpdateParams {
    * Body param: Other entries, e.g. predefined or integration.
    */
   shared_entries?: Array<
-    CustomUpdateParams.UnionMember0 | CustomUpdateParams.UnionMember1 | CustomUpdateParams.UnionMember2
+    CustomUpdateParams.Predefined | CustomUpdateParams.Integration | CustomUpdateParams.ExactData
   >;
 }
 
@@ -1027,7 +491,7 @@ export namespace CustomUpdateParams {
     pattern: CustomAPI.PatternParam;
   }
 
-  export interface UnionMember0 {
+  export interface Predefined {
     enabled: boolean;
 
     entry_id: string;
@@ -1035,7 +499,7 @@ export namespace CustomUpdateParams {
     entry_type: 'predefined';
   }
 
-  export interface UnionMember1 {
+  export interface Integration {
     enabled: boolean;
 
     entry_id: string;
@@ -1043,7 +507,7 @@ export namespace CustomUpdateParams {
     entry_type: 'integration';
   }
 
-  export interface UnionMember2 {
+  export interface ExactData {
     enabled: boolean;
 
     entry_id: string;
@@ -1064,7 +528,6 @@ export declare namespace Custom {
   export {
     type CustomProfile as CustomProfile,
     type Pattern as Pattern,
-    type CustomCreateResponse as CustomCreateResponse,
     type CustomDeleteResponse as CustomDeleteResponse,
     type CustomCreateParams as CustomCreateParams,
     type CustomUpdateParams as CustomUpdateParams,