cloudflare 4.4.1 → 5.0.0

package/src/resources/custom-pages.ts

@@ -13,7 +13,7 @@ export class CustomPages extends APIResource {
    * @example
    * ```ts
    * const customPage = await client.customPages.update(
-   *   '023e105f4ecef8ad9ca31a8372d0c353',
+   *   'ratelimit_block',
    *   {
    *     state: 'default',
    *     url: 'http://www.example.com',
@@ -23,10 +23,17 @@ export class CustomPages extends APIResource {
    * ```
    */
   update(
-    identifier: string,
+    identifier:
+      | 'waf_block'
+      | 'ip_block'
+      | 'country_challenge'
+      | '500_errors'
+      | '1000_errors'
+      | 'managed_challenge'
+      | 'ratelimit_block',
     params: CustomPageUpdateParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<CustomPageUpdateResponse | null> {
+  ): Core.APIPromise<CustomPageUpdateResponse> {
     const { account_id, zone_id, ...body } = params;
     if (!account_id && !zone_id) {
       throw new CloudflareError('You must provide either account_id or zone_id.');
@@ -48,7 +55,7 @@ export class CustomPages extends APIResource {
       this._client.put(`/${accountOrZone}/${accountOrZoneId}/custom_pages/${identifier}`, {
         body,
         ...options,
-      }) as Core.APIPromise<{ result: CustomPageUpdateResponse | null }>
+      }) as Core.APIPromise<{ result: CustomPageUpdateResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -109,22 +116,46 @@ export class CustomPages extends APIResource {
    * @example
    * ```ts
    * const customPage = await client.customPages.get(
-   *   '023e105f4ecef8ad9ca31a8372d0c353',
+   *   'ratelimit_block',
    *   { account_id: 'account_id' },
    * );
    * ```
    */
   get(
-    identifier: string,
+    identifier:
+      | 'waf_block'
+      | 'ip_block'
+      | 'country_challenge'
+      | '500_errors'
+      | '1000_errors'
+      | 'managed_challenge'
+      | 'ratelimit_block',
     params?: CustomPageGetParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<CustomPageGetResponse | null>;
-  get(identifier: string, options?: Core.RequestOptions): Core.APIPromise<CustomPageGetResponse | null>;
+  ): Core.APIPromise<CustomPageGetResponse>;
   get(
-    identifier: string,
+    identifier:
+      | 'waf_block'
+      | 'ip_block'
+      | 'country_challenge'
+      | '500_errors'
+      | '1000_errors'
+      | 'managed_challenge'
+      | 'ratelimit_block',
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CustomPageGetResponse>;
+  get(
+    identifier:
+      | 'waf_block'
+      | 'ip_block'
+      | 'country_challenge'
+      | '500_errors'
+      | '1000_errors'
+      | 'managed_challenge'
+      | 'ratelimit_block',
     params: CustomPageGetParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.APIPromise<CustomPageGetResponse | null> {
+  ): Core.APIPromise<CustomPageGetResponse> {
     if (isRequestOptions(params)) {
       return this.get(identifier, {}, params);
     }
@@ -149,18 +180,84 @@ export class CustomPages extends APIResource {
       this._client.get(
         `/${accountOrZone}/${accountOrZoneId}/custom_pages/${identifier}`,
         options,
-      ) as Core.APIPromise<{ result: CustomPageGetResponse | null }>
+      ) as Core.APIPromise<{ result: CustomPageGetResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
 }
 
 export class CustomPageListResponsesSinglePage extends SinglePage<CustomPageListResponse> {}
 
-export type CustomPageUpdateResponse = unknown | string;
+export interface CustomPageUpdateResponse {
+  id?: string;
+
+  created_on?: string;
+
+  description?: string;
+
+  modified_on?: string;
+
+  preview_target?: string;
+
+  required_tokens?: Array<string>;
+
+  /**
+   * The custom page state.
+   */
+  state?: 'default' | 'customized';
+
+  /**
+   * The URL associated with the custom page.
+   */
+  url?: string;
+}
+
+export interface CustomPageListResponse {
+  id?: string;
+
+  created_on?: string;
+
+  description?: string;
+
+  modified_on?: string;
+
+  preview_target?: string;
 
-export type CustomPageListResponse = unknown;
+  required_tokens?: Array<string>;
 
-export type CustomPageGetResponse = unknown | string;
+  /**
+   * The custom page state.
+   */
+  state?: 'default' | 'customized';
+
+  /**
+   * The URL associated with the custom page.
+   */
+  url?: string;
+}
+
+export interface CustomPageGetResponse {
+  id?: string;
+
+  created_on?: string;
+
+  description?: string;
+
+  modified_on?: string;
+
+  preview_target?: string;
+
+  required_tokens?: Array<string>;
+
+  /**
+   * The custom page state.
+   */
+  state?: 'default' | 'customized';
+
+  /**
+   * The URL associated with the custom page.
+   */
+  url?: string;
+}
 
 export interface CustomPageUpdateParams {
   /**

package/src/resources/diagnostics/diagnostics.ts

@@ -1,15 +1,33 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../resource';
+import * as EndpointHealthchecksAPI from './endpoint-healthchecks';
+import {
+  EndpointHealthcheck,
+  EndpointHealthcheckCreateParams,
+  EndpointHealthcheckCreateResponse,
+  EndpointHealthcheckDeleteParams,
+  EndpointHealthcheckDeleteResponse,
+  EndpointHealthcheckGetParams,
+  EndpointHealthcheckGetResponse,
+  EndpointHealthcheckListParams,
+  EndpointHealthcheckListResponse,
+  EndpointHealthcheckUpdateParams,
+  EndpointHealthcheckUpdateResponse,
+  EndpointHealthchecks,
+} from './endpoint-healthchecks';
 import * as TraceroutesAPI from './traceroutes';
 import { Traceroute, TracerouteCreateParams, Traceroutes, TraceroutesSinglePage } from './traceroutes';
 
 export class Diagnostics extends APIResource {
   traceroutes: TraceroutesAPI.Traceroutes = new TraceroutesAPI.Traceroutes(this._client);
+  endpointHealthchecks: EndpointHealthchecksAPI.EndpointHealthchecks =
+    new EndpointHealthchecksAPI.EndpointHealthchecks(this._client);
 }
 
 Diagnostics.Traceroutes = Traceroutes;
 Diagnostics.TraceroutesSinglePage = TraceroutesSinglePage;
+Diagnostics.EndpointHealthchecks = EndpointHealthchecks;
 
 export declare namespace Diagnostics {
   export {
@@ -18,4 +36,19 @@ export declare namespace Diagnostics {
     TraceroutesSinglePage as TraceroutesSinglePage,
     type TracerouteCreateParams as TracerouteCreateParams,
   };
+
+  export {
+    EndpointHealthchecks as EndpointHealthchecks,
+    type EndpointHealthcheck as EndpointHealthcheck,
+    type EndpointHealthcheckCreateResponse as EndpointHealthcheckCreateResponse,
+    type EndpointHealthcheckUpdateResponse as EndpointHealthcheckUpdateResponse,
+    type EndpointHealthcheckListResponse as EndpointHealthcheckListResponse,
+    type EndpointHealthcheckDeleteResponse as EndpointHealthcheckDeleteResponse,
+    type EndpointHealthcheckGetResponse as EndpointHealthcheckGetResponse,
+    type EndpointHealthcheckCreateParams as EndpointHealthcheckCreateParams,
+    type EndpointHealthcheckUpdateParams as EndpointHealthcheckUpdateParams,
+    type EndpointHealthcheckListParams as EndpointHealthcheckListParams,
+    type EndpointHealthcheckDeleteParams as EndpointHealthcheckDeleteParams,
+    type EndpointHealthcheckGetParams as EndpointHealthcheckGetParams,
+  };
 }

package/src/resources/diagnostics/endpoint-healthchecks.ts

@@ -0,0 +1,364 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+
+export class EndpointHealthchecks extends APIResource {
+  /**
+   * Create Endpoint Health Check.
+   *
+   * @example
+   * ```ts
+   * const endpointHealthcheck =
+   *   await client.diagnostics.endpointHealthchecks.create({
+   *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *     check_type: 'icmp',
+   *     endpoint: '203.0.113.1',
+   *   });
+   * ```
+   */
+  create(
+    params: EndpointHealthcheckCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<EndpointHealthcheckCreateResponse> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.post(`/accounts/${account_id}/diagnostics/endpoint-healthchecks`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: EndpointHealthcheckCreateResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Update a Endpoint Health Check.
+   *
+   * @example
+   * ```ts
+   * const endpointHealthcheck =
+   *   await client.diagnostics.endpointHealthchecks.update(
+   *     'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
+   *     {
+   *       account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *       check_type: 'icmp',
+   *       endpoint: '203.0.113.1',
+   *     },
+   *   );
+   * ```
+   */
+  update(
+    id: string,
+    params: EndpointHealthcheckUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<EndpointHealthcheckUpdateResponse> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.put(`/accounts/${account_id}/diagnostics/endpoint-healthchecks/${id}`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: EndpointHealthcheckUpdateResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * List Endpoint Health Checks.
+   *
+   * @example
+   * ```ts
+   * const endpointHealthchecks =
+   *   await client.diagnostics.endpointHealthchecks.list({
+   *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *   });
+   * ```
+   */
+  list(
+    params: EndpointHealthcheckListParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<EndpointHealthcheckListResponse> {
+    const { account_id } = params;
+    return (
+      this._client.get(
+        `/accounts/${account_id}/diagnostics/endpoint-healthchecks`,
+        options,
+      ) as Core.APIPromise<{ result: EndpointHealthcheckListResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Delete Endpoint Health Check.
+   *
+   * @example
+   * ```ts
+   * const endpointHealthcheck =
+   *   await client.diagnostics.endpointHealthchecks.delete(
+   *     'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
+   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   *   );
+   * ```
+   */
+  delete(
+    id: string,
+    params: EndpointHealthcheckDeleteParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<EndpointHealthcheckDeleteResponse> {
+    const { account_id } = params;
+    return this._client.delete(`/accounts/${account_id}/diagnostics/endpoint-healthchecks/${id}`, options);
+  }
+
+  /**
+   * Get a single Endpoint Health Check.
+   *
+   * @example
+   * ```ts
+   * const endpointHealthcheck =
+   *   await client.diagnostics.endpointHealthchecks.get(
+   *     'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
+   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   *   );
+   * ```
+   */
+  get(
+    id: string,
+    params: EndpointHealthcheckGetParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<EndpointHealthcheckGetResponse> {
+    const { account_id } = params;
+    return (
+      this._client.get(
+        `/accounts/${account_id}/diagnostics/endpoint-healthchecks/${id}`,
+        options,
+      ) as Core.APIPromise<{ result: EndpointHealthcheckGetResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export interface EndpointHealthcheck {
+  /**
+   * type of check to perform
+   */
+  check_type: 'icmp';
+
+  /**
+   * the IP address of the host to perform checks against
+   */
+  endpoint: string;
+
+  /**
+   * Optional name associated with this check
+   */
+  name?: string;
+}
+
+export interface EndpointHealthcheckCreateResponse {
+  /**
+   * type of check to perform
+   */
+  check_type: 'icmp';
+
+  /**
+   * the IP address of the host to perform checks against
+   */
+  endpoint: string;
+
+  /**
+   * UUID.
+   */
+  id?: string;
+
+  /**
+   * Optional name associated with this check
+   */
+  name?: string;
+}
+
+export interface EndpointHealthcheckUpdateResponse {
+  /**
+   * type of check to perform
+   */
+  check_type: 'icmp';
+
+  /**
+   * the IP address of the host to perform checks against
+   */
+  endpoint: string;
+
+  /**
+   * UUID.
+   */
+  id?: string;
+
+  /**
+   * Optional name associated with this check
+   */
+  name?: string;
+}
+
+export interface EndpointHealthcheckListResponse {
+  /**
+   * type of check to perform
+   */
+  check_type: 'icmp';
+
+  /**
+   * the IP address of the host to perform checks against
+   */
+  endpoint: string;
+
+  /**
+   * UUID.
+   */
+  id?: string;
+
+  /**
+   * Optional name associated with this check
+   */
+  name?: string;
+}
+
+export interface EndpointHealthcheckDeleteResponse {
+  errors: Array<EndpointHealthcheckDeleteResponse.Error>;
+
+  messages: Array<EndpointHealthcheckDeleteResponse.Message>;
+
+  /**
+   * Whether the API call was successful.
+   */
+  success: true;
+}
+
+export namespace EndpointHealthcheckDeleteResponse {
+  export interface Error {
+    code: number;
+
+    message: string;
+
+    documentation_url?: string;
+
+    source?: Error.Source;
+  }
+
+  export namespace Error {
+    export interface Source {
+      pointer?: string;
+    }
+  }
+
+  export interface Message {
+    code: number;
+
+    message: string;
+
+    documentation_url?: string;
+
+    source?: Message.Source;
+  }
+
+  export namespace Message {
+    export interface Source {
+      pointer?: string;
+    }
+  }
+}
+
+export interface EndpointHealthcheckGetResponse {
+  /**
+   * type of check to perform
+   */
+  check_type: 'icmp';
+
+  /**
+   * the IP address of the host to perform checks against
+   */
+  endpoint: string;
+
+  /**
+   * UUID.
+   */
+  id?: string;
+
+  /**
+   * Optional name associated with this check
+   */
+  name?: string;
+}
+
+export interface EndpointHealthcheckCreateParams {
+  /**
+   * Path param: Identifier
+   */
+  account_id: string;
+
+  /**
+   * Body param: type of check to perform
+   */
+  check_type: 'icmp';
+
+  /**
+   * Body param: the IP address of the host to perform checks against
+   */
+  endpoint: string;
+
+  /**
+   * Body param: Optional name associated with this check
+   */
+  name?: string;
+}
+
+export interface EndpointHealthcheckUpdateParams {
+  /**
+   * Path param: Identifier
+   */
+  account_id: string;
+
+  /**
+   * Body param: type of check to perform
+   */
+  check_type: 'icmp';
+
+  /**
+   * Body param: the IP address of the host to perform checks against
+   */
+  endpoint: string;
+
+  /**
+   * Body param: Optional name associated with this check
+   */
+  name?: string;
+}
+
+export interface EndpointHealthcheckListParams {
+  /**
+   * Identifier
+   */
+  account_id: string;
+}
+
+export interface EndpointHealthcheckDeleteParams {
+  /**
+   * Identifier
+   */
+  account_id: string;
+}
+
+export interface EndpointHealthcheckGetParams {
+  /**
+   * Identifier
+   */
+  account_id: string;
+}
+
+export declare namespace EndpointHealthchecks {
+  export {
+    type EndpointHealthcheck as EndpointHealthcheck,
+    type EndpointHealthcheckCreateResponse as EndpointHealthcheckCreateResponse,
+    type EndpointHealthcheckUpdateResponse as EndpointHealthcheckUpdateResponse,
+    type EndpointHealthcheckListResponse as EndpointHealthcheckListResponse,
+    type EndpointHealthcheckDeleteResponse as EndpointHealthcheckDeleteResponse,
+    type EndpointHealthcheckGetResponse as EndpointHealthcheckGetResponse,
+    type EndpointHealthcheckCreateParams as EndpointHealthcheckCreateParams,
+    type EndpointHealthcheckUpdateParams as EndpointHealthcheckUpdateParams,
+    type EndpointHealthcheckListParams as EndpointHealthcheckListParams,
+    type EndpointHealthcheckDeleteParams as EndpointHealthcheckDeleteParams,
+    type EndpointHealthcheckGetParams as EndpointHealthcheckGetParams,
+  };
+}

package/src/resources/diagnostics/index.ts

@@ -1,6 +1,20 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export { Diagnostics } from './diagnostics';
+export {
+  EndpointHealthchecks,
+  type EndpointHealthcheck,
+  type EndpointHealthcheckCreateResponse,
+  type EndpointHealthcheckUpdateResponse,
+  type EndpointHealthcheckListResponse,
+  type EndpointHealthcheckDeleteResponse,
+  type EndpointHealthcheckGetResponse,
+  type EndpointHealthcheckCreateParams,
+  type EndpointHealthcheckUpdateParams,
+  type EndpointHealthcheckListParams,
+  type EndpointHealthcheckDeleteParams,
+  type EndpointHealthcheckGetParams,
+} from './endpoint-healthchecks';
 export {
   TraceroutesSinglePage,
   Traceroutes,

package/src/resources/dns/analytics/reports/bytimes.ts

@@ -2,7 +2,6 @@
 
 import { APIResource } from '../../../../resource';
 import * as Core from '../../../../core';
-import * as DNSAPI from '../../dns';
 
 export class Bytimes extends APIResource {
   /**
@@ -55,7 +54,7 @@ export interface ByTime {
    */
   min: unknown;
 
-  query: DNSAPI.DNSAnalyticsQuery;
+  query: ByTime.Query;
 
   /**
    * Total number of rows in the result.
@@ -87,7 +86,60 @@ export namespace ByTime {
      * Array with one item per requested metric. Each item is an array of values,
      * broken down by time interval.
      */
-    metrics: Array<DNSAPI.DNSAnalyticsNominalMetric>;
+    metrics: Array<Array<number>>;
+  }
+
+  export interface Query {
+    /**
+     * Array of dimension names.
+     */
+    dimensions: Array<string>;
+
+    /**
+     * Limit number of returned metrics.
+     */
+    limit: number;
+
+    /**
+     * Array of metric names.
+     */
+    metrics: Array<string>;
+
+    /**
+     * Start date and time of requesting data period in ISO 8601 format.
+     */
+    since: string;
+
+    /**
+     * Unit of time to group data by.
+     */
+    time_delta:
+      | 'all'
+      | 'auto'
+      | 'year'
+      | 'quarter'
+      | 'month'
+      | 'week'
+      | 'day'
+      | 'hour'
+      | 'dekaminute'
+      | 'minute';
+
+    /**
+     * End date and time of requesting data period in ISO 8601 format.
+     */
+    until: string;
+
+    /**
+     * Segmentation filter in 'attribute operator value' format.
+     */
+    filters?: string;
+
+    /**
+     * Array of dimensions to sort by, where each dimension may be prefixed by -
+     * (descending) or + (ascending).
+     */
+    sort?: Array<string>;
   }
 }