cloudflare 5.0.0 → 5.2.0

package/src/resources/radar/http/timeseries-groups.ts

@@ -10,11 +10,7 @@ export class TimeseriesGroups extends APIResource {
    * over time. Visit https://developers.cloudflare.com/radar/concepts/bot-classes/
    * for more information.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.http.timeseriesGroups.botClass();
-   * ```
+   * @deprecated
    */
   botClass(
     query?: TimeseriesGroupBotClassParams,
@@ -38,11 +34,7 @@ export class TimeseriesGroups extends APIResource {
   /**
    * Retrieves the distribution of HTTP requests by user agent over time.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.http.timeseriesGroups.browser();
-   * ```
+   * @deprecated
    */
   browser(
     query?: TimeseriesGroupBrowserParams,
@@ -66,11 +58,7 @@ export class TimeseriesGroups extends APIResource {
   /**
    * Retrieves the distribution of HTTP requests by user agent family over time.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.http.timeseriesGroups.browserFamily();
-   * ```
+   * @deprecated
    */
   browserFamily(
     query?: TimeseriesGroupBrowserFamilyParams,
@@ -95,11 +83,7 @@ export class TimeseriesGroups extends APIResource {
   /**
    * Retrieves the distribution of HTTP requests by device type over time.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.http.timeseriesGroups.deviceType();
-   * ```
+   * @deprecated
    */
   deviceType(
     query?: TimeseriesGroupDeviceTypeParams,
@@ -125,11 +109,7 @@ export class TimeseriesGroups extends APIResource {
    * Retrieves the distribution of HTTP requests by HTTP protocol (HTTP vs. HTTPS)
    * over time.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.http.timeseriesGroups.httpProtocol();
-   * ```
+   * @deprecated
    */
   httpProtocol(
     query?: TimeseriesGroupHTTPProtocolParams,
@@ -154,11 +134,7 @@ export class TimeseriesGroups extends APIResource {
   /**
    * Retrieves the distribution of HTTP requests by HTTP version over time.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.http.timeseriesGroups.httpVersion();
-   * ```
+   * @deprecated
    */
   httpVersion(
     query?: TimeseriesGroupHTTPVersionParams,
@@ -183,11 +159,7 @@ export class TimeseriesGroups extends APIResource {
   /**
    * Retrieves the distribution of HTTP requests by IP version over time.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.http.timeseriesGroups.ipVersion();
-   * ```
+   * @deprecated
    */
   ipVersion(
     query?: TimeseriesGroupIPVersionParams,
@@ -211,11 +183,7 @@ export class TimeseriesGroups extends APIResource {
   /**
    * Retrieves the distribution of HTTP requests by operating system over time.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.http.timeseriesGroups.os();
-   * ```
+   * @deprecated
    */
   os(
     query?: TimeseriesGroupOSParams,
@@ -239,11 +207,7 @@ export class TimeseriesGroups extends APIResource {
   /**
    * Retrieves the distribution of HTTP requests by post-quantum support over time.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.http.timeseriesGroups.postQuantum();
-   * ```
+   * @deprecated
    */
   postQuantum(
     query?: TimeseriesGroupPostQuantumParams,
@@ -268,11 +232,7 @@ export class TimeseriesGroups extends APIResource {
   /**
    * Retrieves the distribution of HTTP requests by TLS version over time.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.http.timeseriesGroups.tlsVersion();
-   * ```
+   * @deprecated
    */
   tlsVersion(
     query?: TimeseriesGroupTLSVersionParams,
@@ -1474,6 +1434,14 @@ export interface TimeseriesGroupBotClassParams {
    */
   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).
    */
@@ -1573,6 +1541,14 @@ export interface TimeseriesGroupBrowserParams {
    */
   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).
    */
@@ -1674,6 +1650,14 @@ export interface TimeseriesGroupBrowserFamilyParams {
    */
   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).
    */
@@ -1775,6 +1759,14 @@ export interface TimeseriesGroupDeviceTypeParams {
    */
   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).
    */
@@ -1874,6 +1866,14 @@ export interface TimeseriesGroupHTTPProtocolParams {
    */
   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.
    */
@@ -1968,6 +1968,14 @@ export interface TimeseriesGroupHTTPVersionParams {
    */
   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).
    */
@@ -2062,6 +2070,14 @@ export interface TimeseriesGroupIPVersionParams {
    */
   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).
    */
@@ -2156,6 +2172,14 @@ export interface TimeseriesGroupOSParams {
    */
   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).
    */
@@ -2250,6 +2274,14 @@ export interface TimeseriesGroupPostQuantumParams {
    */
   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).
    */
@@ -2349,6 +2381,14 @@ export interface TimeseriesGroupTLSVersionParams {
    */
   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/top.ts

@@ -318,6 +318,14 @@ export interface TopBrowserParams {
    */
   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).
    */
@@ -410,6 +418,14 @@ export interface TopBrowserFamilyParams {
    */
   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/leaked-credentials/summary.ts

@@ -8,11 +8,7 @@ export class Summary extends APIResource {
   /**
    * Retrieves the distribution of HTTP authentication requests by bot class.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.leakedCredentials.summary.botClass();
-   * ```
+   * @deprecated
    */
   botClass(
     query?: SummaryBotClassParams,
@@ -38,11 +34,7 @@ export class Summary extends APIResource {
    * Retrieves the distribution of HTTP authentication requests by compromised
    * credential status.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.leakedCredentials.summary.compromised();
-   * ```
+   * @deprecated
    */
   compromised(
     query?: SummaryCompromisedParams,

package/src/resources/radar/leaked-credentials/timeseries-groups.ts

@@ -9,11 +9,7 @@ export class TimeseriesGroups extends APIResource {
    * Retrieves the distribution of HTTP authentication requests by bot class over
    * time.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.leakedCredentials.timeseriesGroups.botClass();
-   * ```
+   * @deprecated
    */
   botClass(
     query?: TimeseriesGroupBotClassParams,
@@ -39,11 +35,7 @@ export class TimeseriesGroups extends APIResource {
    * Retrieves the distribution of HTTP authentication requests by compromised
    * credential status over time.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.radar.leakedCredentials.timeseriesGroups.compromised();
-   * ```
+   * @deprecated
    */
   compromised(
     query?: TimeseriesGroupCompromisedParams,

package/src/resources/radar/netflows/netflows.ts

@@ -13,10 +13,7 @@ export class Netflows extends APIResource {
    * Retrieves the distribution of network traffic (NetFlows) by HTTP vs other
    * protocols.
    *
-   * @example
-   * ```ts
-   * const response = await client.radar.netflows.summary();
-   * ```
+   * @deprecated
    */
   summary(
     query?: NetflowSummaryParams,
@@ -322,6 +319,14 @@ export interface NetflowSummaryParams {
    */
   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 location. Specify a comma-separated list of alpha-2 codes.
    * Prefix with `-` to exclude locations from results. For example, `-US,PT`
@@ -380,6 +385,14 @@ export interface NetflowTimeseriesParams {
    */
   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 location. Specify a comma-separated list of alpha-2 codes.
    * Prefix with `-` to exclude locations from results. For example, `-US,PT`

package/src/resources/radar/netflows/top.ts

@@ -309,6 +309,14 @@ export interface TopAsesParams {
    */
   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>;
+
   /**
    * Limits the number of objects returned in the response.
    */
@@ -365,6 +373,14 @@ export interface TopLocationsParams {
    */
   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>;
+
   /**
    * Limits the number of objects returned in the response.
    */

package/src/resources/radar/search.ts

@@ -48,6 +48,7 @@ export interface SearchGlobalParams {
    * Search types excluded from results.
    */
   exclude?: Array<
+    | 'ADM1S'
     | 'ASNS'
     | 'BOTS'
     | 'CERTIFICATE_AUTHORITIES'
@@ -68,6 +69,7 @@ export interface SearchGlobalParams {
    * Search types included in results.
    */
   include?: Array<
+    | 'ADM1S'
     | 'ASNS'
     | 'BOTS'
     | 'CERTIFICATE_AUTHORITIES'

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

@@ -109,7 +109,7 @@ export interface TraceCreateResponse {
 
 export interface TraceCreateParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   account_id: string;
 

package/src/resources/resource-sharing/recipients.ts

@@ -106,12 +106,12 @@ export class Recipients extends APIResource {
     params: RecipientGetParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<RecipientGetResponse> {
-    const { account_id } = params;
+    const { account_id, ...query } = params;
     return (
-      this._client.get(
-        `/accounts/${account_id}/shares/${shareId}/recipients/${recipientId}`,
-        options,
-      ) as Core.APIPromise<{ result: RecipientGetResponse }>
+      this._client.get(`/accounts/${account_id}/shares/${shareId}/recipients/${recipientId}`, {
+        query,
+        ...options,
+      }) as Core.APIPromise<{ result: RecipientGetResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
 }
@@ -148,6 +148,27 @@ export interface RecipientCreateResponse {
    * Share Recipient status message.
    */
   status_message: string;
+
+  resources?: Array<RecipientCreateResponse.Resource>;
+}
+
+export namespace RecipientCreateResponse {
+  export interface Resource {
+    /**
+     * Share Recipient error message.
+     */
+    error: string;
+
+    /**
+     * Share Resource identifier.
+     */
+    resource_id: string;
+
+    /**
+     * Resource Version.
+     */
+    resource_version: number;
+  }
 }
 
 export interface RecipientListResponse {
@@ -180,6 +201,27 @@ export interface RecipientListResponse {
    * Share Recipient status message.
    */
   status_message: string;
+
+  resources?: Array<RecipientListResponse.Resource>;
+}
+
+export namespace RecipientListResponse {
+  export interface Resource {
+    /**
+     * Share Recipient error message.
+     */
+    error: string;
+
+    /**
+     * Share Resource identifier.
+     */
+    resource_id: string;
+
+    /**
+     * Resource Version.
+     */
+    resource_version: number;
+  }
 }
 
 export interface RecipientDeleteResponse {
@@ -212,6 +254,27 @@ export interface RecipientDeleteResponse {
    * Share Recipient status message.
    */
   status_message: string;
+
+  resources?: Array<RecipientDeleteResponse.Resource>;
+}
+
+export namespace RecipientDeleteResponse {
+  export interface Resource {
+    /**
+     * Share Recipient error message.
+     */
+    error: string;
+
+    /**
+     * Share Resource identifier.
+     */
+    resource_id: string;
+
+    /**
+     * Resource Version.
+     */
+    resource_version: number;
+  }
 }
 
 export interface RecipientGetResponse {
@@ -244,6 +307,27 @@ export interface RecipientGetResponse {
    * Share Recipient status message.
    */
   status_message: string;
+
+  resources?: Array<RecipientGetResponse.Resource>;
+}
+
+export namespace RecipientGetResponse {
+  export interface Resource {
+    /**
+     * Share Recipient error message.
+     */
+    error: string;
+
+    /**
+     * Share Resource identifier.
+     */
+    resource_id: string;
+
+    /**
+     * Resource Version.
+     */
+    resource_version: number;
+  }
 }
 
 export interface RecipientCreateParams {
@@ -268,6 +352,11 @@ export interface RecipientListParams extends V4PagePaginationArrayParams {
    * Path param: Account identifier.
    */
   account_id: string;
+
+  /**
+   * Query param: Include resources in the response.
+   */
+  include_resources?: boolean;
 }
 
 export interface RecipientDeleteParams {
@@ -279,9 +368,14 @@ export interface RecipientDeleteParams {
 
 export interface RecipientGetParams {
   /**
-   * Account identifier.
+   * Path param: Account identifier.
    */
   account_id: string;
+
+  /**
+   * Query param: Include resources in the response.
+   */
+  include_resources?: boolean;
 }
 
 Recipients.RecipientListResponsesV4PagePaginationArray = RecipientListResponsesV4PagePaginationArray;