cloudflare 4.3.0 → 4.4.0

package/src/resources/radar/attacks/layer3/top/locations.ts

@@ -65,56 +65,99 @@ export class Locations extends APIResource {
 }
 
 export interface LocationOriginResponse {
+  /**
+   * Metadata for the results.
+   */
   meta: LocationOriginResponse.Meta;
 
   top_0: Array<LocationOriginResponse.Top0>;
 }
 
 export namespace LocationOriginResponse {
+  /**
+   * Metadata for the results.
+   */
   export interface Meta {
+    confidenceInfo: Meta.ConfidenceInfo | null;
+
     dateRange: Array<Meta.DateRange>;
 
+    /**
+     * Timestamp of the last dataset update.
+     */
     lastUpdated: 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 Top0 {
@@ -129,56 +172,99 @@ export namespace LocationOriginResponse {
 }
 
 export interface LocationTargetResponse {
+  /**
+   * Metadata for the results.
+   */
   meta: LocationTargetResponse.Meta;
 
   top_0: Array<LocationTargetResponse.Top0>;
 }
 
 export namespace LocationTargetResponse {
+  /**
+   * Metadata for the results.
+   */
   export interface Meta {
+    confidenceInfo: Meta.ConfidenceInfo | null;
+
     dateRange: Array<Meta.DateRange>;
 
+    /**
+     * Timestamp of the last dataset update.
+     */
     lastUpdated: 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 Top0 {

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

@@ -47,11 +47,7 @@ export class Top extends APIResource {
    * This endpoint is deprecated. To continue getting this data, switch to the
    * summary by industry endpoint.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.attacks.layer3.top.industry();
-   * ```
+   * @deprecated
    */
   industry(query?: TopIndustryParams, options?: Core.RequestOptions): Core.APIPromise<TopIndustryResponse>;
   industry(options?: Core.RequestOptions): Core.APIPromise<TopIndustryResponse>;
@@ -73,11 +69,7 @@ export class Top extends APIResource {
    * This endpoint is deprecated. To continue getting this data, switch to the
    * summary by vertical endpoint.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.attacks.layer3.top.vertical();
-   * ```
+   * @deprecated
    */
   vertical(query?: TopVerticalParams, options?: Core.RequestOptions): Core.APIPromise<TopVerticalResponse>;
   vertical(options?: Core.RequestOptions): Core.APIPromise<TopVerticalResponse>;
@@ -97,56 +89,99 @@ export class Top extends APIResource {
 }
 
 export interface TopAttacksResponse {
+  /**
+   * Metadata for the results.
+   */
   meta: TopAttacksResponse.Meta;
 
   top_0: Array<TopAttacksResponse.Top0>;
 }
 
 export namespace TopAttacksResponse {
+  /**
+   * Metadata for the results.
+   */
   export interface Meta {
+    confidenceInfo: Meta.ConfidenceInfo | null;
+
     dateRange: Array<Meta.DateRange>;
 
+    /**
+     * Timestamp of the last dataset update.
+     */
     lastUpdated: 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 Top0 {
@@ -159,56 +194,99 @@ export namespace TopAttacksResponse {
 }
 
 export interface TopIndustryResponse {
+  /**
+   * Metadata for the results.
+   */
   meta: TopIndustryResponse.Meta;
 
   top_0: Array<TopIndustryResponse.Top0>;
 }
 
 export namespace TopIndustryResponse {
+  /**
+   * Metadata for the results.
+   */
   export interface Meta {
+    confidenceInfo: Meta.ConfidenceInfo | null;
+
     dateRange: Array<Meta.DateRange>;
 
+    /**
+     * Timestamp of the last dataset update.
+     */
     lastUpdated: 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 Top0 {
@@ -219,56 +297,99 @@ export namespace TopIndustryResponse {
 }
 
 export interface TopVerticalResponse {
+  /**
+   * Metadata for the results.
+   */
   meta: TopVerticalResponse.Meta;
 
   top_0: Array<TopVerticalResponse.Top0>;
 }
 
 export namespace TopVerticalResponse {
+  /**
+   * Metadata for the results.
+   */
   export interface Meta {
+    confidenceInfo: Meta.ConfidenceInfo | null;
+
     dateRange: Array<Meta.DateRange>;
 
+    /**
+     * Timestamp of the last dataset update.
+     */
     lastUpdated: 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 Top0 {