cloudflare 3.1.0 → 3.2.0

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

@@ -67,6 +67,16 @@ export interface ActivityLogSettings {
   enabled?: boolean;
 }
 
+/**
+ * Activity log settings.
+ */
+export interface ActivityLogSettingsParam {
+  /**
+   * Enable activity logging.
+   */
+  enabled?: boolean;
+}
+
 /**
  * Anti-virus settings.
  */
@@ -93,6 +103,32 @@ export interface AntiVirusSettings {
   notification_settings?: NotificationSettings;
 }
 
+/**
+ * Anti-virus settings.
+ */
+export interface AntiVirusSettingsParam {
+  /**
+   * Enable anti-virus scanning on downloads.
+   */
+  enabled_download_phase?: boolean;
+
+  /**
+   * Enable anti-virus scanning on uploads.
+   */
+  enabled_upload_phase?: boolean;
+
+  /**
+   * Block requests for files that cannot be scanned.
+   */
+  fail_closed?: boolean;
+
+  /**
+   * Configure a message to display on the user's device when an antivirus search is
+   * performed.
+   */
+  notification_settings?: NotificationSettingsParam;
+}
+
 /**
  * Block page layout settings.
  */
@@ -143,6 +179,56 @@ export interface BlockPageSettings {
   suppress_footer?: boolean;
 }
 
+/**
+ * Block page layout settings.
+ */
+export interface BlockPageSettingsParam {
+  /**
+   * Block page background color in #rrggbb format.
+   */
+  background_color?: string;
+
+  /**
+   * Enable only cipher suites and TLS versions compliant with FIPS 140-2.
+   */
+  enabled?: boolean;
+
+  /**
+   * Block page footer text.
+   */
+  footer_text?: string;
+
+  /**
+   * Block page header text.
+   */
+  header_text?: string;
+
+  /**
+   * Full URL to the logo file.
+   */
+  logo_path?: string;
+
+  /**
+   * Admin email for users to contact.
+   */
+  mailto_address?: string;
+
+  /**
+   * Subject line for emails created from block page.
+   */
+  mailto_subject?: string;
+
+  /**
+   * Block page title.
+   */
+  name?: string;
+
+  /**
+   * Suppress detailed info at the bottom of the block page.
+   */
+  suppress_footer?: boolean;
+}
+
 /**
  * DLP body scanning settings.
  */
@@ -153,6 +239,16 @@ export interface BodyScanningSettings {
   inspection_mode?: string;
 }
 
+/**
+ * DLP body scanning settings.
+ */
+export interface BodyScanningSettingsParam {
+  /**
+   * Set the inspection mode to either `deep` or `shallow`.
+   */
+  inspection_mode?: string;
+}
+
 /**
  * Browser isolation settings.
  */
@@ -168,6 +264,21 @@ export interface BrowserIsolationSettings {
   url_browser_isolation_enabled?: boolean;
 }
 
+/**
+ * Browser isolation settings.
+ */
+export interface BrowserIsolationSettingsParam {
+  /**
+   * Enable non-identity onramp support for Browser Isolation.
+   */
+  non_identity_enabled?: boolean;
+
+  /**
+   * Enable Clientless Browser Isolation.
+   */
+  url_browser_isolation_enabled?: boolean;
+}
+
 /**
  * Custom certificate settings for BYO-PKI.
  */
@@ -190,6 +301,21 @@ export interface CustomCertificateSettings {
   updated_at?: string;
 }
 
+/**
+ * Custom certificate settings for BYO-PKI.
+ */
+export interface CustomCertificateSettingsParam {
+  /**
+   * Enable use of custom certificate authority for signing Gateway traffic.
+   */
+  enabled: boolean;
+
+  /**
+   * UUID of certificate (ID from MTLS certificate store).
+   */
+  id?: string;
+}
+
 /**
  * Extended e-mail matching settings.
  */
@@ -201,6 +327,17 @@ export interface ExtendedEmailMatching {
   enabled?: boolean;
 }
 
+/**
+ * Extended e-mail matching settings.
+ */
+export interface ExtendedEmailMatchingParam {
+  /**
+   * Enable matching all variants of user emails (with + or . modifiers) used as
+   * criteria in Firewall policies.
+   */
+  enabled?: boolean;
+}
+
 /**
  * FIPS settings.
  */
@@ -211,6 +348,16 @@ export interface FipsSettings {
   tls?: boolean;
 }
 
+/**
+ * FIPS settings.
+ */
+export interface FipsSettingsParam {
+  /**
+   * Enable only cipher suites and TLS versions compliant with FIPS 140-2.
+   */
+  tls?: boolean;
+}
+
 /**
  * account settings.
  */
@@ -266,6 +413,61 @@ export interface GatewayConfigurationSettings {
   tls_decrypt?: TLSSettings;
 }
 
+/**
+ * account settings.
+ */
+export interface GatewayConfigurationSettingsParam {
+  /**
+   * Activity log settings.
+   */
+  activity_log?: ActivityLogSettingsParam;
+
+  /**
+   * Anti-virus settings.
+   */
+  antivirus?: AntiVirusSettingsParam;
+
+  /**
+   * Block page layout settings.
+   */
+  block_page?: BlockPageSettingsParam;
+
+  /**
+   * DLP body scanning settings.
+   */
+  body_scanning?: BodyScanningSettingsParam;
+
+  /**
+   * Browser isolation settings.
+   */
+  browser_isolation?: BrowserIsolationSettingsParam;
+
+  /**
+   * Custom certificate settings for BYO-PKI.
+   */
+  custom_certificate?: CustomCertificateSettingsParam;
+
+  /**
+   * Extended e-mail matching settings.
+   */
+  extended_email_matching?: ExtendedEmailMatchingParam;
+
+  /**
+   * FIPS settings.
+   */
+  fips?: FipsSettingsParam;
+
+  /**
+   * Protocol Detection settings.
+   */
+  protocol_detection?: ProtocolDetectionParam;
+
+  /**
+   * TLS interception settings.
+   */
+  tls_decrypt?: TLSSettingsParam;
+}
+
 /**
  * Configure a message to display on the user's device when an antivirus search is
  * performed.
@@ -288,6 +490,28 @@ export interface NotificationSettings {
   support_url?: string;
 }
 
+/**
+ * Configure a message to display on the user's device when an antivirus search is
+ * performed.
+ */
+export interface NotificationSettingsParam {
+  /**
+   * Set notification on
+   */
+  enabled?: boolean;
+
+  /**
+   * Customize the message shown in the notification.
+   */
+  msg?: string;
+
+  /**
+   * Optional URL to direct users to additional information. If not set, the
+   * notification will open a block page.
+   */
+  support_url?: string;
+}
+
 /**
  * Protocol Detection settings.
  */
@@ -298,6 +522,16 @@ export interface ProtocolDetection {
   enabled?: boolean;
 }
 
+/**
+ * Protocol Detection settings.
+ */
+export interface ProtocolDetectionParam {
+  /**
+   * Enable detecting protocol on initial bytes of client traffic.
+   */
+  enabled?: boolean;
+}
+
 /**
  * TLS interception settings.
  */
@@ -308,6 +542,16 @@ export interface TLSSettings {
   enabled?: boolean;
 }
 
+/**
+ * TLS interception settings.
+ */
+export interface TLSSettingsParam {
+  /**
+   * Enable inspecting encrypted HTTP traffic.
+   */
+  enabled?: boolean;
+}
+
 /**
  * account settings.
  */
@@ -359,7 +603,7 @@ export interface ConfigurationUpdateParams {
   /**
    * Body param: account settings.
    */
-  settings?: GatewayConfigurationSettings;
+  settings?: GatewayConfigurationSettingsParam;
 }
 
 export interface ConfigurationEditParams {
@@ -371,7 +615,7 @@ export interface ConfigurationEditParams {
   /**
    * Body param: account settings.
    */
-  settings?: GatewayConfigurationSettings;
+  settings?: GatewayConfigurationSettingsParam;
 }
 
 export interface ConfigurationGetParams {

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

@@ -57,12 +57,11 @@ export class Lists extends APIResource {
     params: ListDeleteParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<ListDeleteResponse> {
-    const { account_id, body } = params;
+    const { account_id } = params;
     return (
-      this._client.delete(`/accounts/${account_id}/gateway/lists/${listId}`, {
-        body: body,
-        ...options,
-      }) as Core.APIPromise<{ result: ListDeleteResponse }>
+      this._client.delete(`/accounts/${account_id}/gateway/lists/${listId}`, options) as Core.APIPromise<{
+        result: ListDeleteResponse;
+      }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -103,6 +102,13 @@ export interface GatewayItem {
   value?: string;
 }
 
+export interface GatewayItemParam {
+  /**
+   * The value of the item in a list.
+   */
+  value?: string;
+}
+
 export interface GatewayList {
   /**
    * API Resource UUID tag.
@@ -191,7 +197,7 @@ export interface ListCreateParams {
   /**
    * Body param: The items in the list.
    */
-  items?: Array<GatewayItem>;
+  items?: Array<GatewayItemParam>;
 }
 
 export interface ListUpdateParams {
@@ -216,15 +222,7 @@ export interface ListListParams {
 }
 
 export interface ListDeleteParams {
-  /**
-   * Path param:
-   */
   account_id: string;
-
-  /**
-   * Body param:
-   */
-  body: unknown;
 }
 
 export interface ListEditParams {
@@ -236,7 +234,7 @@ export interface ListEditParams {
   /**
    * Body param: The items in the list.
    */
-  append?: Array<GatewayItem>;
+  append?: Array<GatewayItemParam>;
 
   /**
    * Body param: A list of the item values you want to remove.

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

@@ -55,12 +55,12 @@ export class Locations extends APIResource {
     params: LocationDeleteParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<LocationDeleteResponse> {
-    const { account_id, body } = params;
+    const { account_id } = params;
     return (
-      this._client.delete(`/accounts/${account_id}/gateway/locations/${locationId}`, {
-        body: body,
-        ...options,
-      }) as Core.APIPromise<{ result: LocationDeleteResponse }>
+      this._client.delete(
+        `/accounts/${account_id}/gateway/locations/${locationId}`,
+        options,
+      ) as Core.APIPromise<{ result: LocationDeleteResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -132,6 +132,13 @@ export interface LocationNetwork {
   network: string;
 }
 
+export interface LocationNetworkParam {
+  /**
+   * The IPv4 address or IPv4 CIDR. IPv4 CIDRs are limited to a maximum of /24.
+   */
+  network: string;
+}
+
 export type LocationDeleteResponse = unknown | string | null;
 
 export interface LocationCreateParams {
@@ -159,7 +166,7 @@ export interface LocationCreateParams {
    * Body param: A list of network ranges that requests from this location would
    * originate from.
    */
-  networks?: Array<LocationNetwork>;
+  networks?: Array<LocationNetworkParam>;
 }
 
 export interface LocationUpdateParams {
@@ -187,7 +194,7 @@ export interface LocationUpdateParams {
    * Body param: A list of network ranges that requests from this location would
    * originate from.
    */
-  networks?: Array<LocationNetwork>;
+  networks?: Array<LocationNetworkParam>;
 }
 
 export interface LocationListParams {
@@ -195,15 +202,7 @@ export interface LocationListParams {
 }
 
 export interface LocationDeleteParams {
-  /**
-   * Path param:
-   */
   account_id: string;
-
-  /**
-   * Body param:
-   */
-  body: unknown;
 }
 
 export interface LocationGetParams {

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

@@ -42,12 +42,12 @@ export class ProxyEndpoints extends APIResource {
     params: ProxyEndpointDeleteParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<ProxyEndpointDeleteResponse> {
-    const { account_id, body } = params;
+    const { account_id } = params;
     return (
-      this._client.delete(`/accounts/${account_id}/gateway/proxy_endpoints/${proxyEndpointId}`, {
-        body: body,
-        ...options,
-      }) as Core.APIPromise<{ result: ProxyEndpointDeleteResponse }>
+      this._client.delete(
+        `/accounts/${account_id}/gateway/proxy_endpoints/${proxyEndpointId}`,
+        options,
+      ) as Core.APIPromise<{ result: ProxyEndpointDeleteResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -94,6 +94,12 @@ export class ProxyEndpointsSinglePage extends SinglePage<ProxyEndpoint> {}
  */
 export type GatewayIPs = string;
 
+/**
+ * The IPv4 CIDR or IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /109. IPv4
+ * CIDRs are limited to a maximum of /25.
+ */
+export type GatewayIPsParam = string;
+
 export interface ProxyEndpoint {
   id?: string;
 
@@ -128,7 +134,7 @@ export interface ProxyEndpointCreateParams {
   /**
    * Body param: A list of CIDRs to restrict ingress connections.
    */
-  ips: Array<GatewayIPs>;
+  ips: Array<GatewayIPsParam>;
 
   /**
    * Body param: The name of the proxy endpoint.
@@ -141,15 +147,7 @@ export interface ProxyEndpointListParams {
 }
 
 export interface ProxyEndpointDeleteParams {
-  /**
-   * Path param:
-   */
   account_id: string;
-
-  /**
-   * Body param:
-   */
-  body: unknown;
 }
 
 export interface ProxyEndpointEditParams {
@@ -161,7 +159,7 @@ export interface ProxyEndpointEditParams {
   /**
    * Body param: A list of CIDRs to restrict ingress connections.
    */
-  ips?: Array<GatewayIPs>;
+  ips?: Array<GatewayIPsParam>;
 
   /**
    * Body param: The name of the proxy endpoint.