cloudflare 4.4.1 → 5.0.0

package/src/resources/browser-rendering/links.ts

@@ -147,7 +147,7 @@ export interface LinkCreateParams {
   /**
    * Body param:
    */
-  setExtraHTTPHeaders?: Record<string, string>;
+  setExtraHTTPHeaders?: { [key: string]: string };
 
   /**
    * Body param:

package/src/resources/browser-rendering/markdown.ts

@@ -154,7 +154,7 @@ export interface MarkdownCreateParams {
   /**
    * Body param:
    */
-  setExtraHTTPHeaders?: Record<string, string>;
+  setExtraHTTPHeaders?: { [key: string]: string };
 
   /**
    * Body param:

package/src/resources/browser-rendering/pdf.ts

@@ -113,6 +113,11 @@ export interface PDFCreateParams {
    */
   html?: string;
 
+  /**
+   * Body param: Check [options](https://pptr.dev/api/puppeteer.pdfoptions).
+   */
+  pdfOptions?: PDFCreateParams.PDFOptions;
+
   /**
    * Body param: Block undesired requests that match the provided regex patterns, eg.
    * '/^.\*\.(css)'.
@@ -147,7 +152,7 @@ export interface PDFCreateParams {
   /**
    * Body param:
    */
-  setExtraHTTPHeaders?: Record<string, string>;
+  setExtraHTTPHeaders?: { [key: string]: string };
 
   /**
    * Body param:
@@ -255,6 +260,106 @@ export namespace PDFCreateParams {
       | Array<'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'>;
   }
 
+  /**
+   * Check [options](https://pptr.dev/api/puppeteer.pdfoptions).
+   */
+  export interface PDFOptions {
+    /**
+     * Whether to show the header and footer.
+     */
+    displayHeaderFooter?: boolean;
+
+    /**
+     * HTML template for the print footer.
+     */
+    footerTemplate?: string;
+
+    /**
+     * Paper format. Takes priority over width and height if set.
+     */
+    format?: 'letter' | 'legal' | 'tabloid' | 'ledger' | 'a0' | 'a1' | 'a2' | 'a3' | 'a4' | 'a5' | 'a6';
+
+    /**
+     * HTML template for the print header.
+     */
+    headerTemplate?: string;
+
+    /**
+     * Sets the height of paper. Can be a number or string with unit.
+     */
+    height?: string | number;
+
+    /**
+     * Whether to print in landscape orientation.
+     */
+    landscape?: boolean;
+
+    /**
+     * Set the PDF margins. Useful when setting header and footer.
+     */
+    margin?: PDFOptions.Margin;
+
+    /**
+     * Hides default white background and allows generating pdfs with transparency.
+     */
+    omitBackground?: boolean;
+
+    /**
+     * Generate document outline.
+     */
+    outline?: boolean;
+
+    /**
+     * Paper ranges to print, e.g. '1-5, 8, 11-13'.
+     */
+    pageRanges?: string;
+
+    /**
+     * Give CSS @page size priority over other size declarations.
+     */
+    preferCSSPageSize?: boolean;
+
+    /**
+     * Set to true to print background graphics.
+     */
+    printBackground?: boolean;
+
+    /**
+     * Scales the rendering of the web page. Amount must be between 0.1 and 2.
+     */
+    scale?: number;
+
+    /**
+     * Generate tagged (accessible) PDF.
+     */
+    tagged?: boolean;
+
+    /**
+     * Timeout in milliseconds.
+     */
+    timeout?: number;
+
+    /**
+     * Sets the width of paper. Can be a number or string with unit.
+     */
+    width?: string | number;
+  }
+
+  export namespace PDFOptions {
+    /**
+     * Set the PDF margins. Useful when setting header and footer.
+     */
+    export interface Margin {
+      bottom?: string | number;
+
+      left?: string | number;
+
+      right?: string | number;
+
+      top?: string | number;
+    }
+  }
+
   /**
    * Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
    */

package/src/resources/browser-rendering/scrape.ts

@@ -213,7 +213,7 @@ export interface ScrapeCreateParams {
   /**
    * Body param:
    */
-  setExtraHTTPHeaders?: Record<string, string>;
+  setExtraHTTPHeaders?: { [key: string]: string };
 
   /**
    * Body param:

package/src/resources/browser-rendering/screenshot.ts

@@ -186,7 +186,7 @@ export interface ScreenshotCreateParams {
   /**
    * Body param:
    */
-  setExtraHTTPHeaders?: Record<string, string>;
+  setExtraHTTPHeaders?: { [key: string]: string };
 
   /**
    * Body param:

package/src/resources/browser-rendering/snapshot.ts

@@ -167,7 +167,7 @@ export interface SnapshotCreateParams {
   /**
    * Body param:
    */
-  setExtraHTTPHeaders?: Record<string, string>;
+  setExtraHTTPHeaders?: { [key: string]: string };
 
   /**
    * Body param:

package/src/resources/cache/cache-reserve.ts

@@ -113,7 +113,7 @@ export class CacheReserveResource extends APIResource {
 }
 
 /**
- * ID of the zone setting.
+ * The identifier of the caching setting.
  */
 export type CacheReserve = 'cache_reserve';
 
@@ -162,17 +162,17 @@ export interface CacheReserveClearResponse {
 
 export interface CacheReserveEditResponse {
   /**
-   * ID of the zone setting.
+   * The identifier of the caching setting.
    */
   id: CacheReserve;
 
   /**
-   * Whether the setting is editable
+   * Whether the setting is editable.
    */
   editable: boolean;
 
   /**
-   * The value of the feature
+   * Value of the Cache Reserve zone setting.
    */
   value: 'on' | 'off';
 
@@ -184,17 +184,17 @@ export interface CacheReserveEditResponse {
 
 export interface CacheReserveGetResponse {
   /**
-   * ID of the zone setting.
+   * The identifier of the caching setting.
    */
   id: CacheReserve;
 
   /**
-   * Whether the setting is editable
+   * Whether the setting is editable.
    */
   editable: boolean;
 
   /**
-   * The value of the feature
+   * Value of the Cache Reserve zone setting.
    */
   value: 'on' | 'off';
 
@@ -239,7 +239,7 @@ export interface CacheReserveStatusResponse {
 
 export interface CacheReserveClearParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   zone_id: string;
 
@@ -251,7 +251,7 @@ export interface CacheReserveClearParams {
 
 export interface CacheReserveEditParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   zone_id: string;
 
@@ -263,14 +263,14 @@ export interface CacheReserveEditParams {
 
 export interface CacheReserveGetParams {
   /**
-   * Identifier
+   * Identifier.
    */
   zone_id: string;
 }
 
 export interface CacheReserveStatusParams {
   /**
-   * Identifier
+   * Identifier.
    */
   zone_id: string;
 }

package/src/resources/cache/cache.ts

@@ -123,7 +123,7 @@ export class Cache extends APIResource {
    * @example
    * ```ts
    * const response = await client.cache.purge({
-   *   zone_id: 'zone_id',
+   *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
    * });
    * ```
    */
@@ -138,9 +138,6 @@ export class Cache extends APIResource {
 }
 
 export interface CachePurgeResponse {
-  /**
-   * Identifier.
-   */
   id: string;
 }
 
@@ -235,7 +232,7 @@ export declare namespace CachePurgeParams {
 
   export namespace CachePurgeSingleFileWithURLAndHeaders {
     export interface File {
-      headers?: Record<string, string>;
+      headers?: { [key: string]: string };
 
       url?: string;
     }

package/src/resources/cache/regional-tiered-cache.ts

@@ -58,23 +58,23 @@ export class RegionalTieredCacheResource extends APIResource {
 }
 
 /**
- * ID of the zone setting.
+ * The identifier of the caching setting.
  */
 export type RegionalTieredCache = 'tc_regional';
 
 export interface RegionalTieredCacheEditResponse {
   /**
-   * ID of the zone setting.
+   * The identifier of the caching setting.
    */
   id: RegionalTieredCache;
 
   /**
-   * Whether the setting is editable
+   * Whether the setting is editable.
    */
   editable: boolean;
 
   /**
-   * The value of the feature
+   * Value of the Regional Tiered Cache zone setting.
    */
   value: 'on' | 'off';
 
@@ -86,17 +86,17 @@ export interface RegionalTieredCacheEditResponse {
 
 export interface RegionalTieredCacheGetResponse {
   /**
-   * ID of the zone setting.
+   * The identifier of the caching setting.
    */
   id: RegionalTieredCache;
 
   /**
-   * Whether the setting is editable
+   * Whether the setting is editable.
    */
   editable: boolean;
 
   /**
-   * The value of the feature
+   * Value of the Regional Tiered Cache zone setting.
    */
   value: 'on' | 'off';
 
@@ -108,7 +108,7 @@ export interface RegionalTieredCacheGetResponse {
 
 export interface RegionalTieredCacheEditParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   zone_id: string;
 
@@ -120,7 +120,7 @@ export interface RegionalTieredCacheEditParams {
 
 export interface RegionalTieredCacheGetParams {
   /**
-   * Identifier
+   * Identifier.
    */
   zone_id: string;
 }

package/src/resources/cache/smart-tiered-cache.ts

@@ -94,12 +94,12 @@ export class SmartTieredCache extends APIResource {
 
 export interface SmartTieredCacheDeleteResponse {
   /**
-   * ID of the zone setting.
+   * The identifier of the caching setting.
    */
   id: 'tiered_cache_smart_topology_enable';
 
   /**
-   * Whether the setting is editable
+   * Whether the setting is editable.
    */
   editable: boolean;
 
@@ -111,17 +111,17 @@ export interface SmartTieredCacheDeleteResponse {
 
 export interface SmartTieredCacheEditResponse {
   /**
-   * ID of the zone setting.
+   * The identifier of the caching setting.
    */
   id: 'tiered_cache_smart_topology_enable';
 
   /**
-   * Whether the setting is editable
+   * Whether the setting is editable.
    */
   editable: boolean;
 
   /**
-   * The value of the feature
+   * Value of the Smart Tiered Cache zone setting.
    */
   value: 'on' | 'off';
 
@@ -133,17 +133,17 @@ export interface SmartTieredCacheEditResponse {
 
 export interface SmartTieredCacheGetResponse {
   /**
-   * ID of the zone setting.
+   * The identifier of the caching setting.
    */
   id: 'tiered_cache_smart_topology_enable';
 
   /**
-   * Whether the setting is editable
+   * Whether the setting is editable.
    */
   editable: boolean;
 
   /**
-   * The value of the feature
+   * Value of the Smart Tiered Cache zone setting.
    */
   value: 'on' | 'off';
 
@@ -155,26 +155,26 @@ export interface SmartTieredCacheGetResponse {
 
 export interface SmartTieredCacheDeleteParams {
   /**
-   * Identifier
+   * Identifier.
    */
   zone_id: string;
 }
 
 export interface SmartTieredCacheEditParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   zone_id: string;
 
   /**
-   * Body param: Enable or disable the Smart Tiered Cache
+   * Body param: Enable or disable the Smart Tiered Cache.
    */
   value: 'on' | 'off';
 }
 
 export interface SmartTieredCacheGetParams {
   /**
-   * Identifier
+   * Identifier.
    */
   zone_id: string;
 }

package/src/resources/cache/variants.ts

@@ -96,12 +96,12 @@ export interface CacheVariant {
 
 export interface VariantDeleteResponse {
   /**
-   * ID of the zone setting.
+   * The identifier of the caching setting.
    */
   id: 'variants';
 
   /**
-   * Whether the setting is editable
+   * Whether the setting is editable.
    */
   editable: boolean;
 
@@ -113,19 +113,19 @@ export interface VariantDeleteResponse {
 
 export interface VariantEditResponse {
   /**
-   * ID of the zone setting.
+   * The identifier of the caching setting.
    */
   id: 'variants';
 
   /**
-   * Whether the setting is editable
+   * Whether the setting is editable.
    */
   editable: boolean;
 
   /**
-   * The value of the feature
+   * Value of the zone setting.
    */
-  value: string;
+  value: VariantEditResponse.Value;
 
   /**
    * Last time this setting was modified.
@@ -133,21 +133,94 @@ export interface VariantEditResponse {
   modified_on?: string | null;
 }
 
+export namespace VariantEditResponse {
+  /**
+   * Value of the zone setting.
+   */
+  export interface Value {
+    /**
+     * List of strings with the MIME types of all the variants that should be served
+     * for avif.
+     */
+    avif?: Array<string>;
+
+    /**
+     * List of strings with the MIME types of all the variants that should be served
+     * for bmp.
+     */
+    bmp?: Array<string>;
+
+    /**
+     * List of strings with the MIME types of all the variants that should be served
+     * for gif.
+     */
+    gif?: Array<string>;
+
+    /**
+     * List of strings with the MIME types of all the variants that should be served
+     * for jp2.
+     */
+    jp2?: Array<string>;
+
+    /**
+     * List of strings with the MIME types of all the variants that should be served
+     * for jpeg.
+     */
+    jpeg?: Array<string>;
+
+    /**
+     * List of strings with the MIME types of all the variants that should be served
+     * for jpg.
+     */
+    jpg?: Array<string>;
+
+    /**
+     * List of strings with the MIME types of all the variants that should be served
+     * for jpg2.
+     */
+    jpg2?: Array<string>;
+
+    /**
+     * List of strings with the MIME types of all the variants that should be served
+     * for png.
+     */
+    png?: Array<string>;
+
+    /**
+     * List of strings with the MIME types of all the variants that should be served
+     * for tif.
+     */
+    tif?: Array<string>;
+
+    /**
+     * List of strings with the MIME types of all the variants that should be served
+     * for tiff.
+     */
+    tiff?: Array<string>;
+
+    /**
+     * List of strings with the MIME types of all the variants that should be served
+     * for webp.
+     */
+    webp?: Array<string>;
+  }
+}
+
 export interface VariantGetResponse {
   /**
-   * ID of the zone setting.
+   * The identifier of the caching setting.
    */
   id: 'variants';
 
   /**
-   * Whether the setting is editable
+   * Whether the setting is editable.
    */
   editable: boolean;
 
   /**
-   * The value of the feature
+   * Value of the zone setting.
    */
-  value: string;
+  value: VariantGetResponse.Value;
 
   /**
    * Last time this setting was modified.
@@ -155,16 +228,89 @@ export interface VariantGetResponse {
   modified_on?: string | null;
 }
 
+export namespace VariantGetResponse {
+  /**
+   * Value of the zone setting.
+   */
+  export interface Value {
+    /**
+     * List of strings with the MIME types of all the variants that should be served
+     * for avif.
+     */
+    avif?: Array<string>;
+
+    /**
+     * List of strings with the MIME types of all the variants that should be served
+     * for bmp.
+     */
+    bmp?: Array<string>;
+
+    /**
+     * List of strings with the MIME types of all the variants that should be served
+     * for gif.
+     */
+    gif?: Array<string>;
+
+    /**
+     * List of strings with the MIME types of all the variants that should be served
+     * for jp2.
+     */
+    jp2?: Array<string>;
+
+    /**
+     * List of strings with the MIME types of all the variants that should be served
+     * for jpeg.
+     */
+    jpeg?: Array<string>;
+
+    /**
+     * List of strings with the MIME types of all the variants that should be served
+     * for jpg.
+     */
+    jpg?: Array<string>;
+
+    /**
+     * List of strings with the MIME types of all the variants that should be served
+     * for jpg2.
+     */
+    jpg2?: Array<string>;
+
+    /**
+     * List of strings with the MIME types of all the variants that should be served
+     * for png.
+     */
+    png?: Array<string>;
+
+    /**
+     * List of strings with the MIME types of all the variants that should be served
+     * for tif.
+     */
+    tif?: Array<string>;
+
+    /**
+     * List of strings with the MIME types of all the variants that should be served
+     * for tiff.
+     */
+    tiff?: Array<string>;
+
+    /**
+     * List of strings with the MIME types of all the variants that should be served
+     * for webp.
+     */
+    webp?: Array<string>;
+  }
+}
+
 export interface VariantDeleteParams {
   /**
-   * Identifier
+   * Identifier.
    */
   zone_id: string;
 }
 
 export interface VariantEditParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   zone_id: string;
 
@@ -249,7 +395,7 @@ export namespace VariantEditParams {
 
 export interface VariantGetParams {
   /**
-   * Identifier
+   * Identifier.
    */
   zone_id: string;
 }