cloudflare 4.3.0 → 4.4.0

package/src/resources/radar/attacks/layer3/summary.ts

@@ -200,436 +200,774 @@ export class Summary extends APIResource {
 }
 
 export interface SummaryBitrateResponse {
+  /**
+   * Metadata for the results.
+   */
   meta: SummaryBitrateResponse.Meta;
 
   summary_0: SummaryBitrateResponse.Summary0;
 }
 
 export namespace SummaryBitrateResponse {
+  /**
+   * Metadata for the results.
+   */
   export interface Meta {
+    confidenceInfo: Meta.ConfidenceInfo | null;
+
     dateRange: Array<Meta.DateRange>;
 
+    /**
+     * Timestamp of the last dataset update.
+     */
     lastUpdated: string;
 
-    normalization: string;
-
-    confidenceInfo?: Meta.ConfidenceInfo;
+    /**
+     * 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 Summary0 {
+    /**
+     * A numeric string.
+     */
     _1_GBPS_TO_10_GBPS: string;
 
+    /**
+     * A numeric string.
+     */
     _10_GBPS_TO_100_GBPS: string;
 
+    /**
+     * A numeric string.
+     */
     _500_MBPS_TO_1_GBPS: string;
 
+    /**
+     * A numeric string.
+     */
     OVER_100_GBPS: string;
 
+    /**
+     * A numeric string.
+     */
     UNDER_500_MBPS: string;
   }
 }
 
 export interface SummaryDurationResponse {
+  /**
+   * Metadata for the results.
+   */
   meta: SummaryDurationResponse.Meta;
 
   summary_0: SummaryDurationResponse.Summary0;
 }
 
 export namespace SummaryDurationResponse {
+  /**
+   * Metadata for the results.
+   */
   export interface Meta {
+    confidenceInfo: Meta.ConfidenceInfo | null;
+
     dateRange: Array<Meta.DateRange>;
 
+    /**
+     * Timestamp of the last dataset update.
+     */
     lastUpdated: string;
 
-    normalization: string;
-
-    confidenceInfo?: Meta.ConfidenceInfo;
+    /**
+     * 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 Summary0 {
+    /**
+     * A numeric string.
+     */
     _1_HOUR_TO_3_HOURS: string;
 
+    /**
+     * A numeric string.
+     */
     _10_MINS_TO_20_MINS: string;
 
+    /**
+     * A numeric string.
+     */
     _20_MINS_TO_40_MINS: string;
 
+    /**
+     * A numeric string.
+     */
     _40_MINS_TO_1_HOUR: string;
 
+    /**
+     * A numeric string.
+     */
     OVER_3_HOURS: string;
 
+    /**
+     * A numeric string.
+     */
     UNDER_10_MINS: string;
   }
 }
 
 export interface SummaryIndustryResponse {
+  /**
+   * Metadata for the results.
+   */
   meta: SummaryIndustryResponse.Meta;
 
   summary_0: Record<string, string>;
 }
 
 export namespace SummaryIndustryResponse {
+  /**
+   * Metadata for the results.
+   */
   export interface Meta {
+    confidenceInfo: Meta.ConfidenceInfo | null;
+
     dateRange: Array<Meta.DateRange>;
 
+    /**
+     * Timestamp of the last dataset update.
+     */
     lastUpdated: string;
 
-    normalization: string;
-
-    confidenceInfo?: Meta.ConfidenceInfo;
+    /**
+     * 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 SummaryIPVersionResponse {
+  /**
+   * Metadata for the results.
+   */
   meta: SummaryIPVersionResponse.Meta;
 
   summary_0: SummaryIPVersionResponse.Summary0;
 }
 
 export namespace SummaryIPVersionResponse {
+  /**
+   * Metadata for the results.
+   */
   export interface Meta {
+    confidenceInfo: Meta.ConfidenceInfo | null;
+
     dateRange: Array<Meta.DateRange>;
 
+    /**
+     * Timestamp of the last dataset update.
+     */
     lastUpdated: string;
 
-    normalization: string;
-
-    confidenceInfo?: Meta.ConfidenceInfo;
+    /**
+     * 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 Summary0 {
+    /**
+     * A numeric string.
+     */
     IPv4: string;
 
+    /**
+     * A numeric string.
+     */
     IPv6: string;
   }
 }
 
 export interface SummaryProtocolResponse {
+  /**
+   * Metadata for the results.
+   */
   meta: SummaryProtocolResponse.Meta;
 
   summary_0: SummaryProtocolResponse.Summary0;
 }
 
 export namespace SummaryProtocolResponse {
+  /**
+   * Metadata for the results.
+   */
   export interface Meta {
+    confidenceInfo: Meta.ConfidenceInfo | null;
+
     dateRange: Array<Meta.DateRange>;
 
+    /**
+     * Timestamp of the last dataset update.
+     */
     lastUpdated: string;
 
-    normalization: string;
-
-    confidenceInfo?: Meta.ConfidenceInfo;
+    /**
+     * 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 Summary0 {
+    /**
+     * A numeric string.
+     */
     GRE: string;
 
+    /**
+     * A numeric string.
+     */
     ICMP: string;
 
+    /**
+     * A numeric string.
+     */
     TCP: string;
 
+    /**
+     * A numeric string.
+     */
     UDP: string;
   }
 }
 
 export interface SummaryVectorResponse {
+  /**
+   * Metadata for the results.
+   */
   meta: SummaryVectorResponse.Meta;
 
   summary_0: Record<string, string>;
 }
 
 export namespace SummaryVectorResponse {
+  /**
+   * Metadata for the results.
+   */
   export interface Meta {
+    confidenceInfo: Meta.ConfidenceInfo | null;
+
     dateRange: Array<Meta.DateRange>;
 
+    /**
+     * Timestamp of the last dataset update.
+     */
     lastUpdated: string;
 
-    normalization: string;
-
-    confidenceInfo?: Meta.ConfidenceInfo;
+    /**
+     * 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 SummaryVerticalResponse {
+  /**
+   * Metadata for the results.
+   */
   meta: SummaryVerticalResponse.Meta;
 
   summary_0: Record<string, string>;
 }
 
 export namespace SummaryVerticalResponse {
+  /**
+   * Metadata for the results.
+   */
   export interface Meta {
+    confidenceInfo: Meta.ConfidenceInfo | null;
+
     dateRange: Array<Meta.DateRange>;
 
+    /**
+     * Timestamp of the last dataset update.
+     */
     lastUpdated: string;
 
-    normalization: string;
-
-    confidenceInfo?: Meta.ConfidenceInfo;
+    /**
+     * 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;
+    }
   }
 }