// 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 Ases extends APIResource { /** * Retrieves the top autonomous systems by BGP updates (announcements only). */ get(query?: AseGetParams, options?: Core.RequestOptions): Core.APIPromise; get(options?: Core.RequestOptions): Core.APIPromise; get( query: AseGetParams | Core.RequestOptions = {}, options?: Core.RequestOptions, ): Core.APIPromise { if (isRequestOptions(query)) { return this.get({}, query); } return ( this._client.get('/radar/bgp/top/ases', { query, ...options }) as Core.APIPromise<{ result: AseGetResponse; }> )._thenUnwrap((obj) => obj.result); } /** * Retrieves the full list of autonomous systems on the global routing table * ordered by announced prefixes count. The data comes from public BGP MRT data * archives and updates every 2 hours. */ prefixes(query?: AsePrefixesParams, options?: Core.RequestOptions): Core.APIPromise; prefixes(options?: Core.RequestOptions): Core.APIPromise; prefixes( query: AsePrefixesParams | Core.RequestOptions = {}, options?: Core.RequestOptions, ): Core.APIPromise { if (isRequestOptions(query)) { return this.prefixes({}, query); } return ( this._client.get('/radar/bgp/top/ases/prefixes', { query, ...options }) as Core.APIPromise<{ result: AsePrefixesResponse; }> )._thenUnwrap((obj) => obj.result); } } export interface AseGetResponse { meta: AseGetResponse.Meta; top_0: Array; } export namespace AseGetResponse { export interface Meta { dateRange: Array; } export namespace Meta { export interface DateRange { /** * Adjusted end of date range. */ endTime: string; /** * Adjusted start of date range. */ startTime: string; } } export interface Top0 { asn: number; ASName: string; /** * Percentage of updates by this AS out of the total updates by all autonomous * systems. */ value: string; } } export interface AsePrefixesResponse { asns: Array; meta: AsePrefixesResponse.Meta; } export namespace AsePrefixesResponse { export interface ASN { asn: number; country: string; name: string; pfxs_count: number; } export interface Meta { data_time: string; query_time: string; total_peers: number; } } export interface AseGetParams { /** * Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to * exclude ASNs from results. For example, `-174, 3356` excludes results from * AS174, but includes results from AS3356. */ asn?: Array; /** * End of the date range (inclusive). */ dateEnd?: Array; /** * Filters results by the specified 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; /** * Start of the date range. */ dateStart?: Array; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Limits the number of objects returned in the response. */ limit?: number; /** * Array of names used to label the series in the response. */ name?: Array; /** * Array of BGP network prefixes. */ prefix?: Array; /** * Array of BGP update types. */ updateType?: Array<'ANNOUNCEMENT' | 'WITHDRAWAL'>; } export interface AsePrefixesParams { /** * Alpha-2 country code. */ country?: string; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Maximum number of ASes to return. */ limit?: number; } export declare namespace Ases { export { type AseGetResponse as AseGetResponse, type AsePrefixesResponse as AsePrefixesResponse, type AseGetParams as AseGetParams, type AsePrefixesParams as AsePrefixesParams, }; }