cloudflare 4.5.0 → 5.1.0

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

@@ -78,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 {
   /**
@@ -95,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 {
   /**
@@ -125,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.DocumentFingerprintEntry
-      | CustomProfile.WordListEntry
-    >;
-
     /**
      * The name of the profile.
      */
@@ -163,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 {
@@ -200,6 +200,8 @@ export namespace Profile {
       type: 'predefined';
 
       profile_id?: string | null;
+
+      variant?: PredefinedEntry.Variant;
     }
 
     export namespace PredefinedEntry {
@@ -215,6 +217,14 @@ export namespace Profile {
          */
         available: boolean;
       }
+
+      export interface Variant {
+        topic_type: 'Intent' | 'Content';
+
+        type: 'PromptTopic';
+
+        description?: string | null;
+      }
     }
 
     export interface IntegrationEntry {
@@ -317,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;
 
@@ -361,6 +371,8 @@ export namespace Profile {
       type: 'predefined';
 
       profile_id?: string | null;
+
+      variant?: PredefinedEntry.Variant;
     }
 
     export namespace PredefinedEntry {
@@ -376,6 +388,14 @@ export namespace Profile {
          */
         available: boolean;
       }
+
+      export interface Variant {
+        topic_type: 'Intent' | 'Content';
+
+        type: 'PromptTopic';
+
+        description?: string | null;
+      }
     }
 
     export interface IntegrationEntry {
@@ -506,6 +526,8 @@ export namespace Profile {
       type: 'predefined';
 
       profile_id?: string | null;
+
+      variant?: PredefinedEntry.Variant;
     }
 
     export namespace PredefinedEntry {
@@ -521,6 +543,14 @@ export namespace Profile {
          */
         available: boolean;
       }
+
+      export interface Variant {
+        topic_type: 'Intent' | 'Content';
+
+        type: 'PromptTopic';
+
+        description?: string | null;
+      }
     }
 
     export interface IntegrationEntry {

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;
 }

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

@@ -111,7 +111,7 @@ export class Certificates extends APIResource {
   }
 
   /**
-   * Unbinds a single Zero Trust certificate from the edge
+   * Unbinds a single Zero Trust certificate from the edge.
    *
    * @example
    * ```ts
@@ -175,14 +175,14 @@ export interface CertificateCreateResponse {
   id?: string;
 
   /**
-   * The deployment status of the certificate on Cloudflare's edge. Certificates in
-   * the 'available' (previously called 'active') state may be used for Gateway TLS
-   * interception.
+   * The read only deployment status of the certificate on Cloudflare's edge.
+   * Certificates in the 'available' (previously called 'active') state may be used
+   * for Gateway TLS interception.
    */
   binding_status?: 'pending_deployment' | 'available' | 'pending_deletion' | 'inactive';
 
   /**
-   * The CA certificate
+   * The CA certificate(read only).
    */
   certificate?: string;
 
@@ -191,27 +191,29 @@ export interface CertificateCreateResponse {
   expires_on?: string;
 
   /**
-   * The SHA256 fingerprint of the certificate.
+   * The SHA256 fingerprint of the certificate(read only).
    */
   fingerprint?: string;
 
   /**
-   * Use this certificate for Gateway TLS interception
+   * Read-only field that shows whether Gateway TLS interception is using this
+   * certificate. This value cannot be set directly. To configure the certificate for
+   * interception, use the Gateway configuration setting named certificate.
    */
   in_use?: boolean;
 
   /**
-   * The organization that issued the certificate.
+   * The organization that issued the certificate(read only).
    */
   issuer_org?: string;
 
   /**
-   * The entire issuer field of the certificate.
+   * The entire issuer field of the certificate(read only).
    */
   issuer_raw?: string;
 
   /**
-   * The type of certificate, either BYO-PKI (custom) or Gateway-managed.
+   * The type of certificate, either BYO-PKI (custom) or Gateway-managed(read only).
    */
   type?: 'custom' | 'gateway_managed';
 
@@ -227,14 +229,14 @@ export interface CertificateListResponse {
   id?: string;
 
   /**
-   * The deployment status of the certificate on Cloudflare's edge. Certificates in
-   * the 'available' (previously called 'active') state may be used for Gateway TLS
-   * interception.
+   * The read only deployment status of the certificate on Cloudflare's edge.
+   * Certificates in the 'available' (previously called 'active') state may be used
+   * for Gateway TLS interception.
    */
   binding_status?: 'pending_deployment' | 'available' | 'pending_deletion' | 'inactive';
 
   /**
-   * The CA certificate
+   * The CA certificate(read only).
    */
   certificate?: string;
 
@@ -243,27 +245,29 @@ export interface CertificateListResponse {
   expires_on?: string;
 
   /**
-   * The SHA256 fingerprint of the certificate.
+   * The SHA256 fingerprint of the certificate(read only).
    */
   fingerprint?: string;
 
   /**
-   * Use this certificate for Gateway TLS interception
+   * Read-only field that shows whether Gateway TLS interception is using this
+   * certificate. This value cannot be set directly. To configure the certificate for
+   * interception, use the Gateway configuration setting named certificate.
    */
   in_use?: boolean;
 
   /**
-   * The organization that issued the certificate.
+   * The organization that issued the certificate(read only).
    */
   issuer_org?: string;
 
   /**
-   * The entire issuer field of the certificate.
+   * The entire issuer field of the certificate(read only).
    */
   issuer_raw?: string;
 
   /**
-   * The type of certificate, either BYO-PKI (custom) or Gateway-managed.
+   * The type of certificate, either BYO-PKI (custom) or Gateway-managed(read only).
    */
   type?: 'custom' | 'gateway_managed';
 
@@ -279,14 +283,14 @@ export interface CertificateDeleteResponse {
   id?: string;
 
   /**
-   * The deployment status of the certificate on Cloudflare's edge. Certificates in
-   * the 'available' (previously called 'active') state may be used for Gateway TLS
-   * interception.
+   * The read only deployment status of the certificate on Cloudflare's edge.
+   * Certificates in the 'available' (previously called 'active') state may be used
+   * for Gateway TLS interception.
    */
   binding_status?: 'pending_deployment' | 'available' | 'pending_deletion' | 'inactive';
 
   /**
-   * The CA certificate
+   * The CA certificate(read only).
    */
   certificate?: string;
 
@@ -295,27 +299,29 @@ export interface CertificateDeleteResponse {
   expires_on?: string;
 
   /**
-   * The SHA256 fingerprint of the certificate.
+   * The SHA256 fingerprint of the certificate(read only).
    */
   fingerprint?: string;
 
   /**
-   * Use this certificate for Gateway TLS interception
+   * Read-only field that shows whether Gateway TLS interception is using this
+   * certificate. This value cannot be set directly. To configure the certificate for
+   * interception, use the Gateway configuration setting named certificate.
    */
   in_use?: boolean;
 
   /**
-   * The organization that issued the certificate.
+   * The organization that issued the certificate(read only).
    */
   issuer_org?: string;
 
   /**
-   * The entire issuer field of the certificate.
+   * The entire issuer field of the certificate(read only).
    */
   issuer_raw?: string;
 
   /**
-   * The type of certificate, either BYO-PKI (custom) or Gateway-managed.
+   * The type of certificate, either BYO-PKI (custom) or Gateway-managed(read only).
    */
   type?: 'custom' | 'gateway_managed';
 
@@ -331,14 +337,14 @@ export interface CertificateActivateResponse {
   id?: string;
 
   /**
-   * The deployment status of the certificate on Cloudflare's edge. Certificates in
-   * the 'available' (previously called 'active') state may be used for Gateway TLS
-   * interception.
+   * The read only deployment status of the certificate on Cloudflare's edge.
+   * Certificates in the 'available' (previously called 'active') state may be used
+   * for Gateway TLS interception.
    */
   binding_status?: 'pending_deployment' | 'available' | 'pending_deletion' | 'inactive';
 
   /**
-   * The CA certificate
+   * The CA certificate(read only).
    */
   certificate?: string;
 
@@ -347,27 +353,29 @@ export interface CertificateActivateResponse {
   expires_on?: string;
 
   /**
-   * The SHA256 fingerprint of the certificate.
+   * The SHA256 fingerprint of the certificate(read only).
    */
   fingerprint?: string;
 
   /**
-   * Use this certificate for Gateway TLS interception
+   * Read-only field that shows whether Gateway TLS interception is using this
+   * certificate. This value cannot be set directly. To configure the certificate for
+   * interception, use the Gateway configuration setting named certificate.
    */
   in_use?: boolean;
 
   /**
-   * The organization that issued the certificate.
+   * The organization that issued the certificate(read only).
    */
   issuer_org?: string;
 
   /**
-   * The entire issuer field of the certificate.
+   * The entire issuer field of the certificate(read only).
    */
   issuer_raw?: string;
 
   /**
-   * The type of certificate, either BYO-PKI (custom) or Gateway-managed.
+   * The type of certificate, either BYO-PKI (custom) or Gateway-managed(read only).
    */
   type?: 'custom' | 'gateway_managed';
 
@@ -383,14 +391,14 @@ export interface CertificateDeactivateResponse {
   id?: string;
 
   /**
-   * The deployment status of the certificate on Cloudflare's edge. Certificates in
-   * the 'available' (previously called 'active') state may be used for Gateway TLS
-   * interception.
+   * The read only deployment status of the certificate on Cloudflare's edge.
+   * Certificates in the 'available' (previously called 'active') state may be used
+   * for Gateway TLS interception.
    */
   binding_status?: 'pending_deployment' | 'available' | 'pending_deletion' | 'inactive';
 
   /**
-   * The CA certificate
+   * The CA certificate(read only).
    */
   certificate?: string;
 
@@ -399,27 +407,29 @@ export interface CertificateDeactivateResponse {
   expires_on?: string;
 
   /**
-   * The SHA256 fingerprint of the certificate.
+   * The SHA256 fingerprint of the certificate(read only).
    */
   fingerprint?: string;
 
   /**
-   * Use this certificate for Gateway TLS interception
+   * Read-only field that shows whether Gateway TLS interception is using this
+   * certificate. This value cannot be set directly. To configure the certificate for
+   * interception, use the Gateway configuration setting named certificate.
    */
   in_use?: boolean;
 
   /**
-   * The organization that issued the certificate.
+   * The organization that issued the certificate(read only).
    */
   issuer_org?: string;
 
   /**
-   * The entire issuer field of the certificate.
+   * The entire issuer field of the certificate(read only).
    */
   issuer_raw?: string;
 
   /**
-   * The type of certificate, either BYO-PKI (custom) or Gateway-managed.
+   * The type of certificate, either BYO-PKI (custom) or Gateway-managed(read only).
    */
   type?: 'custom' | 'gateway_managed';
 
@@ -435,14 +445,14 @@ export interface CertificateGetResponse {
   id?: string;
 
   /**
-   * The deployment status of the certificate on Cloudflare's edge. Certificates in
-   * the 'available' (previously called 'active') state may be used for Gateway TLS
-   * interception.
+   * The read only deployment status of the certificate on Cloudflare's edge.
+   * Certificates in the 'available' (previously called 'active') state may be used
+   * for Gateway TLS interception.
    */
   binding_status?: 'pending_deployment' | 'available' | 'pending_deletion' | 'inactive';
 
   /**
-   * The CA certificate
+   * The CA certificate(read only).
    */
   certificate?: string;
 
@@ -451,27 +461,29 @@ export interface CertificateGetResponse {
   expires_on?: string;
 
   /**
-   * The SHA256 fingerprint of the certificate.
+   * The SHA256 fingerprint of the certificate(read only).
    */
   fingerprint?: string;
 
   /**
-   * Use this certificate for Gateway TLS interception
+   * Read-only field that shows whether Gateway TLS interception is using this
+   * certificate. This value cannot be set directly. To configure the certificate for
+   * interception, use the Gateway configuration setting named certificate.
    */
   in_use?: boolean;
 
   /**
-   * The organization that issued the certificate.
+   * The organization that issued the certificate(read only).
    */
   issuer_org?: string;
 
   /**
-   * The entire issuer field of the certificate.
+   * The entire issuer field of the certificate(read only).
    */
   issuer_raw?: string;
 
   /**
-   * The type of certificate, either BYO-PKI (custom) or Gateway-managed.
+   * The type of certificate, either BYO-PKI (custom) or Gateway-managed(read only).
    */
   type?: 'custom' | 'gateway_managed';