cloudflare 5.1.0 → 6.0.0-beta.1

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

@@ -69,6 +69,71 @@ export class HTTP extends APIResource {
   );
   top: TopAPI.Top = new TopAPI.Top(this._client);
 
+  /**
+   * Retrieves the distribution of HTTP requests by the specified dimension.
+   *
+   * @example
+   * ```ts
+   * const response = await client.radar.http.summaryV2('ADM1');
+   * ```
+   */
+  summaryV2(
+    dimension:
+      | 'ADM1'
+      | 'BOT_CLASS'
+      | 'BROWSER'
+      | 'BROWSER_FAMILY'
+      | 'DEVICE_TYPE'
+      | 'HTTP_PROTOCOL'
+      | 'HTTP_VERSION'
+      | 'IP_VERSION'
+      | 'OS'
+      | 'POST_QUANTUM'
+      | 'TLS_VERSION',
+    query?: HTTPSummaryV2Params,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<HTTPSummaryV2Response>;
+  summaryV2(
+    dimension:
+      | 'ADM1'
+      | 'BOT_CLASS'
+      | 'BROWSER'
+      | 'BROWSER_FAMILY'
+      | 'DEVICE_TYPE'
+      | 'HTTP_PROTOCOL'
+      | 'HTTP_VERSION'
+      | 'IP_VERSION'
+      | 'OS'
+      | 'POST_QUANTUM'
+      | 'TLS_VERSION',
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<HTTPSummaryV2Response>;
+  summaryV2(
+    dimension:
+      | 'ADM1'
+      | 'BOT_CLASS'
+      | 'BROWSER'
+      | 'BROWSER_FAMILY'
+      | 'DEVICE_TYPE'
+      | 'HTTP_PROTOCOL'
+      | 'HTTP_VERSION'
+      | 'IP_VERSION'
+      | 'OS'
+      | 'POST_QUANTUM'
+      | 'TLS_VERSION',
+    query: HTTPSummaryV2Params | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<HTTPSummaryV2Response> {
+    if (isRequestOptions(query)) {
+      return this.summaryV2(dimension, {}, query);
+    }
+    return (
+      this._client.get(`/radar/http/summary/${dimension}`, { query, ...options }) as Core.APIPromise<{
+        result: HTTPSummaryV2Response;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
   /**
    * Retrieves the HTTP requests over time.
    *
@@ -95,6 +160,202 @@ export class HTTP extends APIResource {
       }>
     )._thenUnwrap((obj) => obj.result);
   }
+
+  /**
+   * Retrieves the distribution of HTTP requests grouped by dimension.
+   *
+   * @example
+   * ```ts
+   * const response = await client.radar.http.timeseriesGroupsV2(
+   *   'ADM1',
+   * );
+   * ```
+   */
+  timeseriesGroupsV2(
+    dimension:
+      | 'ADM1'
+      | 'BOT_CLASS'
+      | 'BROWSER'
+      | 'BROWSER_FAMILY'
+      | 'DEVICE_TYPE'
+      | 'HTTP_PROTOCOL'
+      | 'HTTP_VERSION'
+      | 'IP_VERSION'
+      | 'OS'
+      | 'POST_QUANTUM'
+      | 'TLS_VERSION',
+    query?: HTTPTimeseriesGroupsV2Params,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<HTTPTimeseriesGroupsV2Response>;
+  timeseriesGroupsV2(
+    dimension:
+      | 'ADM1'
+      | 'BOT_CLASS'
+      | 'BROWSER'
+      | 'BROWSER_FAMILY'
+      | 'DEVICE_TYPE'
+      | 'HTTP_PROTOCOL'
+      | 'HTTP_VERSION'
+      | 'IP_VERSION'
+      | 'OS'
+      | 'POST_QUANTUM'
+      | 'TLS_VERSION',
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<HTTPTimeseriesGroupsV2Response>;
+  timeseriesGroupsV2(
+    dimension:
+      | 'ADM1'
+      | 'BOT_CLASS'
+      | 'BROWSER'
+      | 'BROWSER_FAMILY'
+      | 'DEVICE_TYPE'
+      | 'HTTP_PROTOCOL'
+      | 'HTTP_VERSION'
+      | 'IP_VERSION'
+      | 'OS'
+      | 'POST_QUANTUM'
+      | 'TLS_VERSION',
+    query: HTTPTimeseriesGroupsV2Params | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<HTTPTimeseriesGroupsV2Response> {
+    if (isRequestOptions(query)) {
+      return this.timeseriesGroupsV2(dimension, {}, query);
+    }
+    return (
+      this._client.get(`/radar/http/timeseries_groups/${dimension}`, {
+        query,
+        ...options,
+      }) as Core.APIPromise<{ result: HTTPTimeseriesGroupsV2Response }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export interface HTTPSummaryV2Response {
+  /**
+   * Metadata for the results.
+   */
+  meta: HTTPSummaryV2Response.Meta;
+
+  summary_0: { [key: string]: string };
+}
+
+export namespace HTTPSummaryV2Response {
+  /**
+   * Metadata for the results.
+   */
+  export interface Meta {
+    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>;
+  }
+
+  export namespace Meta {
+    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 {
+        /**
+         * Data source for annotations.
+         */
+        dataSource:
+          | 'ALL'
+          | 'AI_BOTS'
+          | 'AI_GATEWAY'
+          | 'BGP'
+          | 'BOTS'
+          | 'CONNECTION_ANOMALY'
+          | 'CT'
+          | 'DNS'
+          | 'DNS_MAGNITUDE'
+          | 'DNS_AS112'
+          | 'DOS'
+          | 'EMAIL_ROUTING'
+          | 'EMAIL_SECURITY'
+          | 'FW'
+          | 'FW_PG'
+          | 'HTTP'
+          | 'HTTP_CONTROL'
+          | 'HTTP_CRAWLER_REFERER'
+          | 'HTTP_ORIGINS'
+          | 'IQI'
+          | 'LEAKED_CREDENTIALS'
+          | 'NET'
+          | 'ROBOTS_TXT'
+          | 'SPEED'
+          | 'WORKERS_AI';
+
+        description: string;
+
+        endDate: string;
+
+        /**
+         * Event type for annotations.
+         */
+        eventType: 'EVENT' | 'GENERAL' | 'OUTAGE' | 'PARTIAL_PROJECTION' | 'PIPELINE' | 'TRAFFIC_ANOMALY';
+
+        /**
+         * 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;
+
+      /**
+       * Adjusted start of date range.
+       */
+      startTime: string;
+    }
+
+    export interface Unit {
+      name: string;
+
+      value: string;
+    }
+  }
 }
 
 export interface HTTPTimeseriesResponse {
@@ -165,13 +426,44 @@ export namespace HTTPTimeseriesResponse {
        * Annotation associated with the result (e.g. outage or other type of event).
        */
       export interface Annotation {
-        dataSource: string;
+        /**
+         * Data source for annotations.
+         */
+        dataSource:
+          | 'ALL'
+          | 'AI_BOTS'
+          | 'AI_GATEWAY'
+          | 'BGP'
+          | 'BOTS'
+          | 'CONNECTION_ANOMALY'
+          | 'CT'
+          | 'DNS'
+          | 'DNS_MAGNITUDE'
+          | 'DNS_AS112'
+          | 'DOS'
+          | 'EMAIL_ROUTING'
+          | 'EMAIL_SECURITY'
+          | 'FW'
+          | 'FW_PG'
+          | 'HTTP'
+          | 'HTTP_CONTROL'
+          | 'HTTP_CRAWLER_REFERER'
+          | 'HTTP_ORIGINS'
+          | 'IQI'
+          | 'LEAKED_CREDENTIALS'
+          | 'NET'
+          | 'ROBOTS_TXT'
+          | 'SPEED'
+          | 'WORKERS_AI';
 
         description: string;
 
         endDate: string;
 
-        eventType: string;
+        /**
+         * Event type for annotations.
+         */
+        eventType: 'EVENT' | 'GENERAL' | 'OUTAGE' | 'PARTIAL_PROJECTION' | 'PIPELINE' | 'TRAFFIC_ANOMALY';
 
         /**
          * Whether event is a single point in time or a time range.
@@ -210,6 +502,249 @@ export namespace HTTPTimeseriesResponse {
   }
 }
 
+export interface HTTPTimeseriesGroupsV2Response {
+  /**
+   * Metadata for the results.
+   */
+  meta: HTTPTimeseriesGroupsV2Response.Meta;
+
+  serie_0: HTTPTimeseriesGroupsV2Response.Serie0;
+}
+
+export namespace HTTPTimeseriesGroupsV2Response {
+  /**
+   * Metadata for the results.
+   */
+  export interface Meta {
+    /**
+     * 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>;
+  }
+
+  export namespace Meta {
+    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 {
+        /**
+         * Data source for annotations.
+         */
+        dataSource:
+          | 'ALL'
+          | 'AI_BOTS'
+          | 'AI_GATEWAY'
+          | 'BGP'
+          | 'BOTS'
+          | 'CONNECTION_ANOMALY'
+          | 'CT'
+          | 'DNS'
+          | 'DNS_MAGNITUDE'
+          | 'DNS_AS112'
+          | 'DOS'
+          | 'EMAIL_ROUTING'
+          | 'EMAIL_SECURITY'
+          | 'FW'
+          | 'FW_PG'
+          | 'HTTP'
+          | 'HTTP_CONTROL'
+          | 'HTTP_CRAWLER_REFERER'
+          | 'HTTP_ORIGINS'
+          | 'IQI'
+          | 'LEAKED_CREDENTIALS'
+          | 'NET'
+          | 'ROBOTS_TXT'
+          | 'SPEED'
+          | 'WORKERS_AI';
+
+        description: string;
+
+        endDate: string;
+
+        /**
+         * Event type for annotations.
+         */
+        eventType: 'EVENT' | 'GENERAL' | 'OUTAGE' | 'PARTIAL_PROJECTION' | 'PIPELINE' | 'TRAFFIC_ANOMALY';
+
+        /**
+         * 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;
+
+      /**
+       * Adjusted start of date range.
+       */
+      startTime: string;
+    }
+
+    export interface Unit {
+      name: string;
+
+      value: string;
+    }
+  }
+
+  export interface Serie0 {
+    timestamps: Array<string>;
+
+    [k: string]: Array<string> | Array<string> | undefined;
+  }
+}
+
+export interface HTTPSummaryV2Params {
+  /**
+   * Filters results by Autonomous System. Specify one or more Autonomous System
+   * Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
+   * results. For example, `-174, 3356` excludes results from AS174, but includes
+   * results from AS3356.
+   */
+  asn?: Array<string>;
+
+  /**
+   * Filters results by bot class. Refer to
+   * [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
+   */
+  botClass?: Array<'LIKELY_AUTOMATED' | 'LIKELY_HUMAN'>;
+
+  /**
+   * Filters results by continent. Specify a comma-separated list of alpha-2 codes.
+   * Prefix with `-` to exclude continents from results. For example, `-EU,NA`
+   * excludes results from EU, but includes results from NA.
+   */
+  continent?: Array<string>;
+
+  /**
+   * End of the date range (inclusive).
+   */
+  dateEnd?: Array<string>;
+
+  /**
+   * Filters results by date range. For example, use `7d` and `7dcontrol` to compare
+   * this week with the previous week. Use this parameter or set specific start and
+   * end dates (`dateStart` and `dateEnd` parameters).
+   */
+  dateRange?: Array<string>;
+
+  /**
+   * Start of the date range.
+   */
+  dateStart?: Array<string>;
+
+  /**
+   * Filters results by device type.
+   */
+  deviceType?: Array<'DESKTOP' | 'MOBILE' | 'OTHER'>;
+
+  /**
+   * Format in which results will be returned.
+   */
+  format?: 'JSON' | 'CSV';
+
+  /**
+   * Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs.
+   * Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689`
+   * excludes results from the 2267056 (Lisbon), but includes results from 5128638
+   * (New York).
+   */
+  geoId?: Array<string>;
+
+  /**
+   * Filters results by HTTP protocol (HTTP vs. HTTPS).
+   */
+  httpProtocol?: Array<'HTTP' | 'HTTPS'>;
+
+  /**
+   * Filters results by HTTP version.
+   */
+  httpVersion?: Array<'HTTPv1' | 'HTTPv2' | 'HTTPv3'>;
+
+  /**
+   * Filters results by IP version (Ipv4 vs. IPv6).
+   */
+  ipVersion?: Array<'IPv4' | 'IPv6'>;
+
+  /**
+   * Limits the number of objects per group to the top items within the specified
+   * time range. When item count exceeds the limit, extra items appear grouped under
+   * an "other" category.
+   */
+  limitPerGroup?: number;
+
+  /**
+   * Filters results by location. Specify a comma-separated list of alpha-2 codes.
+   * Prefix with `-` to exclude locations from results. For example, `-US,PT`
+   * excludes results from the US, but includes results from PT.
+   */
+  location?: Array<string>;
+
+  /**
+   * Array of names used to label the series in the response.
+   */
+  name?: Array<string>;
+
+  /**
+   * Filters results by operating system.
+   */
+  os?: Array<'WINDOWS' | 'MACOSX' | 'IOS' | 'ANDROID' | 'CHROMEOS' | 'LINUX' | 'SMART_TV'>;
+
+  /**
+   * Filters results by TLS version.
+   */
+  tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3' | 'TLSvQUIC'>;
+}
+
 export interface HTTPTimeseriesParams {
   /**
    * Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
@@ -271,6 +806,14 @@ export interface HTTPTimeseriesParams {
    */
   format?: 'JSON' | 'CSV';
 
+  /**
+   * Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs.
+   * Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689`
+   * excludes results from the 2267056 (Lisbon), but includes results from 5128638
+   * (New York).
+   */
+  geoId?: Array<string>;
+
   /**
    * Filters results by HTTP protocol (HTTP vs. HTTPS).
    */
@@ -315,6 +858,121 @@ export interface HTTPTimeseriesParams {
   tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3' | 'TLSvQUIC'>;
 }
 
+export interface HTTPTimeseriesGroupsV2Params {
+  /**
+   * 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?: '15m' | '1h' | '1d' | '1w';
+
+  /**
+   * Filters results by Autonomous System. Specify one or more Autonomous System
+   * Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
+   * results. For example, `-174, 3356` excludes results from AS174, but includes
+   * results from AS3356.
+   */
+  asn?: Array<string>;
+
+  /**
+   * Filters results by bot class. Refer to
+   * [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
+   */
+  botClass?: Array<'LIKELY_AUTOMATED' | 'LIKELY_HUMAN'>;
+
+  /**
+   * Filters results by continent. Specify a comma-separated list of alpha-2 codes.
+   * Prefix with `-` to exclude continents from results. For example, `-EU,NA`
+   * excludes results from EU, but includes results from NA.
+   */
+  continent?: Array<string>;
+
+  /**
+   * End of the date range (inclusive).
+   */
+  dateEnd?: Array<string>;
+
+  /**
+   * Filters results by date range. For example, use `7d` and `7dcontrol` to compare
+   * this week with the previous week. Use this parameter or set specific start and
+   * end dates (`dateStart` and `dateEnd` parameters).
+   */
+  dateRange?: Array<string>;
+
+  /**
+   * Start of the date range.
+   */
+  dateStart?: Array<string>;
+
+  /**
+   * Filters results by device type.
+   */
+  deviceType?: Array<'DESKTOP' | 'MOBILE' | 'OTHER'>;
+
+  /**
+   * Format in which results will be returned.
+   */
+  format?: 'JSON' | 'CSV';
+
+  /**
+   * Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs.
+   * Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689`
+   * excludes results from the 2267056 (Lisbon), but includes results from 5128638
+   * (New York).
+   */
+  geoId?: Array<string>;
+
+  /**
+   * Filters results by HTTP protocol (HTTP vs. HTTPS).
+   */
+  httpProtocol?: Array<'HTTP' | 'HTTPS'>;
+
+  /**
+   * Filters results by HTTP version.
+   */
+  httpVersion?: Array<'HTTPv1' | 'HTTPv2' | 'HTTPv3'>;
+
+  /**
+   * Filters results by IP version (Ipv4 vs. IPv6).
+   */
+  ipVersion?: Array<'IPv4' | 'IPv6'>;
+
+  /**
+   * Limits the number of objects per group to the top items within the specified
+   * time range. When item count exceeds the limit, extra items appear grouped under
+   * an "other" category.
+   */
+  limitPerGroup?: number;
+
+  /**
+   * Filters results by location. Specify a comma-separated list of alpha-2 codes.
+   * Prefix with `-` to exclude locations from results. For example, `-US,PT`
+   * excludes results from the US, but includes results from PT.
+   */
+  location?: Array<string>;
+
+  /**
+   * Array of names used to label the series in the response.
+   */
+  name?: Array<string>;
+
+  /**
+   * Normalization method applied to the results. Refer to
+   * [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
+   */
+  normalization?: 'PERCENTAGE' | 'MIN0_MAX';
+
+  /**
+   * Filters results by operating system.
+   */
+  os?: Array<'WINDOWS' | 'MACOSX' | 'IOS' | 'ANDROID' | 'CHROMEOS' | 'LINUX' | 'SMART_TV'>;
+
+  /**
+   * Filters results by TLS version.
+   */
+  tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3' | 'TLSvQUIC'>;
+}
+
 HTTP.Locations = Locations;
 HTTP.Ases = Ases;
 HTTP.Summary = Summary;
@@ -323,8 +981,12 @@ HTTP.Top = Top;
 
 export declare namespace HTTP {
   export {
+    type HTTPSummaryV2Response as HTTPSummaryV2Response,
     type HTTPTimeseriesResponse as HTTPTimeseriesResponse,
+    type HTTPTimeseriesGroupsV2Response as HTTPTimeseriesGroupsV2Response,
+    type HTTPSummaryV2Params as HTTPSummaryV2Params,
     type HTTPTimeseriesParams as HTTPTimeseriesParams,
+    type HTTPTimeseriesGroupsV2Params as HTTPTimeseriesGroupsV2Params,
   };
 
   export {