cloudflare 4.1.0 → 4.2.0

package/src/resources/radar/ranking/internet-services.ts

@@ -6,7 +6,30 @@ import * as Core from '../../../core';
 
 export class InternetServices extends APIResource {
   /**
-   * Gets Internet Services rank update changes over time. Raw values are returned.
+   * Retrieves the list of Internet services categories.
+   */
+  categories(
+    query?: InternetServiceCategoriesParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<InternetServiceCategoriesResponse>;
+  categories(options?: Core.RequestOptions): Core.APIPromise<InternetServiceCategoriesResponse>;
+  categories(
+    query: InternetServiceCategoriesParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<InternetServiceCategoriesResponse> {
+    if (isRequestOptions(query)) {
+      return this.categories({}, query);
+    }
+    return (
+      this._client.get('/radar/ranking/internet_services/categories', {
+        query,
+        ...options,
+      }) as Core.APIPromise<{ result: InternetServiceCategoriesResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Retrieves Internet Services rank update changes over time.
    */
   timeseriesGroups(
     query?: InternetServiceTimeseriesGroupsParams,
@@ -29,7 +52,7 @@ export class InternetServices extends APIResource {
   }
 
   /**
-   * Get top Internet services based on their rank.
+   * Retrieves top Internet services based on their rank.
    */
   top(
     query?: InternetServiceTopParams,
@@ -51,6 +74,16 @@ export class InternetServices extends APIResource {
   }
 }
 
+export interface InternetServiceCategoriesResponse {
+  categories_0: Array<InternetServiceCategoriesResponse.Categories0>;
+}
+
+export namespace InternetServiceCategoriesResponse {
+  export interface Categories0 {
+    name: string;
+  }
+}
+
 export interface InternetServiceTimeseriesGroupsResponse {
   meta: InternetServiceTimeseriesGroupsResponse.Meta;
 
@@ -108,6 +141,28 @@ export namespace InternetServiceTopResponse {
   }
 }
 
+export interface InternetServiceCategoriesParams {
+  /**
+   * Array of dates to filter the results.
+   */
+  date?: Array<string>;
+
+  /**
+   * 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<string>;
+}
+
 export interface InternetServiceTimeseriesGroupsParams {
   /**
    * End of the date range (inclusive).
@@ -115,69 +170,71 @@ export interface InternetServiceTimeseriesGroupsParams {
   dateEnd?: Array<string>;
 
   /**
-   * 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).
+   * 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<string>;
 
   /**
-   * Array of datetimes to filter the start of a series.
+   * Start of the date range.
    */
   dateStart?: Array<string>;
 
   /**
-   * Format results are returned in.
+   * Format in which results will be returned.
    */
   format?: 'JSON' | 'CSV';
 
   /**
-   * Limit the number of objects in the response.
+   * Limits the number of objects returned in the response.
    */
   limit?: number;
 
   /**
-   * Array of names that will be used to name the series in responses.
+   * Array of names used to label the series in the response.
    */
   name?: Array<string>;
 
   /**
-   * Filter for services category.
+   * Filters results by Internet service category.
    */
   serviceCategory?: Array<string>;
 }
 
 export interface InternetServiceTopParams {
   /**
-   * Array of dates to filter the ranking.
+   * Array of dates to filter the results.
    */
   date?: Array<string>;
 
   /**
-   * Format results are returned in.
+   * Format in which results will be returned.
    */
   format?: 'JSON' | 'CSV';
 
   /**
-   * Limit the number of objects in the response.
+   * Limits the number of objects returned in the response.
    */
   limit?: number;
 
   /**
-   * Array of names that will be used to name the series in responses.
+   * Array of names used to label the series in the response.
    */
   name?: Array<string>;
 
   /**
-   * Filter for services category.
+   * Filters results by Internet service category.
    */
   serviceCategory?: Array<string>;
 }
 
 export declare namespace InternetServices {
   export {
+    type InternetServiceCategoriesResponse as InternetServiceCategoriesResponse,
     type InternetServiceTimeseriesGroupsResponse as InternetServiceTimeseriesGroupsResponse,
     type InternetServiceTopResponse as InternetServiceTopResponse,
+    type InternetServiceCategoriesParams as InternetServiceCategoriesParams,
     type InternetServiceTimeseriesGroupsParams as InternetServiceTimeseriesGroupsParams,
     type InternetServiceTopParams as InternetServiceTopParams,
   };

package/src/resources/radar/ranking/ranking.ts

@@ -7,6 +7,8 @@ import * as DomainAPI from './domain';
 import { Domain, DomainGetParams, DomainGetResponse } from './domain';
 import * as InternetServicesAPI from './internet-services';
 import {
+  InternetServiceCategoriesParams,
+  InternetServiceCategoriesResponse,
   InternetServiceTimeseriesGroupsParams,
   InternetServiceTimeseriesGroupsResponse,
   InternetServiceTopParams,
@@ -21,7 +23,7 @@ export class Ranking extends APIResource {
   );
 
   /**
-   * Gets Domains Rank updates change over time. Raw values are returned.
+   * Retrieves domains rank over time.
    */
   timeseriesGroups(
     query?: RankingTimeseriesGroupsParams,
@@ -43,10 +45,10 @@ export class Ranking extends APIResource {
   }
 
   /**
-   * Get top or trending domains based on their rank. Popular domains are domains of
-   * broad appeal based on how people use the Internet. Trending domains are domains
-   * that are generating a surge in interest. For more information on top domains,
-   * see https://blog.cloudflare.com/radar-domain-rankings/.
+   * Retrieves the top or trending domains based on their rank. Popular domains are
+   * domains of broad appeal based on how people use the Internet. Trending domains
+   * are domains that are generating a surge in interest. For more information on top
+   * domains, see https://blog.cloudflare.com/radar-domain-rankings/.
    */
   top(query?: RankingTopParams, options?: Core.RequestOptions): Core.APIPromise<RankingTopResponse>;
   top(options?: Core.RequestOptions): Core.APIPromise<RankingTopResponse>;
@@ -144,76 +146,86 @@ export interface RankingTimeseriesGroupsParams {
   dateEnd?: Array<string>;
 
   /**
-   * 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).
+   * 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<string>;
 
   /**
-   * Array of datetimes to filter the start of a series.
+   * Start of the date range.
    */
   dateStart?: Array<string>;
 
   /**
-   * Array of comma separated list of domains names.
+   * Filters results by domain category.
+   */
+  domainCategory?: Array<string>;
+
+  /**
+   * Comma-separated list of domain names.
    */
   domains?: Array<string>;
 
   /**
-   * Format results are returned in.
+   * Format in which results will be returned.
    */
   format?: 'JSON' | 'CSV';
 
   /**
-   * Limit the number of objects in the response.
+   * Limits the number of objects returned in the response.
    */
   limit?: number;
 
   /**
-   * Array of locations (alpha-2 country codes).
+   * Comma-separated list of locations (alpha-2 codes).
    */
   location?: Array<string>;
 
   /**
-   * Array of names that will be used to name the series in responses.
+   * Array of names used to label the series in the response.
    */
   name?: Array<string>;
 
   /**
-   * The ranking type.
+   * Ranking type.
    */
   rankingType?: 'POPULAR' | 'TRENDING_RISE' | 'TRENDING_STEADY';
 }
 
 export interface RankingTopParams {
   /**
-   * Array of dates to filter the ranking.
+   * Array of dates to filter the results.
    */
   date?: Array<string>;
 
   /**
-   * Format results are returned in.
+   * Filters results by domain category.
+   */
+  domainCategory?: Array<string>;
+
+  /**
+   * Format in which results will be returned.
    */
   format?: 'JSON' | 'CSV';
 
   /**
-   * Limit the number of objects in the response.
+   * Limits the number of objects returned in the response.
    */
   limit?: number;
 
   /**
-   * Array of locations (alpha-2 country codes).
+   * Comma-separated list of locations (alpha-2 codes).
    */
   location?: Array<string>;
 
   /**
-   * Array of names that will be used to name the series in responses.
+   * Array of names used to label the series in the response.
    */
   name?: Array<string>;
 
   /**
-   * The ranking type.
+   * Ranking type.
    */
   rankingType?: 'POPULAR' | 'TRENDING_RISE' | 'TRENDING_STEADY';
 }
@@ -237,8 +249,10 @@ export declare namespace Ranking {
 
   export {
     InternetServices as InternetServices,
+    type InternetServiceCategoriesResponse as InternetServiceCategoriesResponse,
     type InternetServiceTimeseriesGroupsResponse as InternetServiceTimeseriesGroupsResponse,
     type InternetServiceTopResponse as InternetServiceTopResponse,
+    type InternetServiceCategoriesParams as InternetServiceCategoriesParams,
     type InternetServiceTimeseriesGroupsParams as InternetServiceTimeseriesGroupsParams,
     type InternetServiceTopParams as InternetServiceTopParams,
   };

package/src/resources/radar/ranking.ts

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

package/src/resources/radar/robots-txt/top/top.ts

@@ -10,7 +10,7 @@ export class Top extends APIResource {
   userAgents: UserAgentsAPI.UserAgents = new UserAgentsAPI.UserAgents(this._client);
 
   /**
-   * Get the top domain categories by the number of robots.txt files parsed.
+   * Retrieves the top domain categories by the number of robots.txt files parsed.
    */
   domainCategories(
     query?: TopDomainCategoriesParams,
@@ -104,27 +104,27 @@ export namespace TopDomainCategoriesResponse {
 
 export interface TopDomainCategoriesParams {
   /**
-   * Array of dates to filter the ranking.
+   * Array of dates to filter the results.
    */
   date?: Array<string>;
 
   /**
-   * Format results are returned in.
+   * Format in which results will be returned.
    */
   format?: 'JSON' | 'CSV';
 
   /**
-   * Limit the number of objects in the response.
+   * Limits the number of objects returned in the response.
    */
   limit?: number;
 
   /**
-   * Array of names that will be used to name the series in responses.
+   * Array of names used to label the series in the response.
    */
   name?: Array<string>;
 
   /**
-   * Filter by user agent category.
+   * Filters results by user agent category.
    */
   userAgentCategory?: 'AI';
 }

package/src/resources/radar/robots-txt/top/user-agents.ts

@@ -6,7 +6,7 @@ import * as Core from '../../../../core';
 
 export class UserAgents extends APIResource {
   /**
-   * Get the top user agents on robots.txt files by directive.
+   * Retrieves the top user agents on robots.txt files.
    */
   directive(
     query?: UserAgentDirectiveParams,
@@ -105,37 +105,37 @@ export namespace UserAgentDirectiveResponse {
 
 export interface UserAgentDirectiveParams {
   /**
-   * Array of dates to filter the ranking.
+   * Array of dates to filter the results.
    */
   date?: Array<string>;
 
   /**
-   * Filter by directive.
+   * Filters results by robots.txt directive.
    */
   directive?: 'ALLOW' | 'DISALLOW';
 
   /**
-   * Filter by domain category.
+   * Filters results by domain category.
    */
   domainCategory?: Array<string>;
 
   /**
-   * Format results are returned in.
+   * Format in which results will be returned.
    */
   format?: 'JSON' | 'CSV';
 
   /**
-   * Limit the number of objects in the response.
+   * Limits the number of objects returned in the response.
    */
   limit?: number;
 
   /**
-   * Array of names that will be used to name the series in responses.
+   * Array of names used to label the series in the response.
    */
   name?: Array<string>;
 
   /**
-   * Filter by user agent category.
+   * Filters results by user agent category.
    */
   userAgentCategory?: 'AI';
 }

package/src/resources/radar/robots-txt/top.ts

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

package/src/resources/radar/robots-txt.ts

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

package/src/resources/radar/search.ts

@@ -5,7 +5,7 @@ import * as Core from '../../core';
 
 export class Search extends APIResource {
   /**
-   * Lets you search for locations, autonomous systems (ASes), and reports.
+   * Searches for locations, autonomous systems, and reports.
    */
   global(query: SearchGlobalParams, options?: Core.RequestOptions): Core.APIPromise<SearchGlobalResponse> {
     return (
@@ -32,7 +32,7 @@ export namespace SearchGlobalResponse {
 
 export interface SearchGlobalParams {
   /**
-   * Search for locations, AS and reports.
+   * Search for locations, autonomous systems and reports.
    */
   query: string;
 
@@ -42,7 +42,7 @@ export interface SearchGlobalParams {
   exclude?: Array<'SPECIAL_EVENTS' | 'NOTEBOOKS' | 'LOCATIONS' | 'ASNS'>;
 
   /**
-   * Format results are returned in.
+   * Format in which results will be returned.
    */
   format?: 'JSON' | 'CSV';
 
@@ -52,7 +52,7 @@ export interface SearchGlobalParams {
   include?: Array<'SPECIAL_EVENTS' | 'NOTEBOOKS' | 'LOCATIONS' | 'ASNS'>;
 
   /**
-   * Limit the number of objects in the response.
+   * Limits the number of objects returned in the response.
    */
   limit?: number;
 

package/src/resources/radar/tcp-resets-timeouts.ts

@@ -6,8 +6,8 @@ import * as Core from '../../core';
 
 export class TCPResetsTimeouts extends APIResource {
   /**
-   * Percentage distribution by connection stage of TCP connections terminated within
-   * the first 10 packets by a reset or timeout, for a given time period.
+   * Retrieves the distribution of connection stage by TCP connections terminated
+   * within the first 10 packets by a reset or timeout.
    */
   summary(
     query?: TCPResetsTimeoutSummaryParams,
@@ -29,8 +29,8 @@ export class TCPResetsTimeouts extends APIResource {
   }
 
   /**
-   * Percentage distribution by connection stage of TCP connections terminated within
-   * the first 10 packets by a reset or timeout, over time.
+   * Retrieves the distribution of connection stage by TCP connections terminated
+   * within the first 10 packets by a reset or timeout over time.
    */
   timeseriesGroups(
     query?: TCPResetsTimeoutTimeseriesGroupsParams,
@@ -208,16 +208,16 @@ export namespace TCPResetsTimeoutTimeseriesGroupsResponse {
 
 export interface TCPResetsTimeoutSummaryParams {
   /**
-   * Array of comma separated list of ASNs, start with `-` to exclude from results.
-   * For example, `-174, 3356` excludes results from AS174, but includes results from
-   * AS3356.
+   * 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<string>;
 
   /**
-   * Array of comma separated list of continents (alpha-2 continent codes). Start
-   * with `-` to exclude from results. For example, `-EU,NA` excludes results from
-   * Europe, but includes results from North America.
+   * Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to
+   * exclude continents from results. For example, `-EU,NA` excludes results from EU,
+   * but includes results from NA.
    */
   continent?: Array<string>;
 
@@ -227,31 +227,31 @@ export interface TCPResetsTimeoutSummaryParams {
   dateEnd?: Array<string>;
 
   /**
-   * 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).
+   * 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<string>;
 
   /**
-   * Array of datetimes to filter the start of a series.
+   * Start of the date range.
    */
   dateStart?: Array<string>;
 
   /**
-   * Format results are returned in.
+   * Format in which results will be returned.
    */
   format?: 'JSON' | 'CSV';
 
   /**
-   * Array of comma separated list of locations (alpha-2 country codes). Start with
-   * `-` to exclude from results. For example, `-US,PT` excludes results from the US,
-   * but includes results from PT.
+   * Comma-separated list of locations (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 that will be used to name the series in responses.
+   * Array of names used to label the series in the response.
    */
   name?: Array<string>;
 }
@@ -265,16 +265,16 @@ export interface TCPResetsTimeoutTimeseriesGroupsParams {
   aggInterval?: '15m' | '1h' | '1d' | '1w';
 
   /**
-   * Array of comma separated list of ASNs, start with `-` to exclude from results.
-   * For example, `-174, 3356` excludes results from AS174, but includes results from
-   * AS3356.
+   * 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<string>;
 
   /**
-   * Array of comma separated list of continents (alpha-2 continent codes). Start
-   * with `-` to exclude from results. For example, `-EU,NA` excludes results from
-   * Europe, but includes results from North America.
+   * Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to
+   * exclude continents from results. For example, `-EU,NA` excludes results from EU,
+   * but includes results from NA.
    */
   continent?: Array<string>;
 
@@ -284,31 +284,31 @@ export interface TCPResetsTimeoutTimeseriesGroupsParams {
   dateEnd?: Array<string>;
 
   /**
-   * 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).
+   * 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<string>;
 
   /**
-   * Array of datetimes to filter the start of a series.
+   * Start of the date range.
    */
   dateStart?: Array<string>;
 
   /**
-   * Format results are returned in.
+   * Format in which results will be returned.
    */
   format?: 'JSON' | 'CSV';
 
   /**
-   * Array of comma separated list of locations (alpha-2 country codes). Start with
-   * `-` to exclude from results. For example, `-US,PT` excludes results from the US,
-   * but includes results from PT.
+   * Comma-separated list of locations (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 that will be used to name the series in responses.
+   * Array of names used to label the series in the response.
    */
   name?: Array<string>;
 }

package/src/resources/radar/traffic-anomalies/locations.ts

@@ -6,9 +6,9 @@ import * as Core from '../../../core';
 
 export class Locations extends APIResource {
   /**
-   * Internet traffic anomalies are signals that might point to an outage. These
-   * alerts are automatically detected by Radar and then manually verified by our
-   * team. This endpoint returns the sum of alerts grouped by location.
+   * Retrieves the sum of Internet traffic anomalies, grouped by location. These
+   * anomalies are signals that might indicate an outage, automatically detected by
+   * Radar and manually verified by our team.
    */
   get(query?: LocationGetParams, options?: Core.RequestOptions): Core.APIPromise<LocationGetResponse>;
   get(options?: Core.RequestOptions): Core.APIPromise<LocationGetResponse>;
@@ -59,12 +59,12 @@ export interface LocationGetParams {
   dateStart?: string;
 
   /**
-   * Format results are returned in.
+   * Format in which results will be returned.
    */
   format?: 'JSON' | 'CSV';
 
   /**
-   * Limit the number of objects in the response.
+   * Limits the number of objects returned in the response.
    */
   limit?: number;