cloudflare 6.1.0 → 6.3.0

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

@@ -0,0 +1,295 @@
+// 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';
+import * as TopAPI from './top';
+import { Top, TopAsesParams, TopAsesResponse } from './top';
+
+export class IPs extends APIResource {
+  top: TopAPI.Top = new TopAPI.Top(this._client);
+
+  /**
+   * Retrieves time series data for the announced IP space count, represented as the
+   * number of IPv4 /24s and IPv6 /48s, for a given ASN.
+   *
+   * @example
+   * ```ts
+   * const response = await client.radar.bgp.ips.timeseries();
+   * ```
+   */
+  timeseries(
+    query?: IPTimeseriesParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<IPTimeseriesResponse>;
+  timeseries(options?: Core.RequestOptions): Core.APIPromise<IPTimeseriesResponse>;
+  timeseries(
+    query: IPTimeseriesParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<IPTimeseriesResponse> {
+    if (isRequestOptions(query)) {
+      return this.timeseries({}, query);
+    }
+    return (
+      this._client.get('/radar/bgp/ips/timeseries', { query, ...options }) as Core.APIPromise<{
+        result: IPTimeseriesResponse;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export interface IPTimeseriesResponse {
+  /**
+   * Metadata for the results.
+   */
+  meta: IPTimeseriesResponse.Meta;
+
+  serie_0: IPTimeseriesResponse.Serie0;
+}
+
+export namespace IPTimeseriesResponse {
+  /**
+   * 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>;
+
+    delay?: Meta.Delay;
+  }
+
+  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 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;
+
+          timestamp: number;
+        }
+      }
+    }
+  }
+
+  export interface Serie0 {
+    ipv4: Array<string>;
+
+    ipv6: Array<string>;
+
+    timestamps: Array<string>;
+  }
+}
+
+export interface IPTimeseriesParams {
+  /**
+   * 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>;
+
+  /**
+   * 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';
+
+  /**
+   * Includes data delay meta information.
+   */
+  includeDelay?: boolean;
+
+  /**
+   * Filters results by IP version (Ipv4 vs. IPv6).
+   */
+  ipVersion?: Array<'IPv4' | 'IPv6'>;
+
+  /**
+   * Filters results by location. Specify a comma-separated list of alpha-2 location
+   * codes.
+   */
+  location?: Array<string>;
+
+  /**
+   * Array of names used to label the series in the response.
+   */
+  name?: Array<string>;
+}
+
+IPs.Top = Top;
+
+export declare namespace IPs {
+  export { type IPTimeseriesResponse as IPTimeseriesResponse, type IPTimeseriesParams as IPTimeseriesParams };
+
+  export { Top as Top, type TopAsesResponse as TopAsesResponse, type TopAsesParams as TopAsesParams };
+}

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

@@ -0,0 +1,84 @@
+// 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 Top extends APIResource {
+  /**
+   * Returns the top-N autonomous systems by announced IP space at the nearest 8-hour
+   * RIB boundary at or before the requested date. The snapped boundary is returned
+   * as `anchor_ts`.
+   *
+   * @example
+   * ```ts
+   * const response = await client.radar.bgp.ips.top.ases();
+   * ```
+   */
+  ases(query?: TopAsesParams, options?: Core.RequestOptions): Core.APIPromise<TopAsesResponse>;
+  ases(options?: Core.RequestOptions): Core.APIPromise<TopAsesResponse>;
+  ases(
+    query: TopAsesParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TopAsesResponse> {
+    if (isRequestOptions(query)) {
+      return this.ases({}, query);
+    }
+    return (
+      this._client.get('/radar/bgp/ips/top/ases', { query, ...options }) as Core.APIPromise<{
+        result: TopAsesResponse;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export interface TopAsesResponse {
+  anchorTs: string;
+
+  asns: Array<TopAsesResponse.ASN>;
+
+  country: string | null;
+
+  metric: string;
+}
+
+export namespace TopAsesResponse {
+  export interface ASN {
+    asn: number;
+
+    v4_24s: number;
+
+    v6_48s: number;
+  }
+}
+
+export interface TopAsesParams {
+  /**
+   * Optional ISO 3166-1 alpha-2 country filter. Omit for global top-N.
+   */
+  country?: string;
+
+  /**
+   * Filters results by the specified datetime (ISO 8601).
+   */
+  date?: string;
+
+  /**
+   * Format in which results will be returned.
+   */
+  format?: 'JSON' | 'CSV';
+
+  /**
+   * Limits the number of objects returned in the response.
+   */
+  limit?: number;
+
+  /**
+   * Ranking metric: IPv4 /24 count or IPv6 /48 count.
+   */
+  metric?: 'v4_24s' | 'v6_48s';
+}
+
+export declare namespace Top {
+  export { type TopAsesResponse as TopAsesResponse, type TopAsesParams as TopAsesParams };
+}

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

@@ -1,287 +1,3 @@
 // 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 IPs extends APIResource {
-  /**
-   * Retrieves time series data for the announced IP space count, represented as the
-   * number of IPv4 /24s and IPv6 /48s, for a given ASN.
-   *
-   * @example
-   * ```ts
-   * const response = await client.radar.bgp.ips.timeseries();
-   * ```
-   */
-  timeseries(
-    query?: IPTimeseriesParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<IPTimeseriesResponse>;
-  timeseries(options?: Core.RequestOptions): Core.APIPromise<IPTimeseriesResponse>;
-  timeseries(
-    query: IPTimeseriesParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<IPTimeseriesResponse> {
-    if (isRequestOptions(query)) {
-      return this.timeseries({}, query);
-    }
-    return (
-      this._client.get('/radar/bgp/ips/timeseries', { query, ...options }) as Core.APIPromise<{
-        result: IPTimeseriesResponse;
-      }>
-    )._thenUnwrap((obj) => obj.result);
-  }
-}
-
-export interface IPTimeseriesResponse {
-  /**
-   * Metadata for the results.
-   */
-  meta: IPTimeseriesResponse.Meta;
-
-  serie_0: IPTimeseriesResponse.Serie0;
-}
-
-export namespace IPTimeseriesResponse {
-  /**
-   * 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>;
-
-    delay?: Meta.Delay;
-  }
-
-  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 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;
-
-          timestamp: number;
-        }
-      }
-    }
-  }
-
-  export interface Serie0 {
-    ipv4: Array<string>;
-
-    ipv6: Array<string>;
-
-    timestamps: Array<string>;
-  }
-}
-
-export interface IPTimeseriesParams {
-  /**
-   * 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>;
-
-  /**
-   * 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';
-
-  /**
-   * Includes data delay meta information.
-   */
-  includeDelay?: boolean;
-
-  /**
-   * Filters results by IP version (Ipv4 vs. IPv6).
-   */
-  ipVersion?: Array<'IPv4' | 'IPv6'>;
-
-  /**
-   * Filters results by location. Specify a comma-separated list of alpha-2 location
-   * codes.
-   */
-  location?: Array<string>;
-
-  /**
-   * Array of names used to label the series in the response.
-   */
-  name?: Array<string>;
-}
-
-export declare namespace IPs {
-  export { type IPTimeseriesResponse as IPTimeseriesResponse, type IPTimeseriesParams as IPTimeseriesParams };
-}
+export * from './ips/index';

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

@@ -10,3 +10,4 @@ export {
   type ASPATimeseriesParams,
 } from './aspa';
 export { RPKI } from './rpki';
+export { Roas, type RoaTimeseriesResponse, type RoaTimeseriesParams } from './roas';