cloudflare 3.0.0 → 3.2.0

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

@@ -194,6 +194,30 @@ export class TimeseriesGroups extends APIResource {
     )._thenUnwrap((obj) => obj.result);
   }
 
+  /**
+   * Get a time series of the percentage distribution of traffic per Post Quantum
+   * suport.
+   */
+  postQuantum(
+    query?: TimeseriesGroupPostQuantumParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TimeseriesGroupPostQuantumResponse>;
+  postQuantum(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupPostQuantumResponse>;
+  postQuantum(
+    query: TimeseriesGroupPostQuantumParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TimeseriesGroupPostQuantumResponse> {
+    if (isRequestOptions(query)) {
+      return this.postQuantum({}, query);
+    }
+    return (
+      this._client.get('/radar/http/timeseries_groups/post_quantum', {
+        query,
+        ...options,
+      }) as Core.APIPromise<{ result: TimeseriesGroupPostQuantumResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
   /**
    * Get a time series of the percentage distribution of traffic per TLS protocol
    * version.
@@ -342,6 +366,22 @@ export namespace TimeseriesGroupOSResponse {
   }
 }
 
+export interface TimeseriesGroupPostQuantumResponse {
+  meta: unknown;
+
+  serie_0: TimeseriesGroupPostQuantumResponse.Serie0;
+}
+
+export namespace TimeseriesGroupPostQuantumResponse {
+  export interface Serie0 {
+    NOT_SUPPORTED: Array<string>;
+
+    SUPPORTED: Array<string>;
+
+    timestamps: Array<string>;
+  }
+}
+
 export interface TimeseriesGroupTLSVersionResponse {
   meta: unknown;
 
@@ -1211,6 +1251,115 @@ export interface TimeseriesGroupOSParams {
   tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3' | 'TLSvQUIC'>;
 }
 
+export interface TimeseriesGroupPostQuantumParams {
+  /**
+   * Aggregation interval results should be returned in (for example, in 15 minutes
+   * or 1 hour intervals). Refer to
+   * [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
+   */
+  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.
+   */
+  asn?: Array<string>;
+
+  /**
+   * Filter for bot class. Refer to
+   * [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
+   */
+  botClass?: Array<'LIKELY_AUTOMATED' | 'LIKELY_HUMAN'>;
+
+  /**
+   * 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.
+   */
+  continent?: Array<string>;
+
+  /**
+   * End of the date range (inclusive).
+   */
+  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).
+   */
+  dateRange?: Array<
+    | '1d'
+    | '2d'
+    | '7d'
+    | '14d'
+    | '28d'
+    | '12w'
+    | '24w'
+    | '52w'
+    | '1dControl'
+    | '2dControl'
+    | '7dControl'
+    | '14dControl'
+    | '28dControl'
+    | '12wControl'
+    | '24wControl'
+  >;
+
+  /**
+   * Array of datetimes to filter the start of a series.
+   */
+  dateStart?: Array<string>;
+
+  /**
+   * Filter for device type.
+   */
+  deviceType?: Array<'DESKTOP' | 'MOBILE' | 'OTHER'>;
+
+  /**
+   * Format results are returned in.
+   */
+  format?: 'JSON' | 'CSV';
+
+  /**
+   * Filter for http protocol.
+   */
+  httpProtocol?: Array<'HTTP' | 'HTTPS'>;
+
+  /**
+   * Filter for http version.
+   */
+  httpVersion?: Array<'HTTPv1' | 'HTTPv2' | 'HTTPv3'>;
+
+  /**
+   * Filter for ip version.
+   */
+  ipVersion?: Array<'IPv4' | 'IPv6'>;
+
+  /**
+   * 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.
+   */
+  location?: Array<string>;
+
+  /**
+   * Array of names that will be used to name the series in responses.
+   */
+  name?: Array<string>;
+
+  /**
+   * Filter for os name.
+   */
+  os?: Array<'WINDOWS' | 'MACOSX' | 'IOS' | 'ANDROID' | 'CHROMEOS' | 'LINUX' | 'SMART_TV'>;
+
+  /**
+   * Filter for tls version.
+   */
+  tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3' | 'TLSvQUIC'>;
+}
+
 export interface TimeseriesGroupTLSVersionParams {
   /**
    * Aggregation interval results should be returned in (for example, in 15 minutes
@@ -1324,6 +1473,7 @@ export namespace TimeseriesGroups {
   export import TimeseriesGroupHTTPVersionResponse = TimeseriesGroupsAPI.TimeseriesGroupHTTPVersionResponse;
   export import TimeseriesGroupIPVersionResponse = TimeseriesGroupsAPI.TimeseriesGroupIPVersionResponse;
   export import TimeseriesGroupOSResponse = TimeseriesGroupsAPI.TimeseriesGroupOSResponse;
+  export import TimeseriesGroupPostQuantumResponse = TimeseriesGroupsAPI.TimeseriesGroupPostQuantumResponse;
   export import TimeseriesGroupTLSVersionResponse = TimeseriesGroupsAPI.TimeseriesGroupTLSVersionResponse;
   export import TimeseriesGroupBotClassParams = TimeseriesGroupsAPI.TimeseriesGroupBotClassParams;
   export import TimeseriesGroupBrowserParams = TimeseriesGroupsAPI.TimeseriesGroupBrowserParams;
@@ -1333,5 +1483,6 @@ export namespace TimeseriesGroups {
   export import TimeseriesGroupHTTPVersionParams = TimeseriesGroupsAPI.TimeseriesGroupHTTPVersionParams;
   export import TimeseriesGroupIPVersionParams = TimeseriesGroupsAPI.TimeseriesGroupIPVersionParams;
   export import TimeseriesGroupOSParams = TimeseriesGroupsAPI.TimeseriesGroupOSParams;
+  export import TimeseriesGroupPostQuantumParams = TimeseriesGroupsAPI.TimeseriesGroupPostQuantumParams;
   export import TimeseriesGroupTLSVersionParams = TimeseriesGroupsAPI.TimeseriesGroupTLSVersionParams;
 }

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

@@ -50,10 +50,16 @@ export class Top extends APIResource {
   }
 }
 
+export interface Browser {
+  name: string;
+
+  value: string;
+}
+
 export interface TopBrowserFamiliesResponse {
   meta: TopBrowserFamiliesResponse.Meta;
 
-  top_0: Array<TopBrowserFamiliesResponse.Top0>;
+  top_0: Array<Browser>;
 }
 
 export namespace TopBrowserFamiliesResponse {
@@ -102,18 +108,12 @@ export namespace TopBrowserFamiliesResponse {
       }
     }
   }
-
-  export interface Top0 {
-    name: string;
-
-    value: string;
-  }
 }
 
 export interface TopBrowsersResponse {
   meta: TopBrowsersResponse.Meta;
 
-  top_0: Array<TopBrowsersResponse.Top0>;
+  top_0: Array<Browser>;
 }
 
 export namespace TopBrowsersResponse {
@@ -162,12 +162,6 @@ export namespace TopBrowsersResponse {
       }
     }
   }
-
-  export interface Top0 {
-    name: string;
-
-    value: string;
-  }
 }
 
 export interface TopBrowserFamiliesParams {
@@ -385,6 +379,7 @@ export interface TopBrowsersParams {
 }
 
 export namespace Top {
+  export import Browser = TopAPI.Browser;
   export import TopBrowserFamiliesResponse = TopAPI.TopBrowserFamiliesResponse;
   export import TopBrowsersResponse = TopAPI.TopBrowsersResponse;
   export import TopBrowserFamiliesParams = TopAPI.TopBrowserFamiliesParams;

package/src/resources/radar/index.ts

@@ -21,12 +21,12 @@ export {
   DatasetGetParams,
   Datasets,
 } from './datasets';
-export { Email } from './email/index';
 export { EntityGetResponse, EntityGetParams, Entities } from './entities/index';
 export { HTTP } from './http/index';
 export { NetflowTimeseriesResponse, NetflowTimeseriesParams, Netflows } from './netflows/index';
 export { Quality } from './quality/index';
 export { Radar } from './radar';
+export { RadarEmailSeries, RadarEmailSummary, Email } from './email/index';
 export {
   RankingTimeseriesGroupsResponse,
   RankingTopResponse,

package/src/resources/radar/radar.ts

@@ -69,6 +69,8 @@ export namespace Radar {
   export import ConnectionTamperingSummaryParams = ConnectionTamperingAPI.ConnectionTamperingSummaryParams;
   export import ConnectionTamperingTimeseriesGroupsParams = ConnectionTamperingAPI.ConnectionTamperingTimeseriesGroupsParams;
   export import Email = EmailAPI.Email;
+  export import RadarEmailSeries = EmailAPI.RadarEmailSeries;
+  export import RadarEmailSummary = EmailAPI.RadarEmailSummary;
   export import Attacks = AttacksAPI.Attacks;
   export import Entities = EntitiesAPI.Entities;
   export import EntityGetResponse = EntitiesAPI.EntityGetResponse;

package/src/resources/rate-limits.ts

@@ -15,10 +15,10 @@ export class RateLimits extends APIResource {
     zoneIdentifier: string,
     body: RateLimitCreateParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<RateLimitCreateResponse | null> {
+  ): Core.APIPromise<RateLimitCreateResponse> {
     return (
       this._client.post(`/zones/${zoneIdentifier}/rate_limits`, { body, ...options }) as Core.APIPromise<{
-        result: RateLimitCreateResponse | null;
+        result: RateLimitCreateResponse;
       }>
     )._thenUnwrap((obj) => obj.result);
   }
@@ -30,24 +30,23 @@ export class RateLimits extends APIResource {
     zoneIdentifier: string,
     query?: RateLimitListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<RateLimitListResponsesV4PagePaginationArray, RateLimitListResponse>;
+  ): Core.PagePromise<RateLimitsV4PagePaginationArray, RateLimit>;
   list(
     zoneIdentifier: string,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<RateLimitListResponsesV4PagePaginationArray, RateLimitListResponse>;
+  ): Core.PagePromise<RateLimitsV4PagePaginationArray, RateLimit>;
   list(
     zoneIdentifier: string,
     query: RateLimitListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<RateLimitListResponsesV4PagePaginationArray, RateLimitListResponse> {
+  ): Core.PagePromise<RateLimitsV4PagePaginationArray, RateLimit> {
     if (isRequestOptions(query)) {
       return this.list(zoneIdentifier, {}, query);
     }
-    return this._client.getAPIList(
-      `/zones/${zoneIdentifier}/rate_limits`,
-      RateLimitListResponsesV4PagePaginationArray,
-      { query, ...options },
-    );
+    return this._client.getAPIList(`/zones/${zoneIdentifier}/rate_limits`, RateLimitsV4PagePaginationArray, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -57,10 +56,10 @@ export class RateLimits extends APIResource {
     zoneIdentifier: string,
     id: string,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<RateLimitDeleteResponse | null> {
+  ): Core.APIPromise<RateLimitDeleteResponse> {
     return (
       this._client.delete(`/zones/${zoneIdentifier}/rate_limits/${id}`, options) as Core.APIPromise<{
-        result: RateLimitDeleteResponse | null;
+        result: RateLimitDeleteResponse;
       }>
     )._thenUnwrap((obj) => obj.result);
   }
@@ -73,12 +72,12 @@ export class RateLimits extends APIResource {
     id: string,
     body: RateLimitEditParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<RateLimitEditResponse | null> {
+  ): Core.APIPromise<RateLimitEditResponse> {
     return (
       this._client.put(`/zones/${zoneIdentifier}/rate_limits/${id}`, {
         body,
         ...options,
-      }) as Core.APIPromise<{ result: RateLimitEditResponse | null }>
+      }) as Core.APIPromise<{ result: RateLimitEditResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -89,16 +88,34 @@ export class RateLimits extends APIResource {
     zoneIdentifier: string,
     id: string,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<RateLimitGetResponse | null> {
+  ): Core.APIPromise<RateLimitGetResponse> {
     return (
       this._client.get(`/zones/${zoneIdentifier}/rate_limits/${id}`, options) as Core.APIPromise<{
-        result: RateLimitGetResponse | null;
+        result: RateLimitGetResponse;
       }>
     )._thenUnwrap((obj) => obj.result);
   }
 }
 
-export class RateLimitListResponsesV4PagePaginationArray extends V4PagePaginationArray<RateLimitListResponse> {}
+export class RateLimitsV4PagePaginationArray extends V4PagePaginationArray<RateLimit> {}
+
+/**
+ * The action to apply to a matched request. The `log` action is only available on
+ * an Enterprise plan.
+ */
+export type Action =
+  | 'block'
+  | 'challenge'
+  | 'js_challenge'
+  | 'managed_challenge'
+  | 'allow'
+  | 'log'
+  | 'bypass';
+
+/**
+ * An HTTP method or `_ALL_` to indicate all methods.
+ */
+export type Methods = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | '_ALL_';
 
 export interface RateLimit {
   /**
@@ -246,7 +263,7 @@ export namespace RateLimit {
        * `['POST','PUT']`) or all methods (`['_ALL_']`). This field is optional when
        * creating a rate limit.
        */
-      methods?: Array<'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | '_ALL_'>;
+      methods?: Array<RateLimitsAPI.Methods>;
 
       /**
        * The HTTP schemes to match. You can specify one scheme (`['HTTPS']`), both
@@ -277,184 +294,7 @@ export namespace RateLimit {
   }
 }
 
-export type RateLimitCreateResponse = unknown | string;
-
-export interface RateLimitListResponse {
-  /**
-   * The unique identifier of the rate limit.
-   */
-  id?: string;
-
-  /**
-   * The action to perform when the threshold of matched traffic within the
-   * configured period is exceeded.
-   */
-  action?: RateLimitListResponse.Action;
-
-  /**
-   * Criteria specifying when the current rate limit should be bypassed. You can
-   * specify that the rate limit should not apply to one or more URLs.
-   */
-  bypass?: Array<RateLimitListResponse.Bypass>;
-
-  /**
-   * An informative summary of the rate limit. This value is sanitized and any tags
-   * will be removed.
-   */
-  description?: string;
-
-  /**
-   * When true, indicates that the rate limit is currently disabled.
-   */
-  disabled?: boolean;
-
-  /**
-   * Determines which traffic the rate limit counts towards the threshold.
-   */
-  match?: RateLimitListResponse.Match;
-
-  /**
-   * The time in seconds (an integer value) to count matching traffic. If the count
-   * exceeds the configured threshold within this period, Cloudflare will perform the
-   * configured action.
-   */
-  period?: number;
-
-  /**
-   * The threshold that will trigger the configured mitigation action. Configure this
-   * value along with the `period` property to establish a threshold per period.
-   */
-  threshold?: number;
-}
-
-export namespace RateLimitListResponse {
-  /**
-   * The action to perform when the threshold of matched traffic within the
-   * configured period is exceeded.
-   */
-  export interface Action {
-    /**
-     * The action to perform.
-     */
-    mode?: 'simulate' | 'ban' | 'challenge' | 'js_challenge' | 'managed_challenge';
-
-    /**
-     * A custom content type and reponse to return when the threshold is exceeded. The
-     * custom response configured in this object will override the custom error for the
-     * zone. This object is optional. Notes: If you omit this object, Cloudflare will
-     * use the default HTML error page. If "mode" is "challenge", "managed_challenge",
-     * or "js_challenge", Cloudflare will use the zone challenge pages and you should
-     * not provide the "response" object.
-     */
-    response?: Action.Response;
-
-    /**
-     * The time in seconds during which Cloudflare will perform the mitigation action.
-     * Must be an integer value greater than or equal to the period. Notes: If "mode"
-     * is "challenge", "managed_challenge", or "js_challenge", Cloudflare will use the
-     * zone's Challenge Passage time and you should not provide this value.
-     */
-    timeout?: number;
-  }
-
-  export namespace Action {
-    /**
-     * A custom content type and reponse to return when the threshold is exceeded. The
-     * custom response configured in this object will override the custom error for the
-     * zone. This object is optional. Notes: If you omit this object, Cloudflare will
-     * use the default HTML error page. If "mode" is "challenge", "managed_challenge",
-     * or "js_challenge", Cloudflare will use the zone challenge pages and you should
-     * not provide the "response" object.
-     */
-    export interface Response {
-      /**
-       * The response body to return. The value must conform to the configured content
-       * type.
-       */
-      body?: string;
-
-      /**
-       * The content type of the body. Must be one of the following: `text/plain`,
-       * `text/xml`, or `application/json`.
-       */
-      content_type?: string;
-    }
-  }
-
-  export interface Bypass {
-    name?: 'url';
-
-    /**
-     * The URL to bypass.
-     */
-    value?: string;
-  }
-
-  /**
-   * Determines which traffic the rate limit counts towards the threshold.
-   */
-  export interface Match {
-    headers?: Array<Match.Header>;
-
-    request?: Match.Request;
-
-    response?: Match.Response;
-  }
-
-  export namespace Match {
-    export interface Header {
-      /**
-       * The name of the response header to match.
-       */
-      name?: string;
-
-      /**
-       * The operator used when matching: `eq` means "equal" and `ne` means "not equal".
-       */
-      op?: 'eq' | 'ne';
-
-      /**
-       * The value of the response header, which must match exactly.
-       */
-      value?: string;
-    }
-
-    export interface Request {
-      /**
-       * The HTTP methods to match. You can specify a subset (for example,
-       * `['POST','PUT']`) or all methods (`['_ALL_']`). This field is optional when
-       * creating a rate limit.
-       */
-      methods?: Array<'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | '_ALL_'>;
-
-      /**
-       * The HTTP schemes to match. You can specify one scheme (`['HTTPS']`), both
-       * schemes (`['HTTP','HTTPS']`), or all schemes (`['_ALL_']`). This field is
-       * optional.
-       */
-      schemes?: Array<string>;
-
-      /**
-       * The URL pattern to match, composed of a host and a path such as
-       * `example.org/path*`. Normalization is applied before the pattern is matched. `*`
-       * wildcards are expanded to match applicable traffic. Query strings are not
-       * matched. Set the value to `*` to match all traffic to your zone.
-       */
-      url?: string;
-    }
-
-    export interface Response {
-      /**
-       * When true, only the uncached traffic served from your origin servers will count
-       * towards rate limiting. In this case, any cached traffic served by Cloudflare
-       * will not count towards rate limiting. This field is optional. Notes: This field
-       * is deprecated. Instead, use response headers and set "origin_traffic" to "false"
-       * to avoid legacy behaviour interacting with the "response_headers" property.
-       */
-      origin_traffic?: boolean;
-    }
-  }
-}
+export type RateLimitCreateResponse = unknown | string | null;
 
 export interface RateLimitDeleteResponse {
   /**
@@ -463,25 +303,12 @@ export interface RateLimitDeleteResponse {
   id?: string;
 }
 
-export type RateLimitEditResponse = unknown | string;
+export type RateLimitEditResponse = unknown | string | null;
 
-export type RateLimitGetResponse = unknown | string;
+export type RateLimitGetResponse = unknown | string | null;
 
 export type RateLimitCreateParams = unknown;
 
 export interface RateLimitListParams extends V4PagePaginationArrayParams {}
 
 export type RateLimitEditParams = unknown;
-
-export namespace RateLimits {
-  export import RateLimit = RateLimitsAPI.RateLimit;
-  export import RateLimitCreateResponse = RateLimitsAPI.RateLimitCreateResponse;
-  export import RateLimitListResponse = RateLimitsAPI.RateLimitListResponse;
-  export import RateLimitDeleteResponse = RateLimitsAPI.RateLimitDeleteResponse;
-  export import RateLimitEditResponse = RateLimitsAPI.RateLimitEditResponse;
-  export import RateLimitGetResponse = RateLimitsAPI.RateLimitGetResponse;
-  export import RateLimitListResponsesV4PagePaginationArray = RateLimitsAPI.RateLimitListResponsesV4PagePaginationArray;
-  export import RateLimitCreateParams = RateLimitsAPI.RateLimitCreateParams;
-  export import RateLimitListParams = RateLimitsAPI.RateLimitListParams;
-  export import RateLimitEditParams = RateLimitsAPI.RateLimitEditParams;
-}

package/src/resources/rate-plans.ts

@@ -2,7 +2,6 @@
 
 import * as Core from "../core";
 import { APIResource } from "../resource";
-import * as RatePlansAPI from "./rate-plans";
 
 export class RatePlans extends APIResource {
   /**
@@ -68,62 +67,4 @@ export namespace RatePlan {
   }
 }
 
-export type RatePlanGetResponse = Array<RatePlanGetResponse.RatePlanGetResponseItem>;
-
-export namespace RatePlanGetResponse {
-  export interface RatePlanGetResponseItem {
-    /**
-     * Plan identifier tag.
-     */
-    id?: string;
-
-    /**
-     * Array of available components values for the plan.
-     */
-    components?: Array<RatePlanGetResponseItem.Component>;
-
-    /**
-     * The monetary unit in which pricing information is displayed.
-     */
-    currency?: string;
-
-    /**
-     * The duration of the plan subscription.
-     */
-    duration?: number;
-
-    /**
-     * The frequency at which you will be billed for this plan.
-     */
-    frequency?: 'weekly' | 'monthly' | 'quarterly' | 'yearly';
-
-    /**
-     * The plan name.
-     */
-    name?: string;
-  }
-
-  export namespace RatePlanGetResponseItem {
-    export interface Component {
-      /**
-       * The default amount allocated.
-       */
-      default?: number;
-
-      /**
-       * The unique component.
-       */
-      name?: 'zones' | 'page_rules' | 'dedicated_certificates' | 'dedicated_certificates_custom';
-
-      /**
-       * The unit price of the addon.
-       */
-      unit_price?: number;
-    }
-  }
-}
-
-export namespace RatePlans {
-  export import RatePlan = RatePlansAPI.RatePlan;
-  export import RatePlanGetResponse = RatePlansAPI.RatePlanGetResponse;
-}
+export type RatePlanGetResponse = Array<RatePlan>;