cloudflare 4.4.1 → 5.0.0

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

@@ -93,7 +93,7 @@ export interface ActivityLogSettings {
   /**
    * Enable activity logging.
    */
-  enabled?: boolean;
+  enabled?: boolean | null;
 }
 
 /**
@@ -103,7 +103,7 @@ export interface ActivityLogSettingsParam {
   /**
    * Enable activity logging.
    */
-  enabled?: boolean;
+  enabled?: boolean | null;
 }
 
 /**
@@ -113,17 +113,17 @@ export interface AntiVirusSettings {
   /**
    * Enable anti-virus scanning on downloads.
    */
-  enabled_download_phase?: boolean;
+  enabled_download_phase?: boolean | null;
 
   /**
    * Enable anti-virus scanning on uploads.
    */
-  enabled_upload_phase?: boolean;
+  enabled_upload_phase?: boolean | null;
 
   /**
    * Block requests for files that cannot be scanned.
    */
-  fail_closed?: boolean;
+  fail_closed?: boolean | null;
 
   /**
    * Configure a message to display on the user's device when an antivirus search is
@@ -139,17 +139,17 @@ export interface AntiVirusSettingsParam {
   /**
    * Enable anti-virus scanning on downloads.
    */
-  enabled_download_phase?: boolean;
+  enabled_download_phase?: boolean | null;
 
   /**
    * Enable anti-virus scanning on uploads.
    */
-  enabled_upload_phase?: boolean;
+  enabled_upload_phase?: boolean | null;
 
   /**
    * Block requests for files that cannot be scanned.
    */
-  fail_closed?: boolean;
+  fail_closed?: boolean | null;
 
   /**
    * Configure a message to display on the user's device when an antivirus search is
@@ -168,9 +168,9 @@ export interface BlockPageSettings {
   background_color?: string;
 
   /**
-   * Enable only cipher suites and TLS versions compliant with FIPS 140-2.
+   * Enable only cipher suites and TLS versions compliant with FIPS. 140-2.
    */
-  enabled?: boolean;
+  enabled?: boolean | null;
 
   /**
    * If mode is customized_block_page: block page footer text.
@@ -208,13 +208,24 @@ export interface BlockPageSettings {
    * Controls whether the user is redirected to a Cloudflare-hosted block page or to
    * a customer-provided URI.
    */
-  mode?: 'customized_block_page' | 'redirect_uri';
+  mode?: '' | 'customized_block_page' | 'redirect_uri';
 
   /**
    * If mode is customized_block_page: block page title.
    */
   name?: string;
 
+  /**
+   * This setting was shared via the Orgs API and cannot be edited by the current
+   * account.
+   */
+  read_only?: boolean | null;
+
+  /**
+   * Account tag of account that shared this setting.
+   */
+  source_account?: string | null;
+
   /**
    * If mode is customized_block_page: suppress detailed info at the bottom of the
    * block page.
@@ -225,6 +236,11 @@ export interface BlockPageSettings {
    * If mode is redirect_uri: URI to which the user should be redirected.
    */
   target_uri?: string;
+
+  /**
+   * Version number of the setting.
+   */
+  version?: number | null;
 }
 
 /**
@@ -237,9 +253,9 @@ export interface BlockPageSettingsParam {
   background_color?: string;
 
   /**
-   * Enable only cipher suites and TLS versions compliant with FIPS 140-2.
+   * Enable only cipher suites and TLS versions compliant with FIPS. 140-2.
    */
-  enabled?: boolean;
+  enabled?: boolean | null;
 
   /**
    * If mode is customized_block_page: block page footer text.
@@ -277,7 +293,7 @@ export interface BlockPageSettingsParam {
    * Controls whether the user is redirected to a Cloudflare-hosted block page or to
    * a customer-provided URI.
    */
-  mode?: 'customized_block_page' | 'redirect_uri';
+  mode?: '' | 'customized_block_page' | 'redirect_uri';
 
   /**
    * If mode is customized_block_page: block page title.
@@ -303,7 +319,7 @@ export interface BodyScanningSettings {
   /**
    * Set the inspection mode to either `deep` or `shallow`.
    */
-  inspection_mode?: string;
+  inspection_mode?: 'deep' | 'shallow';
 }
 
 /**
@@ -313,7 +329,7 @@ export interface BodyScanningSettingsParam {
   /**
    * Set the inspection mode to either `deep` or `shallow`.
    */
-  inspection_mode?: string;
+  inspection_mode?: 'deep' | 'shallow';
 }
 
 /**
@@ -348,13 +364,13 @@ export interface BrowserIsolationSettingsParam {
 
 /**
  * @deprecated Custom certificate settings for BYO-PKI. (deprecated and replaced by
- * `certificate`)
+ * `certificate`).
  */
 export interface CustomCertificateSettings {
   /**
-   * Enable use of custom certificate authority for signing Gateway traffic.
+   * Enable use of custom certificate authority for signing Gateway. traffic.
    */
-  enabled: boolean;
+  enabled: boolean | null;
 
   /**
    * UUID of certificate (ID from MTLS certificate store).
@@ -371,13 +387,13 @@ export interface CustomCertificateSettings {
 
 /**
  * @deprecated Custom certificate settings for BYO-PKI. (deprecated and replaced by
- * `certificate`)
+ * `certificate`).
  */
 export interface CustomCertificateSettingsParam {
   /**
-   * Enable use of custom certificate authority for signing Gateway traffic.
+   * Enable use of custom certificate authority for signing Gateway. traffic.
    */
-  enabled: boolean;
+  enabled: boolean | null;
 
   /**
    * UUID of certificate (ID from MTLS certificate store).
@@ -393,7 +409,23 @@ export interface ExtendedEmailMatching {
    * Enable matching all variants of user emails (with + or . modifiers) used as
    * criteria in Firewall policies.
    */
-  enabled?: boolean;
+  enabled?: boolean | null;
+
+  /**
+   * This setting was shared via the Orgs API and cannot be edited by the current
+   * account.
+   */
+  read_only?: boolean;
+
+  /**
+   * Account tag of account that shared this setting.
+   */
+  source_account?: string;
+
+  /**
+   * Version number of the setting.
+   */
+  version?: number;
 }
 
 /**
@@ -404,7 +436,7 @@ export interface ExtendedEmailMatchingParam {
    * Enable matching all variants of user emails (with + or . modifiers) used as
    * criteria in Firewall policies.
    */
-  enabled?: boolean;
+  enabled?: boolean | null;
 }
 
 /**
@@ -412,7 +444,7 @@ export interface ExtendedEmailMatchingParam {
  */
 export interface FipsSettings {
   /**
-   * Enable only cipher suites and TLS versions compliant with FIPS 140-2.
+   * Enable only cipher suites and TLS versions compliant with FIPS. 140-2.
    */
   tls?: boolean;
 }
@@ -422,13 +454,13 @@ export interface FipsSettings {
  */
 export interface FipsSettingsParam {
   /**
-   * Enable only cipher suites and TLS versions compliant with FIPS 140-2.
+   * Enable only cipher suites and TLS versions compliant with FIPS. 140-2.
    */
   tls?: boolean;
 }
 
 /**
- * Account settings
+ * Account settings.
  */
 export interface GatewayConfigurationSettings {
   /**
@@ -441,11 +473,6 @@ export interface GatewayConfigurationSettings {
    */
   antivirus?: AntiVirusSettings | null;
 
-  /**
-   * Setting to enable App Control
-   */
-  'app-control-settings'?: GatewayConfigurationSettings.AppControlSettings | null;
-
   /**
    * Block page layout settings.
    */
@@ -469,7 +496,7 @@ export interface GatewayConfigurationSettings {
 
   /**
    * @deprecated Custom certificate settings for BYO-PKI. (deprecated and replaced by
-   * `certificate`)
+   * `certificate`).
    */
   custom_certificate?: CustomCertificateSettings | null;
 
@@ -488,6 +515,11 @@ export interface GatewayConfigurationSettings {
    */
   host_selector?: GatewayConfigurationSettings.HostSelector | null;
 
+  /**
+   * Setting to define inspection settings.
+   */
+  inspection?: GatewayConfigurationSettings.Inspection | null;
+
   /**
    * Protocol Detection settings.
    */
@@ -505,16 +537,6 @@ export interface GatewayConfigurationSettings {
 }
 
 export namespace GatewayConfigurationSettings {
-  /**
-   * Setting to enable App Control
-   */
-  export interface AppControlSettings {
-    /**
-     * Enable App Control
-     */
-    enabled?: boolean;
-  }
-
   /**
    * Certificate settings for Gateway TLS interception. If not specified, the
    * Cloudflare Root CA will be used.
@@ -535,7 +557,22 @@ export namespace GatewayConfigurationSettings {
     /**
      * Enable filtering via hosts for egress policies.
      */
-    enabled?: boolean;
+    enabled?: boolean | null;
+  }
+
+  /**
+   * Setting to define inspection settings.
+   */
+  export interface Inspection {
+    /**
+     * Defines the mode of inspection the proxy will use.
+     *
+     * - static: Gateway will use static inspection to inspect HTTP on TCP(80). If TLS
+     *   decryption is on, Gateway will inspect HTTPS traffic on TCP(443) & UDP(443).
+     * - dynamic: Gateway will use protocol detection to dynamically inspect HTTP and
+     *   HTTPS traffic on any port. TLS decryption must be on to inspect HTTPS traffic.
+     */
+    mode?: 'static' | 'dynamic';
   }
 
   /**
@@ -545,7 +582,7 @@ export namespace GatewayConfigurationSettings {
     /**
      * Enable sandbox.
      */
-    enabled?: boolean;
+    enabled?: boolean | null;
 
     /**
      * Action to take when the file cannot be scanned.
@@ -555,7 +592,7 @@ export namespace GatewayConfigurationSettings {
 }
 
 /**
- * Account settings
+ * Account settings.
  */
 export interface GatewayConfigurationSettingsParam {
   /**
@@ -568,11 +605,6 @@ export interface GatewayConfigurationSettingsParam {
    */
   antivirus?: AntiVirusSettingsParam | null;
 
-  /**
-   * Setting to enable App Control
-   */
-  'app-control-settings'?: GatewayConfigurationSettingsParam.AppControlSettings | null;
-
   /**
    * Block page layout settings.
    */
@@ -596,7 +628,7 @@ export interface GatewayConfigurationSettingsParam {
 
   /**
    * @deprecated Custom certificate settings for BYO-PKI. (deprecated and replaced by
-   * `certificate`)
+   * `certificate`).
    */
   custom_certificate?: CustomCertificateSettingsParam | null;
 
@@ -615,6 +647,11 @@ export interface GatewayConfigurationSettingsParam {
    */
   host_selector?: GatewayConfigurationSettingsParam.HostSelector | null;
 
+  /**
+   * Setting to define inspection settings.
+   */
+  inspection?: GatewayConfigurationSettingsParam.Inspection | null;
+
   /**
    * Protocol Detection settings.
    */
@@ -632,16 +669,6 @@ export interface GatewayConfigurationSettingsParam {
 }
 
 export namespace GatewayConfigurationSettingsParam {
-  /**
-   * Setting to enable App Control
-   */
-  export interface AppControlSettings {
-    /**
-     * Enable App Control
-     */
-    enabled?: boolean;
-  }
-
   /**
    * Certificate settings for Gateway TLS interception. If not specified, the
    * Cloudflare Root CA will be used.
@@ -662,7 +689,22 @@ export namespace GatewayConfigurationSettingsParam {
     /**
      * Enable filtering via hosts for egress policies.
      */
-    enabled?: boolean;
+    enabled?: boolean | null;
+  }
+
+  /**
+   * Setting to define inspection settings.
+   */
+  export interface Inspection {
+    /**
+     * Defines the mode of inspection the proxy will use.
+     *
+     * - static: Gateway will use static inspection to inspect HTTP on TCP(80). If TLS
+     *   decryption is on, Gateway will inspect HTTPS traffic on TCP(443) & UDP(443).
+     * - dynamic: Gateway will use protocol detection to dynamically inspect HTTP and
+     *   HTTPS traffic on any port. TLS decryption must be on to inspect HTTPS traffic.
+     */
+    mode?: 'static' | 'dynamic';
   }
 
   /**
@@ -672,7 +714,7 @@ export namespace GatewayConfigurationSettingsParam {
     /**
      * Enable sandbox.
      */
-    enabled?: boolean;
+    enabled?: boolean | null;
 
     /**
      * Action to take when the file cannot be scanned.
@@ -687,12 +729,12 @@ export namespace GatewayConfigurationSettingsParam {
  */
 export interface NotificationSettings {
   /**
-   * Set notification on
+   * Set notification on.
    */
   enabled?: boolean;
 
   /**
-   * If true, context information will be passed as query parameters
+   * If true, context information will be passed as query parameters.
    */
   include_context?: boolean;
 
@@ -714,12 +756,12 @@ export interface NotificationSettings {
  */
 export interface NotificationSettingsParam {
   /**
-   * Set notification on
+   * Set notification on.
    */
   enabled?: boolean;
 
   /**
-   * If true, context information will be passed as query parameters
+   * If true, context information will be passed as query parameters.
    */
   include_context?: boolean;
 
@@ -742,7 +784,7 @@ export interface ProtocolDetection {
   /**
    * Enable detecting protocol on initial bytes of client traffic.
    */
-  enabled?: boolean;
+  enabled?: boolean | null;
 }
 
 /**
@@ -752,7 +794,7 @@ export interface ProtocolDetectionParam {
   /**
    * Enable detecting protocol on initial bytes of client traffic.
    */
-  enabled?: boolean;
+  enabled?: boolean | null;
 }
 
 /**
@@ -776,13 +818,13 @@ export interface TLSSettingsParam {
 }
 
 /**
- * Account settings
+ * Account settings.
  */
 export interface ConfigurationUpdateResponse {
   created_at?: string;
 
   /**
-   * Account settings
+   * Account settings.
    */
   settings?: GatewayConfigurationSettings;
 
@@ -790,13 +832,13 @@ export interface ConfigurationUpdateResponse {
 }
 
 /**
- * Account settings
+ * Account settings.
  */
 export interface ConfigurationEditResponse {
   created_at?: string;
 
   /**
-   * Account settings
+   * Account settings.
    */
   settings?: GatewayConfigurationSettings;
 
@@ -804,13 +846,13 @@ export interface ConfigurationEditResponse {
 }
 
 /**
- * Account settings
+ * Account settings.
  */
 export interface ConfigurationGetResponse {
   created_at?: string;
 
   /**
-   * Account settings
+   * Account settings.
    */
   settings?: GatewayConfigurationSettings;
 
@@ -824,7 +866,7 @@ export interface ConfigurationUpdateParams {
   account_id: string;
 
   /**
-   * Body param: Account settings
+   * Body param: Account settings.
    */
   settings?: GatewayConfigurationSettingsParam;
 }
@@ -836,7 +878,7 @@ export interface ConfigurationEditParams {
   account_id: string;
 
   /**
-   * Body param: Account settings
+   * Body param: Account settings.
    */
   settings?: GatewayConfigurationSettingsParam;
 }

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

@@ -186,7 +186,7 @@ export interface GatewayCreateResponse {
   gateway_tag?: string;
 
   /**
-   * The name of the provider. Usually Cloudflare.
+   * Provider Name. Usually Cloudflare.
    */
   provider_name?: string;
 }
@@ -203,7 +203,7 @@ export interface GatewayListResponse {
   gateway_tag?: string;
 
   /**
-   * The name of the provider. Usually Cloudflare.
+   * Provider Name. Usually Cloudflare.
    */
   provider_name?: string;
 }

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

@@ -158,19 +158,7 @@ export interface GatewayItem {
   created_at?: string;
 
   /**
-   * The description of the list item, if present
-   */
-  description?: string;
-
-  /**
-   * The value of the item in a list.
-   */
-  value?: string;
-}
-
-export interface GatewayItemParam {
-  /**
-   * The description of the list item, if present
+   * The description of the list item, if present.
    */
   description?: string;
 
@@ -271,9 +259,23 @@ export interface ListCreateParams {
   description?: string;
 
   /**
-   * Body param: The items in the list.
+   * Body param: items to add to the list.
    */
-  items?: Array<GatewayItemParam>;
+  items?: Array<ListCreateParams.Item>;
+}
+
+export namespace ListCreateParams {
+  export interface Item {
+    /**
+     * The description of the list item, if present.
+     */
+    description?: string;
+
+    /**
+     * The value of the item in a list.
+     */
+    value?: string;
+  }
 }
 
 export interface ListUpdateParams {
@@ -293,9 +295,23 @@ export interface ListUpdateParams {
   description?: string;
 
   /**
-   * Body param: The items in the list.
+   * Body param: items to add to the list.
    */
-  items?: Array<GatewayItemParam>;
+  items?: Array<ListUpdateParams.Item>;
+}
+
+export namespace ListUpdateParams {
+  export interface Item {
+    /**
+     * The description of the list item, if present.
+     */
+    description?: string;
+
+    /**
+     * The value of the item in a list.
+     */
+    value?: string;
+  }
 }
 
 export interface ListListParams {
@@ -334,7 +350,7 @@ export interface ListEditParams {
 export namespace ListEditParams {
   export interface Append {
     /**
-     * The description of the list item, if present
+     * The description of the list item, if present.
      */
     description?: string;