cloudflare 4.3.0 → 4.4.1

package/src/resources/radar/verified-bots/top.ts

@@ -60,54 +60,99 @@ export class Top extends APIResource {
 }
 
 export interface TopBotsResponse {
+  /**
+   * Metadata for the results.
+   */
   meta: TopBotsResponse.Meta;
 
   top_0: Array<TopBotsResponse.Top0>;
 }
 
 export namespace TopBotsResponse {
+  /**
+   * Metadata for the results.
+   */
   export interface Meta {
+    confidenceInfo: Meta.ConfidenceInfo | null;
+
     dateRange: Array<Meta.DateRange>;
 
-    confidenceInfo?: Meta.ConfidenceInfo;
+    /**
+     * Timestamp of the last dataset update.
+     */
+    lastUpdated: string;
+
+    /**
+     * Normalization method applied to the results. Refer to
+     * [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
+     */
+    normalization:
+      | 'PERCENTAGE'
+      | 'MIN0_MAX'
+      | 'MIN_MAX'
+      | 'RAW_VALUES'
+      | 'PERCENTAGE_CHANGE'
+      | 'ROLLING_AVERAGE'
+      | 'OVERLAPPED_PERCENTAGE'
+      | 'RATIO';
+
+    /**
+     * Measurement units for the results.
+     */
+    units: Array<Meta.Unit>;
   }
 
   export namespace Meta {
-    export interface DateRange {
-      /**
-       * Adjusted end of date range.
-       */
-      endTime: string;
+    export interface ConfidenceInfo {
+      annotations: Array<ConfidenceInfo.Annotation>;
 
       /**
-       * Adjusted start of date range.
+       * Provides an indication of how much confidence Cloudflare has in the data.
        */
-      startTime: string;
-    }
-
-    export interface ConfidenceInfo {
-      annotations?: Array<ConfidenceInfo.Annotation>;
-
-      level?: number;
+      level: number;
     }
 
     export namespace ConfidenceInfo {
+      /**
+       * Annotation associated with the result (e.g. outage or other type of event).
+       */
       export interface Annotation {
         dataSource: string;
 
         description: string;
 
+        endDate: string;
+
         eventType: string;
 
+        /**
+         * Whether event is a single point in time or a time range.
+         */
         isInstantaneous: boolean;
 
-        endTime?: string;
-
-        linkedUrl?: string;
+        linkedUrl: string;
 
-        startTime?: string;
+        startDate: string;
       }
     }
+
+    export interface DateRange {
+      /**
+       * Adjusted end of date range.
+       */
+      endTime: string;
+
+      /**
+       * Adjusted start of date range.
+       */
+      startTime: string;
+    }
+
+    export interface Unit {
+      name: string;
+
+      value: string;
+    }
   }
 
   export interface Top0 {
@@ -117,64 +162,115 @@ export namespace TopBotsResponse {
 
     botOwner: string;
 
+    /**
+     * A numeric string.
+     */
     value: string;
   }
 }
 
 export interface TopCategoriesResponse {
+  /**
+   * Metadata for the results.
+   */
   meta: TopCategoriesResponse.Meta;
 
   top_0: Array<TopCategoriesResponse.Top0>;
 }
 
 export namespace TopCategoriesResponse {
+  /**
+   * Metadata for the results.
+   */
   export interface Meta {
+    confidenceInfo: Meta.ConfidenceInfo | null;
+
     dateRange: Array<Meta.DateRange>;
 
-    confidenceInfo?: Meta.ConfidenceInfo;
+    /**
+     * Timestamp of the last dataset update.
+     */
+    lastUpdated: string;
+
+    /**
+     * Normalization method applied to the results. Refer to
+     * [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
+     */
+    normalization:
+      | 'PERCENTAGE'
+      | 'MIN0_MAX'
+      | 'MIN_MAX'
+      | 'RAW_VALUES'
+      | 'PERCENTAGE_CHANGE'
+      | 'ROLLING_AVERAGE'
+      | 'OVERLAPPED_PERCENTAGE'
+      | 'RATIO';
+
+    /**
+     * Measurement units for the results.
+     */
+    units: Array<Meta.Unit>;
   }
 
   export namespace Meta {
-    export interface DateRange {
-      /**
-       * Adjusted end of date range.
-       */
-      endTime: string;
+    export interface ConfidenceInfo {
+      annotations: Array<ConfidenceInfo.Annotation>;
 
       /**
-       * Adjusted start of date range.
+       * Provides an indication of how much confidence Cloudflare has in the data.
        */
-      startTime: string;
-    }
-
-    export interface ConfidenceInfo {
-      annotations?: Array<ConfidenceInfo.Annotation>;
-
-      level?: number;
+      level: number;
     }
 
     export namespace ConfidenceInfo {
+      /**
+       * Annotation associated with the result (e.g. outage or other type of event).
+       */
       export interface Annotation {
         dataSource: string;
 
         description: string;
 
+        endDate: string;
+
         eventType: string;
 
+        /**
+         * Whether event is a single point in time or a time range.
+         */
         isInstantaneous: boolean;
 
-        endTime?: string;
-
-        linkedUrl?: string;
+        linkedUrl: string;
 
-        startTime?: string;
+        startDate: string;
       }
     }
+
+    export interface DateRange {
+      /**
+       * Adjusted end of date range.
+       */
+      endTime: string;
+
+      /**
+       * Adjusted start of date range.
+       */
+      startTime: string;
+    }
+
+    export interface Unit {
+      name: string;
+
+      value: string;
+    }
   }
 
   export interface Top0 {
     botCategory: string;
 
+    /**
+     * A numeric string.
+     */
     value: string;
   }
 }

package/src/resources/rulesets/rules.ts

@@ -1159,7 +1159,7 @@ export namespace ExecuteRule {
 
     export namespace Overrides {
       /**
-       * A category-level override
+       * A category-level override.
        */
       export interface Category {
         /**
@@ -1184,7 +1184,7 @@ export namespace ExecuteRule {
       }
 
       /**
-       * A rule-level override
+       * A rule-level override.
        */
       export interface Rule {
         /**
@@ -1402,7 +1402,7 @@ export namespace ExecuteRuleParam {
 
     export namespace Overrides {
       /**
-       * A category-level override
+       * A category-level override.
        */
       export interface Category {
         /**
@@ -1427,7 +1427,7 @@ export namespace ExecuteRuleParam {
       }
 
       /**
-       * A rule-level override
+       * A rule-level override.
        */
       export interface Rule {
         /**
@@ -4791,7 +4791,7 @@ export namespace SetCacheSettingsRule {
 
     /**
      * Generate Cloudflare error pages from issues sent from the origin server. When
-     * on, error pages will trigger for issues from the origin
+     * on, error pages will trigger for issues from the origin.
      */
     origin_error_page_passthru?: boolean;
 
@@ -4842,13 +4842,13 @@ export namespace SetCacheSettingsRule {
      */
     export interface CacheKey {
       /**
-       * Separate cached content based on the visitor’s device type
+       * Separate cached content based on the visitor’s device type.
        */
       cache_by_device_type?: boolean;
 
       /**
        * Protect from web cache deception attacks while allowing static assets to be
-       * cached
+       * cached.
        */
       cache_deception_armor?: boolean;
 
@@ -5072,12 +5072,12 @@ export namespace SetCacheSettingsRule {
       default: number;
 
       /**
-       * edge ttl options
+       * Edge TTL options.
        */
       mode: 'respect_origin' | 'bypass_by_default' | 'override_origin';
 
       /**
-       * List of single status codes, or status code ranges to apply the selected mode
+       * List of single status codes, or status code ranges to apply the selected mode.
        */
       status_code_ttl: Array<EdgeTTL.StatusCodeTTL>;
     }
@@ -5085,7 +5085,7 @@ export namespace SetCacheSettingsRule {
     export namespace EdgeTTL {
       /**
        * Specify how long Cloudflare should cache the response based on the status code
-       * from the origin. Can be a single status code or a range or status codes
+       * from the origin. Can be a single status code or a range or status codes.
        */
       export interface StatusCodeTTL {
         /**
@@ -5101,7 +5101,7 @@ export namespace SetCacheSettingsRule {
         status_code_range?: StatusCodeTTL.StatusCodeRange;
 
         /**
-         * Set the ttl for responses with this specific status code
+         * Set the TTL for responses with this specific status code.
          */
         status_code_value?: number;
       }
@@ -5112,12 +5112,12 @@ export namespace SetCacheSettingsRule {
          */
         export interface StatusCodeRange {
           /**
-           * response status code lower bound
+           * Response status code lower bound.
            */
           from: number;
 
           /**
-           * response status code upper bound
+           * Response status code upper bound.
            */
           to: number;
         }
@@ -5307,7 +5307,7 @@ export namespace SetCacheSettingsRuleParam {
 
     /**
      * Generate Cloudflare error pages from issues sent from the origin server. When
-     * on, error pages will trigger for issues from the origin
+     * on, error pages will trigger for issues from the origin.
      */
     origin_error_page_passthru?: boolean;
 
@@ -5358,13 +5358,13 @@ export namespace SetCacheSettingsRuleParam {
      */
     export interface CacheKey {
       /**
-       * Separate cached content based on the visitor’s device type
+       * Separate cached content based on the visitor’s device type.
        */
       cache_by_device_type?: boolean;
 
       /**
        * Protect from web cache deception attacks while allowing static assets to be
-       * cached
+       * cached.
        */
       cache_deception_armor?: boolean;
 
@@ -5588,12 +5588,12 @@ export namespace SetCacheSettingsRuleParam {
       default: number;
 
       /**
-       * edge ttl options
+       * Edge TTL options.
        */
       mode: 'respect_origin' | 'bypass_by_default' | 'override_origin';
 
       /**
-       * List of single status codes, or status code ranges to apply the selected mode
+       * List of single status codes, or status code ranges to apply the selected mode.
        */
       status_code_ttl: Array<EdgeTTL.StatusCodeTTL>;
     }
@@ -5601,7 +5601,7 @@ export namespace SetCacheSettingsRuleParam {
     export namespace EdgeTTL {
       /**
        * Specify how long Cloudflare should cache the response based on the status code
-       * from the origin. Can be a single status code or a range or status codes
+       * from the origin. Can be a single status code or a range or status codes.
        */
       export interface StatusCodeTTL {
         /**
@@ -5617,7 +5617,7 @@ export namespace SetCacheSettingsRuleParam {
         status_code_range?: StatusCodeTTL.StatusCodeRange;
 
         /**
-         * Set the ttl for responses with this specific status code
+         * Set the TTL for responses with this specific status code.
          */
         status_code_value?: number;
       }
@@ -5628,12 +5628,12 @@ export namespace SetCacheSettingsRuleParam {
          */
         export interface StatusCodeRange {
           /**
-           * response status code lower bound
+           * Response status code lower bound.
            */
           from: number;
 
           /**
-           * response status code upper bound
+           * Response status code upper bound.
            */
           to: number;
         }
@@ -5852,10 +5852,10 @@ export namespace SetConfigRule {
     /**
      * Configure the Polish level.
      */
-    polish?: 'off' | 'lossless' | 'lossy';
+    polish?: 'off' | 'lossless' | 'lossy' | 'webp';
 
     /**
-     * Turn on or off Rocket Loader
+     * Turn on or off Rocket Loader.
      */
     rocket_loader?: boolean;
 
@@ -6084,10 +6084,10 @@ export namespace SetConfigRuleParam {
     /**
      * Configure the Polish level.
      */
-    polish?: 'off' | 'lossless' | 'lossy';
+    polish?: 'off' | 'lossless' | 'lossy' | 'webp';
 
     /**
-     * Turn on or off Rocket Loader
+     * Turn on or off Rocket Loader.
      */
     rocket_loader?: boolean;
 
@@ -8251,7 +8251,7 @@ export declare namespace RuleCreateParams {
 
       export namespace Overrides {
         /**
-         * A category-level override
+         * A category-level override.
          */
         export interface Category {
           /**
@@ -8276,7 +8276,7 @@ export declare namespace RuleCreateParams {
         }
 
         /**
-         * A rule-level override
+         * A rule-level override.
          */
         export interface Rule {
           /**
@@ -10136,10 +10136,10 @@ export declare namespace RuleCreateParams {
       /**
        * Configure the Polish level.
        */
-      polish?: 'off' | 'lossless' | 'lossy';
+      polish?: 'off' | 'lossless' | 'lossy' | 'webp';
 
       /**
-       * Turn on or off Rocket Loader
+       * Turn on or off Rocket Loader.
        */
       rocket_loader?: boolean;
 
@@ -10609,7 +10609,7 @@ export declare namespace RuleCreateParams {
 
       /**
        * Generate Cloudflare error pages from issues sent from the origin server. When
-       * on, error pages will trigger for issues from the origin
+       * on, error pages will trigger for issues from the origin.
        */
       origin_error_page_passthru?: boolean;
 
@@ -10660,13 +10660,13 @@ export declare namespace RuleCreateParams {
        */
       export interface CacheKey {
         /**
-         * Separate cached content based on the visitor’s device type
+         * Separate cached content based on the visitor’s device type.
          */
         cache_by_device_type?: boolean;
 
         /**
          * Protect from web cache deception attacks while allowing static assets to be
-         * cached
+         * cached.
          */
         cache_deception_armor?: boolean;
 
@@ -10890,12 +10890,12 @@ export declare namespace RuleCreateParams {
         default: number;
 
         /**
-         * edge ttl options
+         * Edge TTL options.
          */
         mode: 'respect_origin' | 'bypass_by_default' | 'override_origin';
 
         /**
-         * List of single status codes, or status code ranges to apply the selected mode
+         * List of single status codes, or status code ranges to apply the selected mode.
          */
         status_code_ttl: Array<EdgeTTL.StatusCodeTTL>;
       }
@@ -10903,7 +10903,7 @@ export declare namespace RuleCreateParams {
       export namespace EdgeTTL {
         /**
          * Specify how long Cloudflare should cache the response based on the status code
-         * from the origin. Can be a single status code or a range or status codes
+         * from the origin. Can be a single status code or a range or status codes.
          */
         export interface StatusCodeTTL {
           /**
@@ -10919,7 +10919,7 @@ export declare namespace RuleCreateParams {
           status_code_range?: StatusCodeTTL.StatusCodeRange;
 
           /**
-           * Set the ttl for responses with this specific status code
+           * Set the TTL for responses with this specific status code.
            */
           status_code_value?: number;
         }
@@ -10930,12 +10930,12 @@ export declare namespace RuleCreateParams {
            */
           export interface StatusCodeRange {
             /**
-             * response status code lower bound
+             * Response status code lower bound.
              */
             from: number;
 
             /**
-             * response status code upper bound
+             * Response status code upper bound.
              */
             to: number;
           }
@@ -12393,7 +12393,7 @@ export declare namespace RuleEditParams {
 
       export namespace Overrides {
         /**
-         * A category-level override
+         * A category-level override.
          */
         export interface Category {
           /**
@@ -12418,7 +12418,7 @@ export declare namespace RuleEditParams {
         }
 
         /**
-         * A rule-level override
+         * A rule-level override.
          */
         export interface Rule {
           /**
@@ -14278,10 +14278,10 @@ export declare namespace RuleEditParams {
       /**
        * Configure the Polish level.
        */
-      polish?: 'off' | 'lossless' | 'lossy';
+      polish?: 'off' | 'lossless' | 'lossy' | 'webp';
 
       /**
-       * Turn on or off Rocket Loader
+       * Turn on or off Rocket Loader.
        */
       rocket_loader?: boolean;
 
@@ -14751,7 +14751,7 @@ export declare namespace RuleEditParams {
 
       /**
        * Generate Cloudflare error pages from issues sent from the origin server. When
-       * on, error pages will trigger for issues from the origin
+       * on, error pages will trigger for issues from the origin.
        */
       origin_error_page_passthru?: boolean;
 
@@ -14802,13 +14802,13 @@ export declare namespace RuleEditParams {
        */
       export interface CacheKey {
         /**
-         * Separate cached content based on the visitor’s device type
+         * Separate cached content based on the visitor’s device type.
          */
         cache_by_device_type?: boolean;
 
         /**
          * Protect from web cache deception attacks while allowing static assets to be
-         * cached
+         * cached.
          */
         cache_deception_armor?: boolean;
 
@@ -15032,12 +15032,12 @@ export declare namespace RuleEditParams {
         default: number;
 
         /**
-         * edge ttl options
+         * Edge TTL options.
          */
         mode: 'respect_origin' | 'bypass_by_default' | 'override_origin';
 
         /**
-         * List of single status codes, or status code ranges to apply the selected mode
+         * List of single status codes, or status code ranges to apply the selected mode.
          */
         status_code_ttl: Array<EdgeTTL.StatusCodeTTL>;
       }
@@ -15045,7 +15045,7 @@ export declare namespace RuleEditParams {
       export namespace EdgeTTL {
         /**
          * Specify how long Cloudflare should cache the response based on the status code
-         * from the origin. Can be a single status code or a range or status codes
+         * from the origin. Can be a single status code or a range or status codes.
          */
         export interface StatusCodeTTL {
           /**
@@ -15061,7 +15061,7 @@ export declare namespace RuleEditParams {
           status_code_range?: StatusCodeTTL.StatusCodeRange;
 
           /**
-           * Set the ttl for responses with this specific status code
+           * Set the TTL for responses with this specific status code.
            */
           status_code_value?: number;
         }
@@ -15072,12 +15072,12 @@ export declare namespace RuleEditParams {
            */
           export interface StatusCodeRange {
             /**
-             * response status code lower bound
+             * Response status code lower bound.
              */
             from: number;
 
             /**
-             * response status code upper bound
+             * Response status code upper bound.
              */
             to: number;
           }

package/src/resources/schema-validation/schemas.ts

@@ -16,6 +16,7 @@ export class Schemas extends APIResource {
    *     kind: 'openapi_v3',
    *     name: 'petstore schema',
    *     source: '<schema file contents>',
+   *     validation_enabled: true,
    *   },
    * );
    * ```
@@ -292,7 +293,7 @@ export interface SchemaCreateParams {
   /**
    * Body param: An indicator if this schema is enabled
    */
-  validation_enabled?: boolean;
+  validation_enabled: boolean;
 }
 
 export interface SchemaListParams extends V4PagePaginationArrayParams {