cloudflare 4.4.1 → 5.0.0

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.DocumentTemplateEntry
-    | 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 {
@@ -253,7 +256,7 @@ export namespace CustomProfile {
     updated_at: string;
   }
 
-  export interface DocumentTemplateEntry {
+  export interface DocumentFingerprintEntry {
     id: string;
 
     created_at: string;
@@ -262,7 +265,7 @@ export namespace CustomProfile {
 
     name: string;
 
-    type: 'document_template';
+    type: 'document_fingerprint';
 
     updated_at: string;
   }
@@ -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:
    */
@@ -363,6 +366,7 @@ export interface CustomCreateParams {
     | CustomCreateParams.Predefined
     | CustomCreateParams.Integration
     | CustomCreateParams.ExactData
+    | CustomCreateParams.UnionMember4
   >;
 }
 
@@ -414,6 +418,14 @@ export namespace CustomCreateParams {
 
     entry_type: 'exact_data';
   }
+
+  export interface UnionMember4 {
+    enabled: boolean;
+
+    entry_id: string;
+
+    entry_type: 'document_fingerprint';
+  }
 }
 
 export interface CustomUpdateParams {
@@ -443,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;
 
@@ -468,7 +480,10 @@ export interface CustomUpdateParams {
    * Body param: Other entries, e.g. predefined or integration.
    */
   shared_entries?: Array<
-    CustomUpdateParams.Predefined | CustomUpdateParams.Integration | CustomUpdateParams.ExactData
+    | CustomUpdateParams.Predefined
+    | CustomUpdateParams.Integration
+    | CustomUpdateParams.ExactData
+    | CustomUpdateParams.UnionMember3
   >;
 }
 
@@ -514,6 +529,14 @@ export namespace CustomUpdateParams {
 
     entry_type: 'exact_data';
   }
+
+  export interface UnionMember3 {
+    enabled: boolean;
+
+    entry_id: string;
+
+    entry_type: 'document_fingerprint';
+  }
 }
 
 export interface CustomDeleteParams {

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

@@ -13,7 +13,10 @@ export {
 export {
   Predefined,
   type PredefinedProfile,
+  type PredefinedDeleteResponse,
+  type PredefinedCreateParams,
   type PredefinedUpdateParams,
+  type PredefinedDeleteParams,
   type PredefinedGetParams,
 } from './predefined';
 export {

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

@@ -6,6 +6,31 @@ 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.
+   *
+   * @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.
    *
@@ -32,6 +57,33 @@ export class Predefined extends APIResource {
     )._thenUnwrap((obj) => obj.result);
   }
 
+  /**
+   * This is a no-op as predefined profiles can't be deleted but is needed for our
+   * generated terraform API
+   *
+   * @example
+   * ```ts
+   * const predefined =
+   *   await client.zeroTrust.dlp.profiles.predefined.delete(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     { account_id: 'account_id' },
+   *   );
+   * ```
+   */
+  delete(
+    profileId: string,
+    params: PredefinedDeleteParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PredefinedDeleteResponse | null> {
+    const { account_id } = params;
+    return (
+      this._client.delete(
+        `/accounts/${account_id}/dlp/profiles/predefined/${profileId}`,
+        options,
+      ) as Core.APIPromise<{ result: PredefinedDeleteResponse | null }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
   /**
    * Fetches a predefined DLP profile by id.
    *
@@ -72,7 +124,7 @@ export interface PredefinedProfile {
     | PredefinedProfile.PredefinedEntry
     | PredefinedProfile.IntegrationEntry
     | PredefinedProfile.ExactDataEntry
-    | PredefinedProfile.DocumentTemplateEntry
+    | PredefinedProfile.DocumentFingerprintEntry
     | PredefinedProfile.WordListEntry
   >;
 
@@ -86,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;
 
@@ -130,6 +182,8 @@ export namespace PredefinedProfile {
     type: 'predefined';
 
     profile_id?: string | null;
+
+    variant?: PredefinedEntry.Variant;
   }
 
   export namespace PredefinedEntry {
@@ -145,6 +199,14 @@ export namespace PredefinedProfile {
        */
       available: boolean;
     }
+
+    export interface Variant {
+      topic_type: 'Intent' | 'Content';
+
+      type: 'PromptTopic';
+
+      description?: string | null;
+    }
   }
 
   export interface IntegrationEntry {
@@ -185,7 +247,7 @@ export namespace PredefinedProfile {
     updated_at: string;
   }
 
-  export interface DocumentTemplateEntry {
+  export interface DocumentFingerprintEntry {
     id: string;
 
     created_at: string;
@@ -194,7 +256,7 @@ export namespace PredefinedProfile {
 
     name: string;
 
-    type: 'document_template';
+    type: 'document_fingerprint';
 
     updated_at: string;
   }
@@ -218,6 +280,59 @@ 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:
@@ -240,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;
 
@@ -264,6 +379,10 @@ export namespace PredefinedUpdateParams {
   }
 }
 
+export interface PredefinedDeleteParams {
+  account_id: string;
+}
+
 export interface PredefinedGetParams {
   account_id: string;
 }
@@ -271,7 +390,10 @@ export interface PredefinedGetParams {
 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,
   };
 }

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

@@ -17,6 +17,9 @@ import {
 import * as PredefinedAPI from './predefined';
 import {
   Predefined,
+  PredefinedCreateParams,
+  PredefinedDeleteParams,
+  PredefinedDeleteResponse,
   PredefinedGetParams,
   PredefinedProfile as PredefinedAPIPredefinedProfile,
   PredefinedUpdateParams,
@@ -75,8 +78,8 @@ export class Profiles extends APIResource {
 export class ProfilesSinglePage extends SinglePage<Profile> {}
 
 /**
- * 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.
  */
 export interface ContextAwareness {
   /**
@@ -92,8 +95,8 @@ export interface ContextAwareness {
 }
 
 /**
- * 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.
  */
 export interface ContextAwarenessParam {
   /**
@@ -122,26 +125,11 @@ export namespace Profile {
      */
     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.DocumentTemplateEntry
-      | CustomProfile.WordListEntry
-    >;
-
     /**
      * The name of the profile.
      */
@@ -160,10 +148,25 @@ export namespace Profile {
 
     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 {
@@ -197,6 +200,8 @@ export namespace Profile {
       type: 'predefined';
 
       profile_id?: string | null;
+
+      variant?: PredefinedEntry.Variant;
     }
 
     export namespace PredefinedEntry {
@@ -212,6 +217,14 @@ export namespace Profile {
          */
         available: boolean;
       }
+
+      export interface Variant {
+        topic_type: 'Intent' | 'Content';
+
+        type: 'PromptTopic';
+
+        description?: string | null;
+      }
     }
 
     export interface IntegrationEntry {
@@ -252,7 +265,7 @@ export namespace Profile {
       updated_at: string;
     }
 
-    export interface DocumentTemplateEntry {
+    export interface DocumentFingerprintEntry {
       id: string;
 
       created_at: string;
@@ -261,7 +274,7 @@ export namespace Profile {
 
       name: string;
 
-      type: 'document_template';
+      type: 'document_fingerprint';
 
       updated_at: string;
     }
@@ -298,7 +311,7 @@ export namespace Profile {
       | PredefinedProfile.PredefinedEntry
       | PredefinedProfile.IntegrationEntry
       | PredefinedProfile.ExactDataEntry
-      | PredefinedProfile.DocumentTemplateEntry
+      | PredefinedProfile.DocumentFingerprintEntry
       | PredefinedProfile.WordListEntry
     >;
 
@@ -314,8 +327,8 @@ export namespace Profile {
     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;
 
@@ -358,6 +371,8 @@ export namespace Profile {
       type: 'predefined';
 
       profile_id?: string | null;
+
+      variant?: PredefinedEntry.Variant;
     }
 
     export namespace PredefinedEntry {
@@ -373,6 +388,14 @@ export namespace Profile {
          */
         available: boolean;
       }
+
+      export interface Variant {
+        topic_type: 'Intent' | 'Content';
+
+        type: 'PromptTopic';
+
+        description?: string | null;
+      }
     }
 
     export interface IntegrationEntry {
@@ -413,7 +436,7 @@ export namespace Profile {
       updated_at: string;
     }
 
-    export interface DocumentTemplateEntry {
+    export interface DocumentFingerprintEntry {
       id: string;
 
       created_at: string;
@@ -422,7 +445,7 @@ export namespace Profile {
 
       name: string;
 
-      type: 'document_template';
+      type: 'document_fingerprint';
 
       updated_at: string;
     }
@@ -456,7 +479,7 @@ export namespace Profile {
       | IntegrationProfile.PredefinedEntry
       | IntegrationProfile.IntegrationEntry
       | IntegrationProfile.ExactDataEntry
-      | IntegrationProfile.DocumentTemplateEntry
+      | IntegrationProfile.DocumentFingerprintEntry
       | IntegrationProfile.WordListEntry
     >;
 
@@ -503,6 +526,8 @@ export namespace Profile {
       type: 'predefined';
 
       profile_id?: string | null;
+
+      variant?: PredefinedEntry.Variant;
     }
 
     export namespace PredefinedEntry {
@@ -518,6 +543,14 @@ export namespace Profile {
          */
         available: boolean;
       }
+
+      export interface Variant {
+        topic_type: 'Intent' | 'Content';
+
+        type: 'PromptTopic';
+
+        description?: string | null;
+      }
     }
 
     export interface IntegrationEntry {
@@ -558,7 +591,7 @@ export namespace Profile {
       updated_at: string;
     }
 
-    export interface DocumentTemplateEntry {
+    export interface DocumentFingerprintEntry {
       id: string;
 
       created_at: string;
@@ -567,7 +600,7 @@ export namespace Profile {
 
       name: string;
 
-      type: 'document_template';
+      type: 'document_fingerprint';
 
       updated_at: string;
     }
@@ -657,7 +690,10 @@ export declare namespace Profiles {
   export {
     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,
   };
 }

package/src/resources/zero-trust/gateway/app-types.ts

@@ -75,7 +75,7 @@ export namespace AppType {
 
 export interface AppTypeListParams {
   /**
-   * Identifier
+   * Identifier.
    */
   account_id: string;
 }

package/src/resources/zero-trust/gateway/audit-ssh-settings.ts

@@ -88,7 +88,7 @@ export interface GatewaySettings {
   public_key?: string;
 
   /**
-   * Seed ID
+   * Seed ID.
    */
   seed_id?: string;
 

package/src/resources/zero-trust/gateway/categories.ts

@@ -102,7 +102,7 @@ export namespace Category {
 
 export interface CategoryListParams {
   /**
-   * Identifier
+   * Identifier.
    */
   account_id: string;
 }