cloudflare 4.3.0 → 4.4.0

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

@@ -51,11 +51,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.layer7.top.industry();
-   * ```
+   * @deprecated
    */
   industry(query?: TopIndustryParams, options?: Core.RequestOptions): Core.APIPromise<TopIndustryResponse>;
   industry(options?: Core.RequestOptions): Core.APIPromise<TopIndustryResponse>;
@@ -77,11 +73,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.layer7.top.vertical();
-   * ```
+   * @deprecated
    */
   vertical(query?: TopVerticalParams, options?: Core.RequestOptions): Core.APIPromise<TopVerticalResponse>;
   vertical(options?: Core.RequestOptions): Core.APIPromise<TopVerticalResponse>;
@@ -101,56 +93,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 {
@@ -167,56 +202,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 {
@@ -227,56 +305,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 {

package/src/resources/radar/bgp/bgp.ts

@@ -70,51 +70,60 @@ export interface BGPTimeseriesResponse {
 
 export namespace BGPTimeseriesResponse {
   export interface Meta {
-    aggInterval: string;
+    aggInterval: '15m' | '1h' | '1d' | '1w';
+
+    confidenceInfo: Meta.ConfidenceInfo;
 
     dateRange: Array<Meta.DateRange>;
 
     lastUpdated: string;
-
-    confidenceInfo?: Meta.ConfidenceInfo;
   }
 
   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 Serie0 {

package/src/resources/radar/bgp/ips.ts

@@ -35,33 +35,161 @@ export class IPs extends APIResource {
 }
 
 export interface IPTimeseriesResponse {
+  /**
+   * Metadata for the results.
+   */
   meta: IPTimeseriesResponse.Meta;
 
-  serie_174: IPTimeseriesResponse.Serie174;
+  serie_0: IPTimeseriesResponse.Serie0;
 }
 
 export namespace IPTimeseriesResponse {
+  /**
+   * Metadata for the results.
+   */
   export interface Meta {
-    queries: Array<Meta.Query>;
+    /**
+     * Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
+     * Refer to
+     * [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
+     */
+    aggInterval: 'FIFTEEN_MINUTES' | 'ONE_HOUR' | 'ONE_DAY' | 'ONE_WEEK' | 'ONE_MONTH';
+
+    confidenceInfo: Meta.ConfidenceInfo;
+
+    dateRange: Array<Meta.DateRange>;
+
+    /**
+     * 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>;
+
+    delay?: Meta.Delay;
   }
 
   export namespace Meta {
-    export interface Query {
-      dateRange: Query.DateRange;
+    export interface ConfidenceInfo {
+      annotations: Array<ConfidenceInfo.Annotation>;
+
+      /**
+       * Provides an indication of how much confidence Cloudflare has in the data.
+       */
+      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;
+
+        linkedUrl: string;
+
+        startDate: string;
+      }
+    }
+
+    export interface DateRange {
+      /**
+       * Adjusted end of date range.
+       */
+      endTime: string;
 
-      entity: string;
+      /**
+       * Adjusted start of date range.
+       */
+      startTime: string;
     }
 
-    export namespace Query {
-      export interface DateRange {
-        endTime: string;
+    export interface Unit {
+      name: string;
+
+      value: string;
+    }
+
+    export interface Delay {
+      asn_data: Delay.ASNData;
+
+      country_data: Delay.CountryData;
+
+      healthy: boolean;
+
+      nowTs: number;
+    }
+
+    export namespace Delay {
+      export interface ASNData {
+        delaySecs: number;
+
+        delayStr: string;
+
+        healthy: boolean;
+
+        latest: ASNData.Latest;
+      }
+
+      export namespace ASNData {
+        export interface Latest {
+          entries_count: number;
+
+          path: string;
+
+          timestamp: number;
+        }
+      }
+
+      export interface CountryData {
+        delaySecs: number;
+
+        delayStr: string;
+
+        healthy: boolean;
+
+        latest: CountryData.Latest;
+      }
+
+      export namespace CountryData {
+        export interface Latest {
+          count: number;
 
-        startTime: string;
+          timestamp: number;
+        }
       }
     }
   }
 
-  export interface Serie174 {
+  export interface Serie0 {
     ipv4: Array<string>;
 
     ipv6: Array<string>;

package/src/resources/radar/bgp/routes.ts

@@ -78,8 +78,8 @@ export class Routes extends APIResource {
   }
 
   /**
-   * Retrieves realtime routes for prefixes using public realtime data collectors
-   * (RouteViews and RIPE RIS).
+   * Retrieves real-time BGP routes for a prefix, using public real-time data
+   * collectors (RouteViews and RIPE RIS).
    *
    * @example
    * ```ts
@@ -322,7 +322,7 @@ export namespace RouteRealtimeResponse {
       collector: string;
 
       /**
-       * Latest realtime stream timestamp for this collector.
+       * Latest real-time stream timestamp for this collector.
        */
       latest_realtime_ts: string;
 

package/src/resources/radar/bgp/top/top.ts

@@ -62,6 +62,9 @@ export namespace TopPrefixesResponse {
   export interface Top0 {
     prefix: string;
 
+    /**
+     * A numeric string.
+     */
     value: string;
   }
 }