cloudflare 5.1.0 → 5.2.0

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

@@ -29,6 +29,35 @@ export class ASNs extends APIResource {
     )._thenUnwrap((obj) => obj.result);
   }
 
+  /**
+   * Retrieves Internet Routing Registry AS-SETs that an AS is a member of.
+   *
+   * @example
+   * ```ts
+   * const response = await client.radar.entities.asns.asSet(3);
+   * ```
+   */
+  asSet(
+    asn: number,
+    query?: ASNAsSetParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ASNAsSetResponse>;
+  asSet(asn: number, options?: Core.RequestOptions): Core.APIPromise<ASNAsSetResponse>;
+  asSet(
+    asn: number,
+    query: ASNAsSetParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ASNAsSetResponse> {
+    if (isRequestOptions(query)) {
+      return this.asSet(asn, {}, query);
+    }
+    return (
+      this._client.get(`/radar/entities/asns/${asn}/as_set`, { query, ...options }) as Core.APIPromise<{
+        result: ASNAsSetResponse;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
   /**
    * Retrieves the requested autonomous system information. (A confidence level below
    * `5` indicates a low level of confidence in the traffic data - normally this
@@ -124,6 +153,54 @@ export namespace ASNListResponse {
   }
 }
 
+export interface ASNAsSetResponse {
+  as_sets: Array<ASNAsSetResponse.AsSet>;
+
+  /**
+   * Paths from the AS-SET that include the given AS to its upstreams recursively
+   */
+  paths: Array<Array<string>>;
+}
+
+export namespace ASNAsSetResponse {
+  export interface AsSet {
+    /**
+     * The number of AS members in the AS-SET
+     */
+    as_members_count: number;
+
+    /**
+     * The number of AS-SET members in the AS-SET
+     */
+    as_set_members_count: number;
+
+    /**
+     * The number of recursive upstream AS-SETs
+     */
+    as_set_upstreams_count: number;
+
+    /**
+     * The number of unique ASNs in the AS-SETs recursive downstream
+     */
+    asn_cone_size: number;
+
+    /**
+     * The IRR sources of the AS-SET
+     */
+    irr_sources: Array<string>;
+
+    /**
+     * The name of the AS-SET
+     */
+    name: string;
+
+    /**
+     * The inferred AS number of the AS-SET
+     */
+    asn?: number;
+  }
+}
+
 export interface ASNGetResponse {
   asn: ASNGetResponse.ASN;
 }
@@ -327,6 +404,13 @@ export interface ASNListParams {
   orderBy?: 'ASN' | 'POPULATION';
 }
 
+export interface ASNAsSetParams {
+  /**
+   * Format in which results will be returned.
+   */
+  format?: 'JSON' | 'CSV';
+}
+
 export interface ASNGetParams {
   /**
    * Format in which results will be returned.
@@ -361,10 +445,12 @@ export interface ASNRelParams {
 export declare namespace ASNs {
   export {
     type ASNListResponse as ASNListResponse,
+    type ASNAsSetResponse as ASNAsSetResponse,
     type ASNGetResponse as ASNGetResponse,
     type ASNIPResponse as ASNIPResponse,
     type ASNRelResponse as ASNRelResponse,
     type ASNListParams as ASNListParams,
+    type ASNAsSetParams as ASNAsSetParams,
     type ASNGetParams as ASNGetParams,
     type ASNIPParams as ASNIPParams,
     type ASNRelParams as ASNRelParams,

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

@@ -4,6 +4,8 @@ import { APIResource } from '../../../resource';
 import * as Core from '../../../core';
 import * as ASNsAPI from './asns';
 import {
+  ASNAsSetParams,
+  ASNAsSetResponse,
   ASNGetParams,
   ASNGetResponse,
   ASNIPParams,
@@ -91,10 +93,12 @@ export declare namespace Entities {
   export {
     ASNs as ASNs,
     type ASNListResponse as ASNListResponse,
+    type ASNAsSetResponse as ASNAsSetResponse,
     type ASNGetResponse as ASNGetResponse,
     type ASNIPResponse as ASNIPResponse,
     type ASNRelResponse as ASNRelResponse,
     type ASNListParams as ASNListParams,
+    type ASNAsSetParams as ASNAsSetParams,
     type ASNGetParams as ASNGetParams,
     type ASNIPParams as ASNIPParams,
     type ASNRelParams as ASNRelParams,

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

@@ -3,10 +3,12 @@
 export {
   ASNs,
   type ASNListResponse,
+  type ASNAsSetResponse,
   type ASNGetResponse,
   type ASNIPResponse,
   type ASNRelResponse,
   type ASNListParams,
+  type ASNAsSetParams,
   type ASNGetParams,
   type ASNIPParams,
   type ASNRelParams,

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

@@ -217,6 +217,14 @@ export interface AseGetParams {
    */
   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).
    */

package/src/resources/radar/http/ases/bot-class.ts

@@ -198,6 +198,14 @@ export interface BotClassGetParams {
    */
   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).
    */

package/src/resources/radar/http/ases/browser-family.ts

@@ -198,6 +198,14 @@ export interface BrowserFamilyGetParams {
    */
   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).
    */

package/src/resources/radar/http/ases/device-type.ts

@@ -198,6 +198,14 @@ export interface DeviceTypeGetParams {
    */
   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).
    */

package/src/resources/radar/http/ases/http-method.ts

@@ -203,6 +203,14 @@ export interface HTTPMethodGetParams {
    */
   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).
    */

package/src/resources/radar/http/ases/http-protocol.ts

@@ -203,6 +203,14 @@ export interface HTTPProtocolGetParams {
    */
   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 version.
    */

package/src/resources/radar/http/ases/ip-version.ts

@@ -200,6 +200,14 @@ export interface IPVersionGetParams {
    */
   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).
    */

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

@@ -201,6 +201,14 @@ export interface OSGetParams {
    */
   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).
    */

package/src/resources/radar/http/ases/tls-version.ts

@@ -203,6 +203,14 @@ export interface TLSVersionGetParams {
    */
   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).
    */

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

@@ -271,6 +271,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).
    */

package/src/resources/radar/http/locations/bot-class.ts

@@ -198,6 +198,14 @@ export interface BotClassGetParams {
    */
   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).
    */

package/src/resources/radar/http/locations/browser-family.ts

@@ -199,6 +199,14 @@ export interface BrowserFamilyGetParams {
    */
   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).
    */

package/src/resources/radar/http/locations/device-type.ts

@@ -199,6 +199,14 @@ export interface DeviceTypeGetParams {
    */
   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).
    */

package/src/resources/radar/http/locations/http-method.ts

@@ -204,6 +204,14 @@ export interface HTTPMethodGetParams {
    */
   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).
    */

package/src/resources/radar/http/locations/http-protocol.ts

@@ -204,6 +204,14 @@ export interface HTTPProtocolGetParams {
    */
   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 version.
    */

package/src/resources/radar/http/locations/ip-version.ts

@@ -199,6 +199,14 @@ export interface IPVersionGetParams {
    */
   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).
    */

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

@@ -217,6 +217,14 @@ export interface LocationGetParams {
    */
   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).
    */

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

@@ -203,6 +203,14 @@ export interface OSGetParams {
    */
   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).
    */

package/src/resources/radar/http/locations/tls-version.ts

@@ -205,6 +205,14 @@ export interface TLSVersionGetParams {
    */
   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).
    */

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

@@ -11,10 +11,7 @@ export class Summary extends APIResource {
    * https://developers.cloudflare.com/radar/concepts/bot-classes/ for more
    * information.
    *
-   * @example
-   * ```ts
-   * const response = await client.radar.http.summary.botClass();
-   * ```
+   * @deprecated
    */
   botClass(
     query?: SummaryBotClassParams,
@@ -39,11 +36,7 @@ export class Summary extends APIResource {
    * Retrieves the distribution of HTTP requests generated by mobile, desktop, and
    * other types of devices.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.http.summary.deviceType();
-   * ```
+   * @deprecated
    */
   deviceType(
     query?: SummaryDeviceTypeParams,
@@ -67,11 +60,7 @@ export class Summary extends APIResource {
   /**
    * Retrieves the distribution of HTTP requests by HTTP protocol (HTTP vs. HTTPS).
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.http.summary.httpProtocol();
-   * ```
+   * @deprecated
    */
   httpProtocol(
     query?: SummaryHTTPProtocolParams,
@@ -95,11 +84,7 @@ export class Summary extends APIResource {
   /**
    * Retrieves the distribution of HTTP requests by HTTP version.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.http.summary.httpVersion();
-   * ```
+   * @deprecated
    */
   httpVersion(
     query?: SummaryHTTPVersionParams,
@@ -123,11 +108,7 @@ export class Summary extends APIResource {
   /**
    * Retrieves the distribution of HTTP requests by IP version.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.http.summary.ipVersion();
-   * ```
+   * @deprecated
    */
   ipVersion(
     query?: SummaryIPVersionParams,
@@ -152,10 +133,7 @@ export class Summary extends APIResource {
    * Retrieves the distribution of HTTP requests by operating system (Windows, macOS,
    * Android, iOS, and others).
    *
-   * @example
-   * ```ts
-   * const response = await client.radar.http.summary.os();
-   * ```
+   * @deprecated
    */
   os(query?: SummaryOSParams, options?: Core.RequestOptions): Core.APIPromise<SummaryOSResponse>;
   os(options?: Core.RequestOptions): Core.APIPromise<SummaryOSResponse>;
@@ -176,11 +154,7 @@ export class Summary extends APIResource {
   /**
    * Retrieves the distribution of HTTP requests by post-quantum support.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.http.summary.postQuantum();
-   * ```
+   * @deprecated
    */
   postQuantum(
     query?: SummaryPostQuantumParams,
@@ -204,11 +178,7 @@ export class Summary extends APIResource {
   /**
    * Retrieves the distribution of HTTP requests by TLS version.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.http.summary.tlsVersion();
-   * ```
+   * @deprecated
    */
   tlsVersion(
     query?: SummaryTLSVersionParams,
@@ -1175,6 +1145,14 @@ export interface SummaryBotClassParams {
    */
   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).
    */
@@ -1262,6 +1240,14 @@ export interface SummaryDeviceTypeParams {
    */
   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).
    */
@@ -1354,6 +1340,14 @@ export interface SummaryHTTPProtocolParams {
    */
   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 version.
    */
@@ -1441,6 +1435,14 @@ export interface SummaryHTTPVersionParams {
    */
   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).
    */
@@ -1528,6 +1530,14 @@ export interface SummaryIPVersionParams {
    */
   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).
    */
@@ -1615,6 +1625,14 @@ export interface SummaryOSParams {
    */
   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).
    */
@@ -1702,6 +1720,14 @@ export interface SummaryPostQuantumParams {
    */
   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).
    */
@@ -1794,6 +1820,14 @@ export interface SummaryTLSVersionParams {
    */
   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).
    */