cloudflare 7.2.0 → 7.3.0

package/src/resources/cache/cache.ts

@@ -78,72 +78,169 @@ export class BaseCache extends APIResource {
   static override readonly _key: readonly ['cache'] = Object.freeze(['cache'] as const);
 
   /**
-   * ### Purge All Cached Content
+   * Marks cached content as stale in every Cloudflare data center and cache tier,
+   * including Cache Reserve. The content stays in cache. The next request for it
+   * makes Cloudflare revalidate it with your origin, using the `ETag` and
+   * `Last-Modified` values it was cached with:
    *
-   * Removes ALL files from Cloudflare's cache. All tiers can purge everything.
+   * - If your origin answers `304 Not Modified`, Cloudflare serves the cached copy
+   *   without downloading it again, and `CF-Cache-Status` is `REVALIDATED`.
+   * - If your origin sends a full response, Cloudflare serves and caches the new
+   *   content, and `CF-Cache-Status` is `EXPIRED`.
    *
-   * ```
-   * {"purge_everything": true}
-   * ```
+   * With Tiered Cache, each tier revalidates with the tier above it, so a visitor
+   * can see `EXPIRED` even when your origin answered `304`.
    *
-   * ### Purge Cached Content by URL
+   * Until content is revalidated, your `stale-while-revalidate` and `stale-if-error`
+   * directives still apply, counted from the time you invalidated it. For example,
+   * if your origin fails during revalidation, Cloudflare can keep serving the stale
+   * copy for the `stale-if-error` window.
    *
-   * Granularly removes one or more files from Cloudflare's cache by specifying URLs.
-   * All tiers can purge by URL.
+   * ### Invalidate or purge?
    *
-   * To purge files with custom cache keys, include the headers used to compute the
-   * cache key as in the example. If you have a device type or geo in your cache key,
-   * you will need to include the CF-Device-Type or CF-IPCountry headers. If you have
-   * lang in your cache key, you will need to include the Accept-Language header.
+   * - **Invalidate** when content may not have changed, for example after a deploy.
+   *   Unchanged content costs your origin a `304` instead of a full response. That
+   *   saving needs an origin that sends `ETag` or `Last-Modified` and answers
+   *   conditional requests. Otherwise, every revalidation downloads the full
+   *   response.
+   * - **Purge**, with `POST /zones/{zone_id}/purge_cache`, when content must not be
+   *   served again, for example content you removed for legal or security reasons.
    *
-   * **NB:** When including the Origin header, be sure to include the **scheme** and
-   * **hostname**. The port number can be omitted if it is the default port (80 for
-   * http, 443 for https), but must be included otherwise.
+   * Invalidating takes the same request bodies as purging, needs the same
+   * permission, and counts against the same rate limits. After a broad invalidation,
+   * such as `purge_everything`, expect more conditional requests to your origin
+   * while visitors request the invalidated content again.
    *
-   * Single file purge example with files:
+   * ### Choose what to invalidate
    *
-   * ```
-   * {"files": ["http://www.example.com/css/styles.css", "http://www.example.com/js/index.js"]}
-   * ```
+   * Send one of these fields in the request body:
    *
-   * Single file purge example with url and header pairs:
+   * - `files`: specific URLs. If your cache key includes request headers, send each
+   *   URL with the header values it was cached with.
+   * - `tags`: all content whose `Cache-Tag` response header contains one of the
+   *   tags.
+   * - `hosts`: all content cached for the hostnames.
+   * - `prefixes`: all content whose URL starts with one of the prefixes.
+   * - `purge_everything`: all cached content in the zone.
    *
-   * ```
-   * {"files": [{"url": "http://www.example.com/cat_picture.jpg", "headers": {"CF-IPCountry": "US", "CF-Device-Type": "desktop", "Accept-Language": "zh-CN"}}, {"url": "http://www.example.com/dog_picture.jpg", "headers": {"CF-IPCountry": "EU", "CF-Device-Type": "mobile", "Accept-Language": "en-US"}}]}
-   * ```
+   * ### Check the result
    *
-   * ### Purge Cached Content by Tag, Host or Prefix
+   * A `200` response with `success: true` means Cloudflare accepted the request. To
+   * check, request an invalidated URL and confirm that the `CF-Cache-Status`
+   * response header is `REVALIDATED` or `EXPIRED`.
    *
-   * Granularly removes one or more files from Cloudflare's cache either by
-   * specifying the host, the associated Cache-Tag, or a Prefix.
+   * ### Availability and limits
    *
-   * Flex purge with tags:
+   * Rate limits and the number of items you can send in one request depend on your
+   * plan. See
+   * [Purge cache: availability and limits](https://developers.cloudflare.com/cache/how-to/purge-cache/#availability-and-limits).
    *
+   * @example
+   * ```ts
+   * const response = await client.cache.invalidate({
+   *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *   tags: ['product-1234', 'homepage'],
+   * });
    * ```
-   * {"tags": ["a-cache-tag", "another-cache-tag"]}
-   * ```
+   */
+  invalidate(
+    params: CacheInvalidateParams,
+    options?: RequestOptions,
+  ): APIPromise<CacheInvalidateResponse | null> {
+    const { zone_id, ...body } = params;
+    return (
+      this._client.post(path`/zones/${zone_id}/invalidate_cache`, { body, ...options }) as APIPromise<{
+        result: CacheInvalidateResponse | null;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Marks cached content as stale for one environment of the zone. Content cached
+   * for the zone's other environments, including production, is not affected.
+   * Otherwise this works like `POST /zones/{zone_id}/invalidate_cache`: the next
+   * request for invalidated content makes Cloudflare revalidate it with your origin,
+   * and the request body takes the same fields.
    *
-   * Flex purge with hosts:
+   * Environments are part of
+   * [Version Management](https://developers.cloudflare.com/version-management/). To
+   * delete the content instead, use
+   * `POST /zones/{zone_id}/environments/{environment_id}/purge_cache`.
    *
-   * ```
-   * {"hosts": ["www.example.com", "images.example.com"]}
-   * ```
+   * Invalidating by URL (`files`) does not work for environments that select
+   * requests by IP address, country, ASN, or threat score, and fails with error
+   * `1136`. Use `tags`, `hosts`, `prefixes`, or `purge_everything` for those
+   * environments.
    *
-   * Flex purge with prefixes:
+   * ### Availability and limits
    *
+   * Rate limits and the number of items you can send in one request depend on your
+   * plan. See
+   * [Purge cache: availability and limits](https://developers.cloudflare.com/cache/how-to/purge-cache/#availability-and-limits).
+   *
+   * @example
+   * ```ts
+   * const response = await client.cache.invalidateEnvironment(
+   *   '023e105f4ecef8ad9ca31a8372d0c353',
+   *   {
+   *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *     tags: ['product-1234', 'homepage'],
+   *   },
+   * );
    * ```
-   * {"prefixes": ["www.example.com/foo", "images.example.com/bar/baz"]}
-   * ```
+   */
+  invalidateEnvironment(
+    environmentID: string,
+    params: CacheInvalidateEnvironmentParams,
+    options?: RequestOptions,
+  ): APIPromise<CacheInvalidateEnvironmentResponse | null> {
+    const { zone_id, ...body } = params;
+    return (
+      this._client.post(path`/zones/${zone_id}/environments/${environmentID}/invalidate_cache`, {
+        body,
+        ...options,
+      }) as APIPromise<{ result: CacheInvalidateEnvironmentResponse | null }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Deletes cached content in every Cloudflare data center and cache tier, including
+   * Cache Reserve. The next request for purged content is a cache `MISS`: Cloudflare
+   * fetches the full response from your origin and caches it again. Cloudflare does
+   * not serve purged content from cache again, even if your origin is unavailable.
+   *
+   * To keep content cached and have Cloudflare revalidate it with your origin
+   * instead, use `POST /zones/{zone_id}/invalidate_cache`.
+   *
+   * ### Choose what to purge
+   *
+   * Send one of these fields in the request body:
+   *
+   * - `files`: specific URLs. If your cache key includes request headers, send each
+   *   URL with the header values it was cached with.
+   * - `tags`: all content whose `Cache-Tag` response header contains one of the
+   *   tags.
+   * - `hosts`: all content cached for the hostnames.
+   * - `prefixes`: all content whose URL starts with one of the prefixes.
+   * - `purge_everything`: all cached content in the zone.
+   *
+   * ### Check the result
+   *
+   * A `200` response with `success: true` means Cloudflare accepted the request. It
+   * does not confirm that any content was cached or removed. To check, request a
+   * purged URL and confirm that the `CF-Cache-Status` response header is `MISS`.
    *
    * ### Availability and limits
    *
-   * Please refer to
-   * [purge cache availability and limits documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/#availability-and-limits).
+   * Rate limits and the number of items you can send in one request depend on your
+   * plan. See
+   * [Purge cache: availability and limits](https://developers.cloudflare.com/cache/how-to/purge-cache/#availability-and-limits).
    *
    * @example
    * ```ts
    * const response = await client.cache.purge({
    *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *   tags: ['product-1234', 'homepage'],
    * });
    * ```
    */
@@ -157,20 +254,34 @@ export class BaseCache extends APIResource {
   }
 
   /**
-   * Purge cached content scoped to a specific environment. Supports the same purge
-   * types as the zone-level endpoint (purge everything, by URL, by tag, host, or
-   * prefix).
+   * Deletes cached content for one environment of the zone. Content cached for the
+   * zone's other environments, including production, is not affected. Otherwise this
+   * works like `POST /zones/{zone_id}/purge_cache`: the next request for purged
+   * content is a cache `MISS`, and the request body takes the same fields.
+   *
+   * Environments are part of
+   * [Version Management](https://developers.cloudflare.com/version-management/). To
+   * keep content cached and have Cloudflare revalidate it instead, use
+   * `POST /zones/{zone_id}/environments/{environment_id}/invalidate_cache`.
+   *
+   * Purging by URL (`files`) does not work for environments that select requests by
+   * IP address, country, ASN, or threat score, and fails with error `1136`. Use
+   * `tags`, `hosts`, `prefixes`, or `purge_everything` for those environments.
    *
    * ### Availability and limits
    *
-   * Please refer to
-   * [purge cache availability and limits documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/#availability-and-limits).
+   * Rate limits and the number of items you can send in one request depend on your
+   * plan. See
+   * [Purge cache: availability and limits](https://developers.cloudflare.com/cache/how-to/purge-cache/#availability-and-limits).
    *
    * @example
    * ```ts
    * const response = await client.cache.purgeEnvironment(
    *   '023e105f4ecef8ad9ca31a8372d0c353',
-   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   *   {
+   *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *     tags: ['product-1234', 'homepage'],
+   *   },
    * );
    * ```
    */
@@ -201,6 +312,14 @@ export class Cache extends BaseCache {
   );
 }
 
+export interface CacheInvalidateResponse {
+  id: string;
+}
+
+export interface CacheInvalidateEnvironmentResponse {
+  id: string;
+}
+
 export interface CachePurgeResponse {
   id: string;
 }
@@ -209,6 +328,242 @@ export interface CachePurgeEnvironmentResponse {
   id: string;
 }
 
+export type CacheInvalidateParams =
+  | CacheInvalidateParams.CachePurgeFlexPurgeByTags
+  | CacheInvalidateParams.CachePurgeFlexPurgeByHostnames
+  | CacheInvalidateParams.CachePurgeFlexPurgeByPrefixes
+  | CacheInvalidateParams.CachePurgeEverything
+  | CacheInvalidateParams.CachePurgeSingleFile
+  | CacheInvalidateParams.CachePurgeSingleFileWithURLAndHeaders;
+
+export declare namespace CacheInvalidateParams {
+  export interface CachePurgeFlexPurgeByTags {
+    /**
+     * Path param: The zone ID.
+     */
+    zone_id: string;
+
+    /**
+     * Body param: Cache tags. Targets all content whose `Cache-Tag` response header
+     * contains at least one of these tags. See
+     * [Purge cache by cache-tags](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-tags/).
+     */
+    tags?: Array<string>;
+  }
+
+  export interface CachePurgeFlexPurgeByHostnames {
+    /**
+     * Path param: The zone ID.
+     */
+    zone_id: string;
+
+    /**
+     * Body param: Hostnames, such as `www.example.com`. Targets all content cached for
+     * these hostnames. See
+     * [Purge cache by hostname](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-hostname/).
+     */
+    hosts?: Array<string>;
+  }
+
+  export interface CachePurgeFlexPurgeByPrefixes {
+    /**
+     * Path param: The zone ID.
+     */
+    zone_id: string;
+
+    /**
+     * Body param: URL prefixes, each a hostname followed by a path, such as
+     * `www.example.com/blog/`. Targets all content whose URL starts with one of these
+     * prefixes. Do not include a scheme, query string, or fragment. See
+     * [Purge cache by prefix](https://developers.cloudflare.com/cache/how-to/purge-cache/purge_by_prefix/).
+     */
+    prefixes?: Array<string>;
+  }
+
+  export interface CachePurgeEverything {
+    /**
+     * Path param: The zone ID.
+     */
+    zone_id: string;
+
+    /**
+     * Body param: Set to `true` to target all cached content in the zone, or in the
+     * environment for the environment endpoints. Must be the only field in the
+     * request. See
+     * [Purge everything](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-everything/).
+     */
+    purge_everything?: boolean;
+  }
+
+  export interface CachePurgeSingleFile {
+    /**
+     * Path param: The zone ID.
+     */
+    zone_id: string;
+
+    /**
+     * Body param: Full URLs, such as `https://www.example.com/css/styles.css`. Targets
+     * the content cached for each URL. If your cache key includes request headers,
+     * send objects with `url` and `headers` instead. See
+     * [Purge by single-file](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-single-file/).
+     */
+    files?: Array<string>;
+  }
+
+  export interface CachePurgeSingleFileWithURLAndHeaders {
+    /**
+     * Path param: The zone ID.
+     */
+    zone_id: string;
+
+    /**
+     * Body param: URLs with the request headers your cache key uses. Use this form
+     * when your cache key includes request headers, or the visitor's device type,
+     * country, or language: send the header values each URL was cached with, such as
+     * `CF-Device-Type`, `CF-IPCountry`, or `Accept-Language`.
+     *
+     * When you send the `Origin` header, include the scheme and hostname. Include the
+     * port unless it is the default for the scheme: 80 for `http`, 443 for `https`.
+     *
+     * See
+     * [Purge by single-file](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-single-file/).
+     */
+    files?: Array<CachePurgeSingleFileWithURLAndHeaders.File>;
+  }
+
+  export namespace CachePurgeSingleFileWithURLAndHeaders {
+    export interface File {
+      /**
+       * Request headers and the values the content was cached with.
+       */
+      headers?: { [key: string]: string };
+
+      /**
+       * Full URL of the content.
+       */
+      url?: string;
+    }
+  }
+}
+
+export type CacheInvalidateEnvironmentParams =
+  | CacheInvalidateEnvironmentParams.CachePurgeFlexPurgeByTags
+  | CacheInvalidateEnvironmentParams.CachePurgeFlexPurgeByHostnames
+  | CacheInvalidateEnvironmentParams.CachePurgeFlexPurgeByPrefixes
+  | CacheInvalidateEnvironmentParams.CachePurgeEverything
+  | CacheInvalidateEnvironmentParams.CachePurgeSingleFile
+  | CacheInvalidateEnvironmentParams.CachePurgeSingleFileWithURLAndHeaders;
+
+export declare namespace CacheInvalidateEnvironmentParams {
+  export interface CachePurgeFlexPurgeByTags {
+    /**
+     * Path param: The zone ID.
+     */
+    zone_id: string;
+
+    /**
+     * Body param: Cache tags. Targets all content whose `Cache-Tag` response header
+     * contains at least one of these tags. See
+     * [Purge cache by cache-tags](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-tags/).
+     */
+    tags?: Array<string>;
+  }
+
+  export interface CachePurgeFlexPurgeByHostnames {
+    /**
+     * Path param: The zone ID.
+     */
+    zone_id: string;
+
+    /**
+     * Body param: Hostnames, such as `www.example.com`. Targets all content cached for
+     * these hostnames. See
+     * [Purge cache by hostname](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-hostname/).
+     */
+    hosts?: Array<string>;
+  }
+
+  export interface CachePurgeFlexPurgeByPrefixes {
+    /**
+     * Path param: The zone ID.
+     */
+    zone_id: string;
+
+    /**
+     * Body param: URL prefixes, each a hostname followed by a path, such as
+     * `www.example.com/blog/`. Targets all content whose URL starts with one of these
+     * prefixes. Do not include a scheme, query string, or fragment. See
+     * [Purge cache by prefix](https://developers.cloudflare.com/cache/how-to/purge-cache/purge_by_prefix/).
+     */
+    prefixes?: Array<string>;
+  }
+
+  export interface CachePurgeEverything {
+    /**
+     * Path param: The zone ID.
+     */
+    zone_id: string;
+
+    /**
+     * Body param: Set to `true` to target all cached content in the zone, or in the
+     * environment for the environment endpoints. Must be the only field in the
+     * request. See
+     * [Purge everything](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-everything/).
+     */
+    purge_everything?: boolean;
+  }
+
+  export interface CachePurgeSingleFile {
+    /**
+     * Path param: The zone ID.
+     */
+    zone_id: string;
+
+    /**
+     * Body param: Full URLs, such as `https://www.example.com/css/styles.css`. Targets
+     * the content cached for each URL. If your cache key includes request headers,
+     * send objects with `url` and `headers` instead. See
+     * [Purge by single-file](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-single-file/).
+     */
+    files?: Array<string>;
+  }
+
+  export interface CachePurgeSingleFileWithURLAndHeaders {
+    /**
+     * Path param: The zone ID.
+     */
+    zone_id: string;
+
+    /**
+     * Body param: URLs with the request headers your cache key uses. Use this form
+     * when your cache key includes request headers, or the visitor's device type,
+     * country, or language: send the header values each URL was cached with, such as
+     * `CF-Device-Type`, `CF-IPCountry`, or `Accept-Language`.
+     *
+     * When you send the `Origin` header, include the scheme and hostname. Include the
+     * port unless it is the default for the scheme: 80 for `http`, 443 for `https`.
+     *
+     * See
+     * [Purge by single-file](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-single-file/).
+     */
+    files?: Array<CachePurgeSingleFileWithURLAndHeaders.File>;
+  }
+
+  export namespace CachePurgeSingleFileWithURLAndHeaders {
+    export interface File {
+      /**
+       * Request headers and the values the content was cached with.
+       */
+      headers?: { [key: string]: string };
+
+      /**
+       * Full URL of the content.
+       */
+      url?: string;
+    }
+  }
+}
+
 export type CachePurgeParams =
   | CachePurgeParams.CachePurgeFlexPurgeByTags
   | CachePurgeParams.CachePurgeFlexPurgeByHostnames
@@ -220,88 +575,108 @@ export type CachePurgeParams =
 export declare namespace CachePurgeParams {
   export interface CachePurgeFlexPurgeByTags {
     /**
-     * Path param
+     * Path param: The zone ID.
      */
     zone_id: string;
 
     /**
-     * Body param: For more information on cache tags and purging by tags, please refer
-     * to
-     * [purge by cache-tags documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-tags/).
+     * Body param: Cache tags. Targets all content whose `Cache-Tag` response header
+     * contains at least one of these tags. See
+     * [Purge cache by cache-tags](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-tags/).
      */
     tags?: Array<string>;
   }
 
   export interface CachePurgeFlexPurgeByHostnames {
     /**
-     * Path param
+     * Path param: The zone ID.
      */
     zone_id: string;
 
     /**
-     * Body param: For more information purging by hostnames, please refer to
-     * [purge by hostname documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-hostname/).
+     * Body param: Hostnames, such as `www.example.com`. Targets all content cached for
+     * these hostnames. See
+     * [Purge cache by hostname](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-hostname/).
      */
     hosts?: Array<string>;
   }
 
   export interface CachePurgeFlexPurgeByPrefixes {
     /**
-     * Path param
+     * Path param: The zone ID.
      */
     zone_id: string;
 
     /**
-     * Body param: For more information on purging by prefixes, please refer to
-     * [purge by prefix documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge_by_prefix/).
+     * Body param: URL prefixes, each a hostname followed by a path, such as
+     * `www.example.com/blog/`. Targets all content whose URL starts with one of these
+     * prefixes. Do not include a scheme, query string, or fragment. See
+     * [Purge cache by prefix](https://developers.cloudflare.com/cache/how-to/purge-cache/purge_by_prefix/).
      */
     prefixes?: Array<string>;
   }
 
   export interface CachePurgeEverything {
     /**
-     * Path param
+     * Path param: The zone ID.
      */
     zone_id: string;
 
     /**
-     * Body param: For more information, please refer to
-     * [purge everything documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-everything/).
+     * Body param: Set to `true` to target all cached content in the zone, or in the
+     * environment for the environment endpoints. Must be the only field in the
+     * request. See
+     * [Purge everything](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-everything/).
      */
     purge_everything?: boolean;
   }
 
   export interface CachePurgeSingleFile {
     /**
-     * Path param
+     * Path param: The zone ID.
      */
     zone_id: string;
 
     /**
-     * Body param: For more information on purging files, please refer to
-     * [purge by single-file documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-single-file/).
+     * Body param: Full URLs, such as `https://www.example.com/css/styles.css`. Targets
+     * the content cached for each URL. If your cache key includes request headers,
+     * send objects with `url` and `headers` instead. See
+     * [Purge by single-file](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-single-file/).
      */
     files?: Array<string>;
   }
 
   export interface CachePurgeSingleFileWithURLAndHeaders {
     /**
-     * Path param
+     * Path param: The zone ID.
      */
     zone_id: string;
 
     /**
-     * Body param: For more information on purging files with URL and headers, please
-     * refer to
-     * [purge by single-file documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-single-file/).
+     * Body param: URLs with the request headers your cache key uses. Use this form
+     * when your cache key includes request headers, or the visitor's device type,
+     * country, or language: send the header values each URL was cached with, such as
+     * `CF-Device-Type`, `CF-IPCountry`, or `Accept-Language`.
+     *
+     * When you send the `Origin` header, include the scheme and hostname. Include the
+     * port unless it is the default for the scheme: 80 for `http`, 443 for `https`.
+     *
+     * See
+     * [Purge by single-file](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-single-file/).
      */
     files?: Array<CachePurgeSingleFileWithURLAndHeaders.File>;
   }
 
   export namespace CachePurgeSingleFileWithURLAndHeaders {
     export interface File {
+      /**
+       * Request headers and the values the content was cached with.
+       */
       headers?: { [key: string]: string };
 
+      /**
+       * Full URL of the content.
+       */
       url?: string;
     }
   }
@@ -318,88 +693,108 @@ export type CachePurgeEnvironmentParams =
 export declare namespace CachePurgeEnvironmentParams {
   export interface CachePurgeFlexPurgeByTags {
     /**
-     * Path param
+     * Path param: The zone ID.
      */
     zone_id: string;
 
     /**
-     * Body param: For more information on cache tags and purging by tags, please refer
-     * to
-     * [purge by cache-tags documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-tags/).
+     * Body param: Cache tags. Targets all content whose `Cache-Tag` response header
+     * contains at least one of these tags. See
+     * [Purge cache by cache-tags](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-tags/).
      */
     tags?: Array<string>;
   }
 
   export interface CachePurgeFlexPurgeByHostnames {
     /**
-     * Path param
+     * Path param: The zone ID.
      */
     zone_id: string;
 
     /**
-     * Body param: For more information purging by hostnames, please refer to
-     * [purge by hostname documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-hostname/).
+     * Body param: Hostnames, such as `www.example.com`. Targets all content cached for
+     * these hostnames. See
+     * [Purge cache by hostname](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-hostname/).
      */
     hosts?: Array<string>;
   }
 
   export interface CachePurgeFlexPurgeByPrefixes {
     /**
-     * Path param
+     * Path param: The zone ID.
      */
     zone_id: string;
 
     /**
-     * Body param: For more information on purging by prefixes, please refer to
-     * [purge by prefix documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge_by_prefix/).
+     * Body param: URL prefixes, each a hostname followed by a path, such as
+     * `www.example.com/blog/`. Targets all content whose URL starts with one of these
+     * prefixes. Do not include a scheme, query string, or fragment. See
+     * [Purge cache by prefix](https://developers.cloudflare.com/cache/how-to/purge-cache/purge_by_prefix/).
      */
     prefixes?: Array<string>;
   }
 
   export interface CachePurgeEverything {
     /**
-     * Path param
+     * Path param: The zone ID.
      */
     zone_id: string;
 
     /**
-     * Body param: For more information, please refer to
-     * [purge everything documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-everything/).
+     * Body param: Set to `true` to target all cached content in the zone, or in the
+     * environment for the environment endpoints. Must be the only field in the
+     * request. See
+     * [Purge everything](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-everything/).
      */
     purge_everything?: boolean;
   }
 
   export interface CachePurgeSingleFile {
     /**
-     * Path param
+     * Path param: The zone ID.
      */
     zone_id: string;
 
     /**
-     * Body param: For more information on purging files, please refer to
-     * [purge by single-file documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-single-file/).
+     * Body param: Full URLs, such as `https://www.example.com/css/styles.css`. Targets
+     * the content cached for each URL. If your cache key includes request headers,
+     * send objects with `url` and `headers` instead. See
+     * [Purge by single-file](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-single-file/).
      */
     files?: Array<string>;
   }
 
   export interface CachePurgeSingleFileWithURLAndHeaders {
     /**
-     * Path param
+     * Path param: The zone ID.
      */
     zone_id: string;
 
     /**
-     * Body param: For more information on purging files with URL and headers, please
-     * refer to
-     * [purge by single-file documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-single-file/).
+     * Body param: URLs with the request headers your cache key uses. Use this form
+     * when your cache key includes request headers, or the visitor's device type,
+     * country, or language: send the header values each URL was cached with, such as
+     * `CF-Device-Type`, `CF-IPCountry`, or `Accept-Language`.
+     *
+     * When you send the `Origin` header, include the scheme and hostname. Include the
+     * port unless it is the default for the scheme: 80 for `http`, 443 for `https`.
+     *
+     * See
+     * [Purge by single-file](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-single-file/).
      */
     files?: Array<CachePurgeSingleFileWithURLAndHeaders.File>;
   }
 
   export namespace CachePurgeSingleFileWithURLAndHeaders {
     export interface File {
+      /**
+       * Request headers and the values the content was cached with.
+       */
       headers?: { [key: string]: string };
 
+      /**
+       * Full URL of the content.
+       */
       url?: string;
     }
   }
@@ -418,8 +813,12 @@ Cache.BaseOriginCloudRegions = BaseOriginCloudRegions;
 
 export declare namespace Cache {
   export {
+    type CacheInvalidateResponse as CacheInvalidateResponse,
+    type CacheInvalidateEnvironmentResponse as CacheInvalidateEnvironmentResponse,
     type CachePurgeResponse as CachePurgeResponse,
     type CachePurgeEnvironmentResponse as CachePurgeEnvironmentResponse,
+    type CacheInvalidateParams as CacheInvalidateParams,
+    type CacheInvalidateEnvironmentParams as CacheInvalidateEnvironmentParams,
     type CachePurgeParams as CachePurgeParams,
     type CachePurgeEnvironmentParams as CachePurgeEnvironmentParams,
   };