cloudflare 4.5.0 → 5.1.0

package/src/resources/radar/ai/timeseries-groups.ts

@@ -6,14 +6,111 @@ import * as Core from '../../../core';
 
 export class TimeseriesGroups extends APIResource {
   /**
-   * Retrieves the distribution of traffic by AI user agent over time.
+   * Retrieves an aggregated summary of AI bots HTTP requests grouped by the
+   * specified dimension.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.radar.ai.timeseriesGroups.summary(
+   *     'USER_AGENT',
+   *   );
+   * ```
+   */
+  summary(
+    dimension: 'USER_AGENT' | 'CRAWL_PURPOSE' | 'INDUSTRY' | 'VERTICAL',
+    query?: TimeseriesGroupSummaryParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TimeseriesGroupSummaryResponse>;
+  summary(
+    dimension: 'USER_AGENT' | 'CRAWL_PURPOSE' | 'INDUSTRY' | 'VERTICAL',
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TimeseriesGroupSummaryResponse>;
+  summary(
+    dimension: 'USER_AGENT' | 'CRAWL_PURPOSE' | 'INDUSTRY' | 'VERTICAL',
+    query: TimeseriesGroupSummaryParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TimeseriesGroupSummaryResponse> {
+    if (isRequestOptions(query)) {
+      return this.summary(dimension, {}, query);
+    }
+    return (
+      this._client.get(`/radar/ai/bots/summary/${dimension}`, { query, ...options }) as Core.APIPromise<{
+        result: TimeseriesGroupSummaryResponse;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Retrieves AI bots HTTP request volume over time.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.radar.ai.timeseriesGroups.timeseries();
+   * ```
+   */
+  timeseries(
+    query?: TimeseriesGroupTimeseriesParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TimeseriesGroupTimeseriesResponse>;
+  timeseries(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupTimeseriesResponse>;
+  timeseries(
+    query: TimeseriesGroupTimeseriesParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TimeseriesGroupTimeseriesResponse> {
+    if (isRequestOptions(query)) {
+      return this.timeseries({}, query);
+    }
+    return (
+      this._client.get('/radar/ai/bots/timeseries', { query, ...options }) as Core.APIPromise<{
+        result: TimeseriesGroupTimeseriesResponse;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Retrieves the distribution of HTTP requests from AI bots, grouped by chosen the
+   * specified dimension over time.
    *
    * @example
    * ```ts
    * const response =
-   *   await client.radar.ai.timeseriesGroups.userAgent();
+   *   await client.radar.ai.timeseriesGroups.timeseriesGroups(
+   *     'USER_AGENT',
+   *   );
    * ```
    */
+  timeseriesGroups(
+    dimension: 'USER_AGENT' | 'CRAWL_PURPOSE' | 'INDUSTRY' | 'VERTICAL',
+    query?: TimeseriesGroupTimeseriesGroupsParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TimeseriesGroupTimeseriesGroupsResponse>;
+  timeseriesGroups(
+    dimension: 'USER_AGENT' | 'CRAWL_PURPOSE' | 'INDUSTRY' | 'VERTICAL',
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TimeseriesGroupTimeseriesGroupsResponse>;
+  timeseriesGroups(
+    dimension: 'USER_AGENT' | 'CRAWL_PURPOSE' | 'INDUSTRY' | 'VERTICAL',
+    query: TimeseriesGroupTimeseriesGroupsParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TimeseriesGroupTimeseriesGroupsResponse> {
+    if (isRequestOptions(query)) {
+      return this.timeseriesGroups(dimension, {}, query);
+    }
+    return (
+      this._client.get(`/radar/ai/bots/timeseries_groups/${dimension}`, {
+        query,
+        ...options,
+      }) as Core.APIPromise<{ result: TimeseriesGroupTimeseriesGroupsResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Retrieves the distribution of traffic by AI user agent over time.
+   *
+   * @deprecated
+   */
   userAgent(
     query?: TimeseriesGroupUserAgentParams,
     options?: Core.RequestOptions,
@@ -35,16 +132,226 @@ export class TimeseriesGroups extends APIResource {
   }
 }
 
-export interface TimeseriesGroupUserAgentResponse {
+export interface TimeseriesGroupSummaryResponse {
   /**
    * Metadata for the results.
    */
-  meta: TimeseriesGroupUserAgentResponse.Meta;
+  meta: TimeseriesGroupSummaryResponse.Meta;
 
-  serie_0: TimeseriesGroupUserAgentResponse.Serie0;
+  summary_0: { [key: string]: string };
 }
 
-export namespace TimeseriesGroupUserAgentResponse {
+export namespace TimeseriesGroupSummaryResponse {
+  /**
+   * 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 {
+        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;
+
+      /**
+       * Adjusted start of date range.
+       */
+      startTime: string;
+    }
+
+    export interface Unit {
+      name: string;
+
+      value: string;
+    }
+  }
+}
+
+export interface TimeseriesGroupTimeseriesResponse {
+  /**
+   * Metadata for the results.
+   */
+  meta: TimeseriesGroupTimeseriesResponse.Meta;
+
+  [k: string]:
+    | TimeseriesGroupTimeseriesResponse.unnamed_schema_ref_75bae70cf28e6bcef364b9840db3bdeb
+    | TimeseriesGroupTimeseriesResponse.Meta
+    | undefined;
+}
+
+export namespace TimeseriesGroupTimeseriesResponse {
+  /**
+   * 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 {
+        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;
+
+      /**
+       * Adjusted start of date range.
+       */
+      startTime: string;
+    }
+
+    export interface Unit {
+      name: string;
+
+      value: string;
+    }
+  }
+
+  export interface unnamed_schema_ref_75bae70cf28e6bcef364b9840db3bdeb {
+    timestamps: Array<string>;
+
+    values: Array<string>;
+  }
+}
+
+export interface TimeseriesGroupTimeseriesGroupsResponse {
+  /**
+   * Metadata for the results.
+   */
+  meta: TimeseriesGroupTimeseriesGroupsResponse.Meta;
+
+  serie_0: TimeseriesGroupTimeseriesGroupsResponse.Serie0;
+}
+
+export namespace TimeseriesGroupTimeseriesGroupsResponse {
   /**
    * Metadata for the results.
    */
@@ -145,6 +452,360 @@ export namespace TimeseriesGroupUserAgentResponse {
   }
 }
 
+export interface TimeseriesGroupUserAgentResponse {
+  /**
+   * Metadata for the results.
+   */
+  meta: TimeseriesGroupUserAgentResponse.Meta;
+
+  serie_0: TimeseriesGroupUserAgentResponse.Serie0;
+}
+
+export namespace TimeseriesGroupUserAgentResponse {
+  /**
+   * 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 {
+        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;
+
+      /**
+       * 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 TimeseriesGroupSummaryParams {
+  /**
+   * 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 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>;
+
+  /**
+   * Filters results by bot crawl purpose.
+   */
+  crawlPurpose?: 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>;
+
+  /**
+   * Format in which results will be returned.
+   */
+  format?: 'JSON' | 'CSV';
+
+  /**
+   * Filters results by industry.
+   */
+  industry?: Array<string>;
+
+  /**
+   * 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 vertical.
+   */
+  vertical?: Array<string>;
+}
+
+export interface TimeseriesGroupTimeseriesParams {
+  /**
+   * 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 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>;
+
+  /**
+   * Filters results by bot crawl purpose.
+   */
+  crawlPurpose?: 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>;
+
+  /**
+   * Format in which results will be returned.
+   */
+  format?: 'JSON' | 'CSV';
+
+  /**
+   * Filters results by industry.
+   */
+  industry?: Array<string>;
+
+  /**
+   * 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 user agent.
+   */
+  userAgent?: Array<string>;
+
+  /**
+   * Filters results by vertical.
+   */
+  vertical?: Array<string>;
+}
+
+export interface TimeseriesGroupTimeseriesGroupsParams {
+  /**
+   * 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 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>;
+
+  /**
+   * Filters results by bot crawl purpose.
+   */
+  crawlPurpose?: 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>;
+
+  /**
+   * Format in which results will be returned.
+   */
+  format?: 'JSON' | 'CSV';
+
+  /**
+   * Filters results by industry.
+   */
+  industry?: Array<string>;
+
+  /**
+   * 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_CHANGE' | 'MIN0_MAX';
+
+  /**
+   * Filters results by vertical.
+   */
+  vertical?: Array<string>;
+}
+
 export interface TimeseriesGroupUserAgentParams {
   /**
    * Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
@@ -212,7 +873,13 @@ export interface TimeseriesGroupUserAgentParams {
 
 export declare namespace TimeseriesGroups {
   export {
+    type TimeseriesGroupSummaryResponse as TimeseriesGroupSummaryResponse,
+    type TimeseriesGroupTimeseriesResponse as TimeseriesGroupTimeseriesResponse,
+    type TimeseriesGroupTimeseriesGroupsResponse as TimeseriesGroupTimeseriesGroupsResponse,
     type TimeseriesGroupUserAgentResponse as TimeseriesGroupUserAgentResponse,
+    type TimeseriesGroupSummaryParams as TimeseriesGroupSummaryParams,
+    type TimeseriesGroupTimeseriesParams as TimeseriesGroupTimeseriesParams,
+    type TimeseriesGroupTimeseriesGroupsParams as TimeseriesGroupTimeseriesGroupsParams,
     type TimeseriesGroupUserAgentParams as TimeseriesGroupUserAgentParams,
   };
 }