cloudflare 4.3.0 → 4.4.1

package/src/resources/radar/http/summary.ts

@@ -231,507 +231,898 @@ export class Summary extends APIResource {
 }
 
 export interface SummaryBotClassResponse {
+  /**
+   * Metadata for the results.
+   */
   meta: SummaryBotClassResponse.Meta;
 
   summary_0: SummaryBotClassResponse.Summary0;
 }
 
 export namespace SummaryBotClassResponse {
+  /**
+   * 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.
+     */
     bot: string;
 
+    /**
+     * A numeric string.
+     */
     human: string;
   }
 }
 
 export interface SummaryDeviceTypeResponse {
+  /**
+   * Metadata for the results.
+   */
   meta: SummaryDeviceTypeResponse.Meta;
 
   summary_0: SummaryDeviceTypeResponse.Summary0;
 }
 
 export namespace SummaryDeviceTypeResponse {
+  /**
+   * 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.
+     */
     desktop: string;
 
+    /**
+     * A numeric string.
+     */
     mobile: string;
 
+    /**
+     * A numeric string.
+     */
     other: string;
   }
 }
 
 export interface SummaryHTTPProtocolResponse {
+  /**
+   * Metadata for the results.
+   */
   meta: SummaryHTTPProtocolResponse.Meta;
 
   summary_0: SummaryHTTPProtocolResponse.Summary0;
 }
 
 export namespace SummaryHTTPProtocolResponse {
+  /**
+   * 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.
+     */
     http: string;
 
+    /**
+     * A numeric string.
+     */
     https: string;
   }
 }
 
 export interface SummaryHTTPVersionResponse {
+  /**
+   * Metadata for the results.
+   */
   meta: SummaryHTTPVersionResponse.Meta;
 
   summary_0: SummaryHTTPVersionResponse.Summary0;
 }
 
 export namespace SummaryHTTPVersionResponse {
+  /**
+   * 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.
+     */
     'HTTP/1.x': string;
 
+    /**
+     * A numeric string.
+     */
     'HTTP/2': string;
 
+    /**
+     * A numeric string.
+     */
     'HTTP/3': 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 SummaryOSResponse {
+  /**
+   * Metadata for the results.
+   */
   meta: SummaryOSResponse.Meta;
 
   summary_0: SummaryOSResponse.Summary0;
 }
 
 export namespace SummaryOSResponse {
+  /**
+   * 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.
+     */
     ANDROID: string;
 
+    /**
+     * A numeric string.
+     */
     IOS: string;
   }
 }
 
 export interface SummaryPostQuantumResponse {
+  /**
+   * Metadata for the results.
+   */
   meta: SummaryPostQuantumResponse.Meta;
 
   summary_0: SummaryPostQuantumResponse.Summary0;
 }
 
 export namespace SummaryPostQuantumResponse {
+  /**
+   * 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.
+     */
     NOT_SUPPORTED: string;
 
+    /**
+     * A numeric string.
+     */
     SUPPORTED: string;
   }
 }
 
 export interface SummaryTLSVersionResponse {
+  /**
+   * Metadata for the results.
+   */
   meta: SummaryTLSVersionResponse.Meta;
 
   summary_0: SummaryTLSVersionResponse.Summary0;
 }
 
 export namespace SummaryTLSVersionResponse {
+  /**
+   * 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.
+     */
     'TLS 1.0': string;
 
+    /**
+     * A numeric string.
+     */
     'TLS 1.1': string;
 
+    /**
+     * A numeric string.
+     */
     'TLS 1.2': string;
 
+    /**
+     * A numeric string.
+     */
     'TLS 1.3': string;
 
+    /**
+     * A numeric string.
+     */
     'TLS QUIC': string;
   }
 }