cloudflare 5.1.0 → 5.2.0

package/src/resources/logs/rayid.ts

@@ -30,7 +30,7 @@ export type RayIDGetResponse = string | unknown;
 
 export interface RayIDGetParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   zone_id: string;
 

package/src/resources/logs/received/fields.ts

@@ -27,7 +27,7 @@ export interface FieldGetResponse {
 
 export interface FieldGetParams {
   /**
-   * Identifier
+   * Identifier.
    */
   zone_id: string;
 }

package/src/resources/logs/received/received.ts

@@ -36,7 +36,7 @@ export type ReceivedGetResponse = string | unknown;
 
 export interface ReceivedGetParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   zone_id: string;
 

package/src/resources/magic-transit/cf-interconnects.ts

@@ -146,6 +146,12 @@ export namespace CfInterconnectUpdateResponse {
      */
     id?: string;
 
+    /**
+     * True if automatic stateful return routing should be enabled for a tunnel, false
+     * otherwise.
+     */
+    automatic_return_routing?: boolean;
+
     /**
      * The name of the interconnect. The name cannot share a name with other tunnels.
      */
@@ -225,6 +231,12 @@ export namespace CfInterconnectListResponse {
      */
     id?: string;
 
+    /**
+     * True if automatic stateful return routing should be enabled for a tunnel, false
+     * otherwise.
+     */
+    automatic_return_routing?: boolean;
+
     /**
      * The name of the interconnect. The name cannot share a name with other tunnels.
      */
@@ -306,6 +318,12 @@ export namespace CfInterconnectBulkUpdateResponse {
      */
     id?: string;
 
+    /**
+     * True if automatic stateful return routing should be enabled for a tunnel, false
+     * otherwise.
+     */
+    automatic_return_routing?: boolean;
+
     /**
      * The name of the interconnect. The name cannot share a name with other tunnels.
      */
@@ -385,6 +403,12 @@ export namespace CfInterconnectGetResponse {
      */
     id?: string;
 
+    /**
+     * True if automatic stateful return routing should be enabled for a tunnel, false
+     * otherwise.
+     */
+    automatic_return_routing?: boolean;
+
     /**
      * The name of the interconnect. The name cannot share a name with other tunnels.
      */
@@ -459,6 +483,12 @@ export interface CfInterconnectUpdateParams {
    */
   account_id: string;
 
+  /**
+   * Body param: True if automatic stateful return routing should be enabled for a
+   * tunnel, false otherwise.
+   */
+  automatic_return_routing?: boolean;
+
   /**
    * Body param: An optional description of the interconnect.
    */

package/src/resources/magic-transit/gre-tunnels.ts

@@ -229,6 +229,12 @@ export interface GRETunnelCreateResponse {
    */
   name: string;
 
+  /**
+   * True if automatic stateful return routing should be enabled for a tunnel, false
+   * otherwise.
+   */
+  automatic_return_routing?: boolean;
+
   bgp?: GRETunnelCreateResponse.BGP;
 
   bgp_status?: GRETunnelCreateResponse.BGPStatus;
@@ -421,6 +427,12 @@ export namespace GRETunnelUpdateResponse {
      */
     name: string;
 
+    /**
+     * True if automatic stateful return routing should be enabled for a tunnel, false
+     * otherwise.
+     */
+    automatic_return_routing?: boolean;
+
     bgp?: ModifiedGRETunnel.BGP;
 
     bgp_status?: ModifiedGRETunnel.BGPStatus;
@@ -612,6 +624,12 @@ export namespace GRETunnelListResponse {
      */
     name: string;
 
+    /**
+     * True if automatic stateful return routing should be enabled for a tunnel, false
+     * otherwise.
+     */
+    automatic_return_routing?: boolean;
+
     bgp?: GRETunnel.BGP;
 
     bgp_status?: GRETunnel.BGPStatus;
@@ -805,6 +823,12 @@ export namespace GRETunnelDeleteResponse {
      */
     name: string;
 
+    /**
+     * True if automatic stateful return routing should be enabled for a tunnel, false
+     * otherwise.
+     */
+    automatic_return_routing?: boolean;
+
     bgp?: DeletedGRETunnel.BGP;
 
     bgp_status?: DeletedGRETunnel.BGPStatus;
@@ -998,6 +1022,12 @@ export namespace GRETunnelBulkUpdateResponse {
      */
     name: string;
 
+    /**
+     * True if automatic stateful return routing should be enabled for a tunnel, false
+     * otherwise.
+     */
+    automatic_return_routing?: boolean;
+
     bgp?: ModifiedGRETunnel.BGP;
 
     bgp_status?: ModifiedGRETunnel.BGPStatus;
@@ -1189,6 +1219,12 @@ export namespace GRETunnelGetResponse {
      */
     name: string;
 
+    /**
+     * True if automatic stateful return routing should be enabled for a tunnel, false
+     * otherwise.
+     */
+    automatic_return_routing?: boolean;
+
     bgp?: GRETunnel.BGP;
 
     bgp_status?: GRETunnel.BGPStatus;
@@ -1376,6 +1412,12 @@ export interface GRETunnelCreateParams {
    */
   name: string;
 
+  /**
+   * Body param: True if automatic stateful return routing should be enabled for a
+   * tunnel, false otherwise.
+   */
+  automatic_return_routing?: boolean;
+
   /**
    * Body param:
    */
@@ -1537,6 +1579,12 @@ export interface GRETunnelUpdateParams {
    */
   name: string;
 
+  /**
+   * Body param: True if automatic stateful return routing should be enabled for a
+   * tunnel, false otherwise.
+   */
+  automatic_return_routing?: boolean;
+
   /**
    * Body param: An optional description of the GRE tunnel.
    */

package/src/resources/magic-transit/ipsec-tunnels.ts

@@ -279,6 +279,12 @@ export interface IPSECTunnelCreateResponse {
    */
   allow_null_cipher?: boolean;
 
+  /**
+   * True if automatic stateful return routing should be enabled for a tunnel, false
+   * otherwise.
+   */
+  automatic_return_routing?: boolean;
+
   bgp?: IPSECTunnelCreateResponse.BGP;
 
   bgp_status?: IPSECTunnelCreateResponse.BGPStatus;
@@ -288,6 +294,8 @@ export interface IPSECTunnelCreateResponse {
    */
   created_on?: string;
 
+  custom_remote_identities?: IPSECTunnelCreateResponse.CustomRemoteIdentities;
+
   /**
    * The IP address assigned to the customer side of the IPsec tunnel. Not required,
    * but must be set for proactive traceroutes to work.
@@ -380,6 +388,20 @@ export namespace IPSECTunnelCreateResponse {
     customer_speaker_port?: number;
   }
 
+  export interface CustomRemoteIdentities {
+    /**
+     * A custom IKE ID of type FQDN that may be used to identity the IPsec tunnel. The
+     * generated IKE IDs can still be used even if this custom value is specified.
+     *
+     * Must be of the form `<custom label>.<account ID>.custom.ipsec.cloudflare.com`.
+     *
+     * This custom ID does not need to be unique. Two IPsec tunnels may have the same
+     * custom fqdn_id. However, if another IPsec tunnel has the same value then the two
+     * tunnels cannot have the same cloudflare_endpoint.
+     */
+    fqdn_id?: string;
+  }
+
   export interface HealthCheck {
     /**
      * The direction of the flow of the healthcheck. Either unidirectional, where the
@@ -477,6 +499,12 @@ export namespace IPSECTunnelUpdateResponse {
      */
     allow_null_cipher?: boolean;
 
+    /**
+     * True if automatic stateful return routing should be enabled for a tunnel, false
+     * otherwise.
+     */
+    automatic_return_routing?: boolean;
+
     bgp?: ModifiedIPSECTunnel.BGP;
 
     bgp_status?: ModifiedIPSECTunnel.BGPStatus;
@@ -486,6 +514,8 @@ export namespace IPSECTunnelUpdateResponse {
      */
     created_on?: string;
 
+    custom_remote_identities?: ModifiedIPSECTunnel.CustomRemoteIdentities;
+
     /**
      * The IP address assigned to the customer side of the IPsec tunnel. Not required,
      * but must be set for proactive traceroutes to work.
@@ -578,6 +608,20 @@ export namespace IPSECTunnelUpdateResponse {
       customer_speaker_port?: number;
     }
 
+    export interface CustomRemoteIdentities {
+      /**
+       * A custom IKE ID of type FQDN that may be used to identity the IPsec tunnel. The
+       * generated IKE IDs can still be used even if this custom value is specified.
+       *
+       * Must be of the form `<custom label>.<account ID>.custom.ipsec.cloudflare.com`.
+       *
+       * This custom ID does not need to be unique. Two IPsec tunnels may have the same
+       * custom fqdn_id. However, if another IPsec tunnel has the same value then the two
+       * tunnels cannot have the same cloudflare_endpoint.
+       */
+      fqdn_id?: string;
+    }
+
     export interface HealthCheck {
       /**
        * The direction of the flow of the healthcheck. Either unidirectional, where the
@@ -674,6 +718,12 @@ export namespace IPSECTunnelListResponse {
      */
     allow_null_cipher?: boolean;
 
+    /**
+     * True if automatic stateful return routing should be enabled for a tunnel, false
+     * otherwise.
+     */
+    automatic_return_routing?: boolean;
+
     bgp?: IPSECTunnel.BGP;
 
     bgp_status?: IPSECTunnel.BGPStatus;
@@ -683,6 +733,8 @@ export namespace IPSECTunnelListResponse {
      */
     created_on?: string;
 
+    custom_remote_identities?: IPSECTunnel.CustomRemoteIdentities;
+
     /**
      * The IP address assigned to the customer side of the IPsec tunnel. Not required,
      * but must be set for proactive traceroutes to work.
@@ -775,6 +827,20 @@ export namespace IPSECTunnelListResponse {
       customer_speaker_port?: number;
     }
 
+    export interface CustomRemoteIdentities {
+      /**
+       * A custom IKE ID of type FQDN that may be used to identity the IPsec tunnel. The
+       * generated IKE IDs can still be used even if this custom value is specified.
+       *
+       * Must be of the form `<custom label>.<account ID>.custom.ipsec.cloudflare.com`.
+       *
+       * This custom ID does not need to be unique. Two IPsec tunnels may have the same
+       * custom fqdn_id. However, if another IPsec tunnel has the same value then the two
+       * tunnels cannot have the same cloudflare_endpoint.
+       */
+      fqdn_id?: string;
+    }
+
     export interface HealthCheck {
       /**
        * The direction of the flow of the healthcheck. Either unidirectional, where the
@@ -873,6 +939,12 @@ export namespace IPSECTunnelDeleteResponse {
      */
     allow_null_cipher?: boolean;
 
+    /**
+     * True if automatic stateful return routing should be enabled for a tunnel, false
+     * otherwise.
+     */
+    automatic_return_routing?: boolean;
+
     bgp?: DeletedIPSECTunnel.BGP;
 
     bgp_status?: DeletedIPSECTunnel.BGPStatus;
@@ -882,6 +954,8 @@ export namespace IPSECTunnelDeleteResponse {
      */
     created_on?: string;
 
+    custom_remote_identities?: DeletedIPSECTunnel.CustomRemoteIdentities;
+
     /**
      * The IP address assigned to the customer side of the IPsec tunnel. Not required,
      * but must be set for proactive traceroutes to work.
@@ -974,6 +1048,20 @@ export namespace IPSECTunnelDeleteResponse {
       customer_speaker_port?: number;
     }
 
+    export interface CustomRemoteIdentities {
+      /**
+       * A custom IKE ID of type FQDN that may be used to identity the IPsec tunnel. The
+       * generated IKE IDs can still be used even if this custom value is specified.
+       *
+       * Must be of the form `<custom label>.<account ID>.custom.ipsec.cloudflare.com`.
+       *
+       * This custom ID does not need to be unique. Two IPsec tunnels may have the same
+       * custom fqdn_id. However, if another IPsec tunnel has the same value then the two
+       * tunnels cannot have the same cloudflare_endpoint.
+       */
+      fqdn_id?: string;
+    }
+
     export interface HealthCheck {
       /**
        * The direction of the flow of the healthcheck. Either unidirectional, where the
@@ -1072,6 +1160,12 @@ export namespace IPSECTunnelBulkUpdateResponse {
      */
     allow_null_cipher?: boolean;
 
+    /**
+     * True if automatic stateful return routing should be enabled for a tunnel, false
+     * otherwise.
+     */
+    automatic_return_routing?: boolean;
+
     bgp?: ModifiedIPSECTunnel.BGP;
 
     bgp_status?: ModifiedIPSECTunnel.BGPStatus;
@@ -1081,6 +1175,8 @@ export namespace IPSECTunnelBulkUpdateResponse {
      */
     created_on?: string;
 
+    custom_remote_identities?: ModifiedIPSECTunnel.CustomRemoteIdentities;
+
     /**
      * The IP address assigned to the customer side of the IPsec tunnel. Not required,
      * but must be set for proactive traceroutes to work.
@@ -1173,6 +1269,20 @@ export namespace IPSECTunnelBulkUpdateResponse {
       customer_speaker_port?: number;
     }
 
+    export interface CustomRemoteIdentities {
+      /**
+       * A custom IKE ID of type FQDN that may be used to identity the IPsec tunnel. The
+       * generated IKE IDs can still be used even if this custom value is specified.
+       *
+       * Must be of the form `<custom label>.<account ID>.custom.ipsec.cloudflare.com`.
+       *
+       * This custom ID does not need to be unique. Two IPsec tunnels may have the same
+       * custom fqdn_id. However, if another IPsec tunnel has the same value then the two
+       * tunnels cannot have the same cloudflare_endpoint.
+       */
+      fqdn_id?: string;
+    }
+
     export interface HealthCheck {
       /**
        * The direction of the flow of the healthcheck. Either unidirectional, where the
@@ -1269,6 +1379,12 @@ export namespace IPSECTunnelGetResponse {
      */
     allow_null_cipher?: boolean;
 
+    /**
+     * True if automatic stateful return routing should be enabled for a tunnel, false
+     * otherwise.
+     */
+    automatic_return_routing?: boolean;
+
     bgp?: IPSECTunnel.BGP;
 
     bgp_status?: IPSECTunnel.BGPStatus;
@@ -1278,6 +1394,8 @@ export namespace IPSECTunnelGetResponse {
      */
     created_on?: string;
 
+    custom_remote_identities?: IPSECTunnel.CustomRemoteIdentities;
+
     /**
      * The IP address assigned to the customer side of the IPsec tunnel. Not required,
      * but must be set for proactive traceroutes to work.
@@ -1370,6 +1488,20 @@ export namespace IPSECTunnelGetResponse {
       customer_speaker_port?: number;
     }
 
+    export interface CustomRemoteIdentities {
+      /**
+       * A custom IKE ID of type FQDN that may be used to identity the IPsec tunnel. The
+       * generated IKE IDs can still be used even if this custom value is specified.
+       *
+       * Must be of the form `<custom label>.<account ID>.custom.ipsec.cloudflare.com`.
+       *
+       * This custom ID does not need to be unique. Two IPsec tunnels may have the same
+       * custom fqdn_id. However, if another IPsec tunnel has the same value then the two
+       * tunnels cannot have the same cloudflare_endpoint.
+       */
+      fqdn_id?: string;
+    }
+
     export interface HealthCheck {
       /**
        * The direction of the flow of the healthcheck. Either unidirectional, where the
@@ -1473,6 +1605,12 @@ export interface IPSECTunnelCreateParams {
    */
   name: string;
 
+  /**
+   * Body param: True if automatic stateful return routing should be enabled for a
+   * tunnel, false otherwise.
+   */
+  automatic_return_routing?: boolean;
+
   /**
    * Body param:
    */
@@ -1634,6 +1772,12 @@ export interface IPSECTunnelUpdateParams {
    */
   name: string;
 
+  /**
+   * Body param: True if automatic stateful return routing should be enabled for a
+   * tunnel, false otherwise.
+   */
+  automatic_return_routing?: boolean;
+
   /**
    * Body param:
    */

package/src/resources/magic-transit/pcaps/download.ts

@@ -32,7 +32,7 @@ export class Download extends APIResource {
 
 export interface DownloadGetParams {
   /**
-   * Identifier
+   * Identifier.
    */
   account_id: string;
 }

package/src/resources/magic-transit/pcaps/ownership.ts

@@ -131,7 +131,7 @@ export interface Ownership {
 
 export interface OwnershipCreateParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   account_id: string;
 
@@ -144,21 +144,21 @@ export interface OwnershipCreateParams {
 
 export interface OwnershipDeleteParams {
   /**
-   * Identifier
+   * Identifier.
    */
   account_id: string;
 }
 
 export interface OwnershipGetParams {
   /**
-   * Identifier
+   * Identifier.
    */
   account_id: string;
 }
 
 export interface OwnershipValidateParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   account_id: string;
 

package/src/resources/magic-transit/pcaps/pcaps.ts

@@ -90,7 +90,7 @@ export class PCAPs extends APIResource {
   }
 
   /**
-   * Stop full PCAP
+   * Stop full PCAP.
    *
    * @example
    * ```ts
@@ -485,7 +485,7 @@ export type PCAPCreateParams =
 export declare namespace PCAPCreateParams {
   export interface MagicVisibilityPCAPsPCAPsRequestSimple {
     /**
-     * Path param: Identifier
+     * Path param: Identifier.
      */
     account_id: string;
 
@@ -526,7 +526,7 @@ export declare namespace PCAPCreateParams {
 
   export interface MagicVisibilityPCAPsPCAPsRequestFull {
     /**
-     * Path param: Identifier
+     * Path param: Identifier.
      */
     account_id: string;
 
@@ -580,21 +580,21 @@ export declare namespace PCAPCreateParams {
 
 export interface PCAPListParams {
   /**
-   * Identifier
+   * Identifier.
    */
   account_id: string;
 }
 
 export interface PCAPGetParams {
   /**
-   * Identifier
+   * Identifier.
    */
   account_id: string;
 }
 
 export interface PCAPStopParams {
   /**
-   * Identifier
+   * Identifier.
    */
   account_id: string;
 }

package/src/resources/page-rules.ts

@@ -12,8 +12,16 @@ export class PageRules extends APIResource {
    * ```ts
    * const pageRule = await client.pageRules.create({
    *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *   actions: [{}],
-   *   targets: [{}],
+   *   actions: [{ id: 'browser_check' }],
+   *   targets: [
+   *     {
+   *       constraint: {
+   *         operator: 'matches',
+   *         value: '*example.com/images/*',
+   *       },
+   *       target: 'url',
+   *     },
+   *   ],
    * });
    * ```
    */
@@ -36,8 +44,16 @@ export class PageRules extends APIResource {
    *   '023e105f4ecef8ad9ca31a8372d0c353',
    *   {
    *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *     actions: [{}],
-   *     targets: [{}],
+   *     actions: [{ id: 'browser_check' }],
+   *     targets: [
+   *       {
+   *         constraint: {
+   *           operator: 'matches',
+   *           value: '*example.com/images/*',
+   *         },
+   *         target: 'url',
+   *       },
+   *     ],
    *   },
    * );
    * ```

package/src/resources/page-shield/connections.ts

@@ -112,7 +112,7 @@ export interface ConnectionListParams {
   exclude_urls?: string;
 
   /**
-   * Query param: Export the list of connections as a file.
+   * Query param: Export the list of connections as a file, limited to 50000 entries.
    */
   export?: 'csv';
 

package/src/resources/page-shield/cookies.ts

@@ -140,7 +140,7 @@ export interface CookieListParams {
   domain?: string;
 
   /**
-   * Query param: Export the list of cookies as a file.
+   * Query param: Export the list of cookies as a file, limited to 50000 entries.
    */
   export?: 'csv';
 

package/src/resources/page-shield/scripts.ts

@@ -276,7 +276,7 @@ export interface ScriptListParams {
   exclude_urls?: string;
 
   /**
-   * Query param: Export the list of scripts as a file.
+   * Query param: Export the list of scripts as a file, limited to 50000 entries.
    */
   export?: 'csv';
 

package/src/resources/radar/ai/inference/summary.ts

@@ -8,11 +8,7 @@ export class Summary extends APIResource {
   /**
    * Retrieves the distribution of unique accounts by model.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.ai.inference.summary.model();
-   * ```
+   * @deprecated
    */
   model(query?: SummaryModelParams, options?: Core.RequestOptions): Core.APIPromise<SummaryModelResponse>;
   model(options?: Core.RequestOptions): Core.APIPromise<SummaryModelResponse>;
@@ -33,11 +29,7 @@ export class Summary extends APIResource {
   /**
    * Retrieves the distribution of unique accounts by task.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.ai.inference.summary.task();
-   * ```
+   * @deprecated
    */
   task(query?: SummaryTaskParams, options?: Core.RequestOptions): Core.APIPromise<SummaryTaskResponse>;
   task(options?: Core.RequestOptions): Core.APIPromise<SummaryTaskResponse>;

package/src/resources/radar/ai/inference/timeseries-groups/summary.ts

@@ -8,11 +8,7 @@ export class Summary extends APIResource {
   /**
    * Retrieves the distribution of unique accounts by model over time.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.ai.inference.timeseriesGroups.summary.model();
-   * ```
+   * @deprecated
    */
   model(query?: SummaryModelParams, options?: Core.RequestOptions): Core.APIPromise<SummaryModelResponse>;
   model(options?: Core.RequestOptions): Core.APIPromise<SummaryModelResponse>;
@@ -34,11 +30,7 @@ export class Summary extends APIResource {
   /**
    * Retrieves the distribution of unique accounts by task over time.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.ai.inference.timeseriesGroups.summary.task();
-   * ```
+   * @deprecated
    */
   task(query?: SummaryTaskParams, options?: Core.RequestOptions): Core.APIPromise<SummaryTaskResponse>;
   task(options?: Core.RequestOptions): Core.APIPromise<SummaryTaskResponse>;