cloudflare 4.4.0 → 4.5.0

package/src/resources/radar/bots/index.ts

@@ -0,0 +1,22 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Bots,
+  type BotListResponse,
+  type BotGetResponse,
+  type BotSummaryResponse,
+  type BotTimeseriesResponse,
+  type BotTimeseriesGroupsResponse,
+  type BotListParams,
+  type BotGetParams,
+  type BotSummaryParams,
+  type BotTimeseriesParams,
+  type BotTimeseriesGroupsParams,
+} from './bots';
+export {
+  WebCrawlers,
+  type WebCrawlerSummaryResponse,
+  type WebCrawlerTimeseriesGroupsResponse,
+  type WebCrawlerSummaryParams,
+  type WebCrawlerTimeseriesGroupsParams,
+} from './web-crawlers';

package/src/resources/radar/bots/web-crawlers.ts

@@ -0,0 +1,384 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../resource';
+import { isRequestOptions } from '../../../core';
+import * as Core from '../../../core';
+
+export class WebCrawlers extends APIResource {
+  /**
+   * Retrieves an aggregated summary of HTTP requests from crawlers, grouped by the
+   * specified dimension.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.radar.bots.webCrawlers.summary('USER_AGENT');
+   * ```
+   */
+  summary(
+    dimension: 'USER_AGENT' | 'REFERER' | 'CRAWL_REFER_RATIO',
+    query?: WebCrawlerSummaryParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<WebCrawlerSummaryResponse>;
+  summary(
+    dimension: 'USER_AGENT' | 'REFERER' | 'CRAWL_REFER_RATIO',
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<WebCrawlerSummaryResponse>;
+  summary(
+    dimension: 'USER_AGENT' | 'REFERER' | 'CRAWL_REFER_RATIO',
+    query: WebCrawlerSummaryParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<WebCrawlerSummaryResponse> {
+    if (isRequestOptions(query)) {
+      return this.summary(dimension, {}, query);
+    }
+    return (
+      this._client.get(`/radar/bots/crawlers/summary/${dimension}`, {
+        query,
+        ...options,
+      }) as Core.APIPromise<{ result: WebCrawlerSummaryResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Retrieves the distribution of HTTP requests from crawlers, grouped by chosen the
+   * specified dimension over time.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.radar.bots.webCrawlers.timeseriesGroups(
+   *     'USER_AGENT',
+   *   );
+   * ```
+   */
+  timeseriesGroups(
+    dimension: 'USER_AGENT' | 'REFERER' | 'CRAWL_REFER_RATIO',
+    query?: WebCrawlerTimeseriesGroupsParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<WebCrawlerTimeseriesGroupsResponse>;
+  timeseriesGroups(
+    dimension: 'USER_AGENT' | 'REFERER' | 'CRAWL_REFER_RATIO',
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<WebCrawlerTimeseriesGroupsResponse>;
+  timeseriesGroups(
+    dimension: 'USER_AGENT' | 'REFERER' | 'CRAWL_REFER_RATIO',
+    query: WebCrawlerTimeseriesGroupsParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<WebCrawlerTimeseriesGroupsResponse> {
+    if (isRequestOptions(query)) {
+      return this.timeseriesGroups(dimension, {}, query);
+    }
+    return (
+      this._client.get(`/radar/bots/crawlers/timeseries_groups/${dimension}`, {
+        query,
+        ...options,
+      }) as Core.APIPromise<{ result: WebCrawlerTimeseriesGroupsResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export interface WebCrawlerSummaryResponse {
+  /**
+   * Metadata for the results.
+   */
+  meta: WebCrawlerSummaryResponse.Meta;
+
+  summary_0: { [key: string]: string };
+}
+
+export namespace WebCrawlerSummaryResponse {
+  /**
+   * Metadata for the results.
+   */
+  export interface Meta {
+    confidenceInfo: Meta.ConfidenceInfo | null;
+
+    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 WebCrawlerTimeseriesGroupsResponse {
+  /**
+   * Metadata for the results.
+   */
+  meta: WebCrawlerTimeseriesGroupsResponse.Meta;
+
+  serie_0: WebCrawlerTimeseriesGroupsResponse.Serie0;
+}
+
+export namespace WebCrawlerTimeseriesGroupsResponse {
+  /**
+   * 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 WebCrawlerSummaryParams {
+  /**
+   * Filters results by bot operator.
+   */
+  botOperator?: 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';
+
+  /**
+   * 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;
+
+  /**
+   * Array of names used to label the series in the response.
+   */
+  name?: Array<string>;
+}
+
+export interface WebCrawlerTimeseriesGroupsParams {
+  /**
+   * 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 bot operator.
+   */
+  botOperator?: 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';
+
+  /**
+   * 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;
+
+  /**
+   * Array of names used to label the series in the response.
+   */
+  name?: Array<string>;
+}
+
+export declare namespace WebCrawlers {
+  export {
+    type WebCrawlerSummaryResponse as WebCrawlerSummaryResponse,
+    type WebCrawlerTimeseriesGroupsResponse as WebCrawlerTimeseriesGroupsResponse,
+    type WebCrawlerSummaryParams as WebCrawlerSummaryParams,
+    type WebCrawlerTimeseriesGroupsParams as WebCrawlerTimeseriesGroupsParams,
+  };
+}

package/src/resources/radar/bots.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './bots/index';

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

@@ -1069,7 +1069,7 @@ export interface SummaryQueryTypeResponse {
    */
   meta: SummaryQueryTypeResponse.Meta;
 
-  summary_0: Record<string, string>;
+  summary_0: { [key: string]: string };
 }
 
 export namespace SummaryQueryTypeResponse {
@@ -1166,7 +1166,7 @@ export interface SummaryResponseCodeResponse {
    */
   meta: SummaryResponseCodeResponse.Meta;
 
-  summary_0: Record<string, string>;
+  summary_0: { [key: string]: string };
 }
 
 export namespace SummaryResponseCodeResponse {

package/src/resources/radar/entities/asns.ts

@@ -118,11 +118,6 @@ export namespace ASNListResponse {
 
     aka?: string;
 
-    /**
-     * Deprecated field. Please use 'aka'.
-     */
-    nameLong?: string;
-
     orgName?: string;
 
     website?: string;
@@ -159,11 +154,6 @@ export namespace ASNGetResponse {
     website: string;
 
     aka?: string;
-
-    /**
-     * Deprecated field. Please use 'aka'.
-     */
-    nameLong?: string;
   }
 
   export namespace ASN {
@@ -232,11 +222,6 @@ export namespace ASNIPResponse {
     website: string;
 
     aka?: string;
-
-    /**
-     * Deprecated field. Please use 'aka'.
-     */
-    nameLong?: string;
   }
 
   export namespace ASN {

package/src/resources/radar/index.ts

@@ -5,6 +5,19 @@ export { AS112, type AS112TimeseriesResponse, type AS112TimeseriesParams } from
 export { Annotations, type AnnotationListResponse, type AnnotationListParams } from './annotations/index';
 export { Attacks } from './attacks/index';
 export { BGP, type BGPTimeseriesResponse, type BGPTimeseriesParams } from './bgp/index';
+export {
+  Bots,
+  type BotListResponse,
+  type BotGetResponse,
+  type BotSummaryResponse,
+  type BotTimeseriesResponse,
+  type BotTimeseriesGroupsResponse,
+  type BotListParams,
+  type BotGetParams,
+  type BotSummaryParams,
+  type BotTimeseriesParams,
+  type BotTimeseriesGroupsParams,
+} from './bots/index';
 export { DNS, type DNSTimeseriesResponse, type DNSTimeseriesParams } from './dns/index';
 export {
   Datasets,

package/src/resources/radar/radar.ts

@@ -30,6 +30,20 @@ import * as AttacksAPI from './attacks/attacks';
 import { Attacks } from './attacks/attacks';
 import * as BGPAPI from './bgp/bgp';
 import { BGP, BGPTimeseriesParams, BGPTimeseriesResponse } from './bgp/bgp';
+import * as BotsAPI from './bots/bots';
+import {
+  BotGetParams,
+  BotGetResponse,
+  BotListParams,
+  BotListResponse,
+  BotSummaryParams,
+  BotSummaryResponse,
+  BotTimeseriesGroupsParams,
+  BotTimeseriesGroupsResponse,
+  BotTimeseriesParams,
+  BotTimeseriesResponse,
+  Bots,
+} from './bots/bots';
 import * as DNSAPI from './dns/dns';
 import { DNS, DNSTimeseriesParams, DNSTimeseriesResponse } from './dns/dns';
 import * as EmailAPI from './email/email';
@@ -73,6 +87,7 @@ export class Radar extends APIResource {
   ai: AIAPI.AI = new AIAPI.AI(this._client);
   annotations: AnnotationsAPI.Annotations = new AnnotationsAPI.Annotations(this._client);
   bgp: BGPAPI.BGP = new BGPAPI.BGP(this._client);
+  bots: BotsAPI.Bots = new BotsAPI.Bots(this._client);
   datasets: DatasetsAPI.Datasets = new DatasetsAPI.Datasets(this._client);
   dns: DNSAPI.DNS = new DNSAPI.DNS(this._client);
   netflows: NetflowsAPI.Netflows = new NetflowsAPI.Netflows(this._client);
@@ -100,6 +115,7 @@ export class Radar extends APIResource {
 Radar.AI = AI;
 Radar.Annotations = Annotations;
 Radar.BGP = BGP;
+Radar.Bots = Bots;
 Radar.Datasets = Datasets;
 Radar.DNS = DNS;
 Radar.Netflows = Netflows;
@@ -132,6 +148,20 @@ export declare namespace Radar {
     type BGPTimeseriesParams as BGPTimeseriesParams,
   };
 
+  export {
+    Bots as Bots,
+    type BotListResponse as BotListResponse,
+    type BotGetResponse as BotGetResponse,
+    type BotSummaryResponse as BotSummaryResponse,
+    type BotTimeseriesResponse as BotTimeseriesResponse,
+    type BotTimeseriesGroupsResponse as BotTimeseriesGroupsResponse,
+    type BotListParams as BotListParams,
+    type BotGetParams as BotGetParams,
+    type BotSummaryParams as BotSummaryParams,
+    type BotTimeseriesParams as BotTimeseriesParams,
+    type BotTimeseriesGroupsParams as BotTimeseriesGroupsParams,
+  };
+
   export {
     Datasets as Datasets,
     type DatasetListResponse as DatasetListResponse,

package/src/resources/radar/search.ts

@@ -5,7 +5,7 @@ import * as Core from '../../core';
 
 export class Search extends APIResource {
   /**
-   * Searches for locations, autonomous systems, and reports.
+   * Searches for locations, autonomous systems, reports, and bots.
    *
    * @example
    * ```ts
@@ -46,7 +46,7 @@ export interface SearchGlobalParams {
   /**
    * Search types excluded from results.
    */
-  exclude?: Array<'ASNS' | 'LOCATIONS' | 'NOTEBOOKS' | 'SPECIAL_EVENTS'>;
+  exclude?: Array<'ASNS' | 'BOTS' | 'LOCATIONS' | 'NOTEBOOKS' | 'SPECIAL_EVENTS'>;
 
   /**
    * Format in which results will be returned.
@@ -56,7 +56,7 @@ export interface SearchGlobalParams {
   /**
    * Search types included in results.
    */
-  include?: Array<'ASNS' | 'LOCATIONS' | 'NOTEBOOKS' | 'SPECIAL_EVENTS'>;
+  include?: Array<'ASNS' | 'BOTS' | 'LOCATIONS' | 'NOTEBOOKS' | 'SPECIAL_EVENTS'>;
 
   /**
    * Limits the number of objects returned in the response.

package/src/resources/radar/verified-bots/top.ts

@@ -8,10 +8,7 @@ export class Top extends APIResource {
   /**
    * Retrieves the top verified bots by HTTP requests, with owner and category.
    *
-   * @example
-   * ```ts
-   * const response = await client.radar.verifiedBots.top.bots();
-   * ```
+   * @deprecated Use [Radar Bots API](https://developers.cloudflare.com/api/resources/radar/subresources/bots/) instead.
    */
   bots(query?: TopBotsParams, options?: Core.RequestOptions): Core.APIPromise<TopBotsResponse>;
   bots(options?: Core.RequestOptions): Core.APIPromise<TopBotsResponse>;
@@ -33,11 +30,7 @@ export class Top extends APIResource {
    * Retrieves the top verified bot categories by HTTP requests, along with their
    * corresponding percentage, over the total verified bot HTTP requests.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.verifiedBots.top.categories();
-   * ```
+   * @deprecated Use [Radar Bots API](https://developers.cloudflare.com/api/resources/radar/subresources/bots/) instead.
    */
   categories(
     query?: TopCategoriesParams,

package/src/resources/rate-limits.ts

@@ -129,8 +129,8 @@ export interface RateLimit {
   bypass?: Array<RateLimit.Bypass>;
 
   /**
-   * An informative summary of the rate limit. This value is sanitized and any tags
-   * will be removed.
+   * An informative summary of the rule. This value is sanitized and any tags will be
+   * removed.
    */
   description?: string;
 
@@ -306,8 +306,8 @@ export interface RateLimitDeleteResponse {
   bypass?: Array<RateLimitDeleteResponse.Bypass>;
 
   /**
-   * An informative summary of the rate limit. This value is sanitized and any tags
-   * will be removed.
+   * An informative summary of the rule. This value is sanitized and any tags will be
+   * removed.
    */
   description?: string;
 

package/src/resources/request-tracers/traces.ts

@@ -136,12 +136,12 @@ export interface TraceCreateParams {
   /**
    * Body param: Cookies added to tracing request
    */
-  cookies?: Record<string, string>;
+  cookies?: { [key: string]: string };
 
   /**
    * Body param: Headers added to tracing request
    */
-  headers?: Record<string, string>;
+  headers?: { [key: string]: string };
 
   /**
    * Body param: HTTP Protocol of tracing request

package/src/resources/rules/index.ts

@@ -1,13 +1,13 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export {
+  ListsListsSinglePage,
   Lists,
   type Hostname,
   type ListsList,
   type Redirect,
   type ListCreateResponse,
   type ListUpdateResponse,
-  type ListListResponse,
   type ListDeleteResponse,
   type ListGetResponse,
   type ListCreateParams,