cloudflare 3.1.0 → 3.2.0

package/src/resources/speed/pages/pages.ts

@@ -0,0 +1,141 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as Core from "../../../core";
+import { APIResource } from "../../../resource";
+import * as PagesAPI from "./pages";
+import * as SpeedAPI from "../speed";
+import * as TestsAPI from "./tests";
+import { SinglePage } from "../../../pagination";
+
+export class Pages extends APIResource {
+  tests: TestsAPI.Tests = new TestsAPI.Tests(this._client);
+
+  /**
+   * Lists all webpages which have been tested.
+   */
+  list(
+    params: PageListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<PageListResponsesSinglePage, PageListResponse> {
+    const { zone_id } = params;
+    return this._client.getAPIList(`/zones/${zone_id}/speed_api/pages`, PageListResponsesSinglePage, options);
+  }
+
+  /**
+   * Lists the core web vital metrics trend over time for a specific page.
+   */
+  trend(
+    url: string,
+    params: PageTrendParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<SpeedAPI.Trend> {
+    const { zone_id, ...query } = params;
+    return (
+      this._client.get(`/zones/${zone_id}/speed_api/pages/${url}/trend`, {
+        query,
+        ...options,
+      }) as Core.APIPromise<{ result: SpeedAPI.Trend }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export class PageListResponsesSinglePage extends SinglePage<PageListResponse> {}
+
+export interface PageListResponse {
+  /**
+   * A test region with a label.
+   */
+  region?: SpeedAPI.LabeledRegion;
+
+  /**
+   * The frequency of the test.
+   */
+  scheduleFrequency?: 'DAILY' | 'WEEKLY';
+
+  tests?: Array<TestsAPI.Test>;
+
+  /**
+   * A URL.
+   */
+  url?: string;
+}
+
+export interface PageListParams {
+  /**
+   * Identifier
+   */
+  zone_id: string;
+}
+
+export interface PageTrendParams {
+  /**
+   * Path param: Identifier
+   */
+  zone_id: string;
+
+  /**
+   * Query param: The type of device.
+   */
+  deviceType: 'DESKTOP' | 'MOBILE';
+
+  /**
+   * Query param: A comma-separated list of metrics to include in the results.
+   */
+  metrics: string;
+
+  /**
+   * Query param: A test region.
+   */
+  region:
+    | 'asia-east1'
+    | 'asia-northeast1'
+    | 'asia-northeast2'
+    | 'asia-south1'
+    | 'asia-southeast1'
+    | 'australia-southeast1'
+    | 'europe-north1'
+    | 'europe-southwest1'
+    | 'europe-west1'
+    | 'europe-west2'
+    | 'europe-west3'
+    | 'europe-west4'
+    | 'europe-west8'
+    | 'europe-west9'
+    | 'me-west1'
+    | 'southamerica-east1'
+    | 'us-central1'
+    | 'us-east1'
+    | 'us-east4'
+    | 'us-south1'
+    | 'us-west1';
+
+  /**
+   * Query param:
+   */
+  start: string;
+
+  /**
+   * Query param: The timezone of the start and end timestamps.
+   */
+  tz: string;
+
+  /**
+   * Query param:
+   */
+  end?: string;
+}
+
+export namespace Pages {
+  export import PageListResponse = PagesAPI.PageListResponse;
+  export import PageListResponsesSinglePage = PagesAPI.PageListResponsesSinglePage;
+  export import PageListParams = PagesAPI.PageListParams;
+  export import PageTrendParams = PagesAPI.PageTrendParams;
+  export import Tests = TestsAPI.Tests;
+  export import Test = TestsAPI.Test;
+  export import TestListResponse = TestsAPI.TestListResponse;
+  export import TestDeleteResponse = TestsAPI.TestDeleteResponse;
+  export import TestCreateParams = TestsAPI.TestCreateParams;
+  export import TestListParams = TestsAPI.TestListParams;
+  export import TestDeleteParams = TestsAPI.TestDeleteParams;
+  export import TestGetParams = TestsAPI.TestGetParams;
+}

package/src/resources/speed/{tests.ts → pages/tests.ts}

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../../core";
-import { APIResource } from "../../resource";
+import * as Core from "../../../core";
+import { APIResource } from "../../../resource";
 import * as TestsAPI from "./tests";
-import * as Shared from "../shared";
-import * as SpeedAPI from "./speed";
+import * as Shared from "../../shared";
+import * as SpeedAPI from "../speed";
 
 export class Tests extends APIResource {
   /**

package/src/resources/speed/schedule.ts

@@ -3,7 +3,7 @@
 import * as Core from "../../core";
 import { APIResource } from "../../resource";
 import * as ScheduleAPI from "./schedule";
-import * as TestsAPI from "./tests";
+import * as TestsAPI from "./pages/tests";
 
 export class ScheduleResource extends APIResource {
   /**
@@ -22,6 +22,36 @@ export class ScheduleResource extends APIResource {
       }) as Core.APIPromise<{ result: ScheduleCreateResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
+
+  /**
+   * Deletes a scheduled test for a page.
+   */
+  delete(
+    url: string,
+    params: ScheduleDeleteParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ScheduleDeleteResponse> {
+    const { zone_id, region } = params;
+    return (
+      this._client.delete(`/zones/${zone_id}/speed_api/schedule/${url}`, {
+        query: { region },
+        ...options,
+      }) as Core.APIPromise<{ result: ScheduleDeleteResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Retrieves the test schedule for a page in a specific region.
+   */
+  get(url: string, params: ScheduleGetParams, options?: Core.RequestOptions): Core.APIPromise<Schedule> {
+    const { zone_id, ...query } = params;
+    return (
+      this._client.get(`/zones/${zone_id}/speed_api/schedule/${url}`, {
+        query,
+        ...options,
+      }) as Core.APIPromise<{ result: Schedule }>
+    )._thenUnwrap((obj) => obj.result);
+  }
 }
 
 /**
@@ -74,6 +104,13 @@ export interface ScheduleCreateResponse {
   test?: TestsAPI.Test;
 }
 
+export interface ScheduleDeleteResponse {
+  /**
+   * Number of items affected.
+   */
+  count?: number;
+}
+
 export interface ScheduleCreateParams {
   /**
    * Path param: Identifier
@@ -107,8 +144,77 @@ export interface ScheduleCreateParams {
     | 'us-west1';
 }
 
+export interface ScheduleDeleteParams {
+  /**
+   * Path param: Identifier
+   */
+  zone_id: string;
+
+  /**
+   * Query param: A test region.
+   */
+  region?:
+    | 'asia-east1'
+    | 'asia-northeast1'
+    | 'asia-northeast2'
+    | 'asia-south1'
+    | 'asia-southeast1'
+    | 'australia-southeast1'
+    | 'europe-north1'
+    | 'europe-southwest1'
+    | 'europe-west1'
+    | 'europe-west2'
+    | 'europe-west3'
+    | 'europe-west4'
+    | 'europe-west8'
+    | 'europe-west9'
+    | 'me-west1'
+    | 'southamerica-east1'
+    | 'us-central1'
+    | 'us-east1'
+    | 'us-east4'
+    | 'us-south1'
+    | 'us-west1';
+}
+
+export interface ScheduleGetParams {
+  /**
+   * Path param: Identifier
+   */
+  zone_id: string;
+
+  /**
+   * Query param: A test region.
+   */
+  region?:
+    | 'asia-east1'
+    | 'asia-northeast1'
+    | 'asia-northeast2'
+    | 'asia-south1'
+    | 'asia-southeast1'
+    | 'australia-southeast1'
+    | 'europe-north1'
+    | 'europe-southwest1'
+    | 'europe-west1'
+    | 'europe-west2'
+    | 'europe-west3'
+    | 'europe-west4'
+    | 'europe-west8'
+    | 'europe-west9'
+    | 'me-west1'
+    | 'southamerica-east1'
+    | 'us-central1'
+    | 'us-east1'
+    | 'us-east4'
+    | 'us-south1'
+    | 'us-west1';
+}
+
 export namespace ScheduleResource {
   export import Schedule = ScheduleAPI.Schedule;
   export import ScheduleCreateResponse = ScheduleAPI.ScheduleCreateResponse;
+  export import ScheduleDeleteResponse = ScheduleAPI.ScheduleDeleteResponse;
   export import ScheduleCreateParams = ScheduleAPI.ScheduleCreateParams;
+  export import ScheduleDeleteParams = ScheduleAPI.ScheduleDeleteParams;
+  export import ScheduleGetParams = ScheduleAPI.ScheduleGetParams;
 }

package/src/resources/speed/speed.ts

@@ -1,68 +1,14 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../../core";
 import { APIResource } from "../../resource";
 import * as AvailabilitiesAPI from "./availabilities";
-import * as PagesAPI from "./pages";
 import * as ScheduleAPI from "./schedule";
-import * as TestsAPI from "./tests";
+import * as PagesAPI from "./pages/pages";
 
 export class Speed extends APIResource {
-  tests: TestsAPI.Tests = new TestsAPI.Tests(this._client);
   schedule: ScheduleAPI.ScheduleResource = new ScheduleAPI.ScheduleResource(this._client);
   availabilities: AvailabilitiesAPI.Availabilities = new AvailabilitiesAPI.Availabilities(this._client);
   pages: PagesAPI.Pages = new PagesAPI.Pages(this._client);
-
-  /**
-   * Deletes a scheduled test for a page.
-   */
-  delete(
-    url: string,
-    params: SpeedDeleteParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<SpeedDeleteResponse> {
-    const { zone_id, region } = params;
-    return (
-      this._client.delete(`/zones/${zone_id}/speed_api/schedule/${url}`, {
-        query: { region },
-        ...options,
-      }) as Core.APIPromise<{ result: SpeedDeleteResponse }>
-    )._thenUnwrap((obj) => obj.result);
-  }
-
-  /**
-   * Retrieves the test schedule for a page in a specific region.
-   */
-  scheduleGet(
-    url: string,
-    params: SpeedScheduleGetParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ScheduleAPI.Schedule> {
-    const { zone_id, ...query } = params;
-    return (
-      this._client.get(`/zones/${zone_id}/speed_api/schedule/${url}`, {
-        query,
-        ...options,
-      }) as Core.APIPromise<{ result: ScheduleAPI.Schedule }>
-    )._thenUnwrap((obj) => obj.result);
-  }
-
-  /**
-   * Lists the core web vital metrics trend over time for a specific page.
-   */
-  trendsList(
-    url: string,
-    params: SpeedTrendsListParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<Trend> {
-    const { zone_id, ...query } = params;
-    return (
-      this._client.get(`/zones/${zone_id}/speed_api/pages/${url}/trend`, {
-        query,
-        ...options,
-      }) as Core.APIPromise<{ result: Trend }>
-    )._thenUnwrap((obj) => obj.result);
-  }
 }
 
 /**
@@ -221,150 +167,14 @@ export interface Trend {
   tti?: Array<number | null>;
 }
 
-export interface SpeedDeleteResponse {
-  /**
-   * Number of items affected.
-   */
-  count?: number;
-}
-
-export interface SpeedDeleteParams {
-  /**
-   * Path param: Identifier
-   */
-  zone_id: string;
-
-  /**
-   * Query param: A test region.
-   */
-  region?:
-    | 'asia-east1'
-    | 'asia-northeast1'
-    | 'asia-northeast2'
-    | 'asia-south1'
-    | 'asia-southeast1'
-    | 'australia-southeast1'
-    | 'europe-north1'
-    | 'europe-southwest1'
-    | 'europe-west1'
-    | 'europe-west2'
-    | 'europe-west3'
-    | 'europe-west4'
-    | 'europe-west8'
-    | 'europe-west9'
-    | 'me-west1'
-    | 'southamerica-east1'
-    | 'us-central1'
-    | 'us-east1'
-    | 'us-east4'
-    | 'us-south1'
-    | 'us-west1';
-}
-
-export interface SpeedScheduleGetParams {
-  /**
-   * Path param: Identifier
-   */
-  zone_id: string;
-
-  /**
-   * Query param: A test region.
-   */
-  region?:
-    | 'asia-east1'
-    | 'asia-northeast1'
-    | 'asia-northeast2'
-    | 'asia-south1'
-    | 'asia-southeast1'
-    | 'australia-southeast1'
-    | 'europe-north1'
-    | 'europe-southwest1'
-    | 'europe-west1'
-    | 'europe-west2'
-    | 'europe-west3'
-    | 'europe-west4'
-    | 'europe-west8'
-    | 'europe-west9'
-    | 'me-west1'
-    | 'southamerica-east1'
-    | 'us-central1'
-    | 'us-east1'
-    | 'us-east4'
-    | 'us-south1'
-    | 'us-west1';
-}
-
-export interface SpeedTrendsListParams {
-  /**
-   * Path param: Identifier
-   */
-  zone_id: string;
-
-  /**
-   * Query param: The type of device.
-   */
-  deviceType: 'DESKTOP' | 'MOBILE';
-
-  /**
-   * Query param: A comma-separated list of metrics to include in the results.
-   */
-  metrics: string;
-
-  /**
-   * Query param: A test region.
-   */
-  region:
-    | 'asia-east1'
-    | 'asia-northeast1'
-    | 'asia-northeast2'
-    | 'asia-south1'
-    | 'asia-southeast1'
-    | 'australia-southeast1'
-    | 'europe-north1'
-    | 'europe-southwest1'
-    | 'europe-west1'
-    | 'europe-west2'
-    | 'europe-west3'
-    | 'europe-west4'
-    | 'europe-west8'
-    | 'europe-west9'
-    | 'me-west1'
-    | 'southamerica-east1'
-    | 'us-central1'
-    | 'us-east1'
-    | 'us-east4'
-    | 'us-south1'
-    | 'us-west1';
-
-  /**
-   * Query param:
-   */
-  start: string;
-
-  /**
-   * Query param: The timezone of the start and end timestamps.
-   */
-  tz: string;
-
-  /**
-   * Query param:
-   */
-  end?: string;
-}
-
 export namespace Speed {
-  export import Tests = TestsAPI.Tests;
-  export import Test = TestsAPI.Test;
-  export import TestListResponse = TestsAPI.TestListResponse;
-  export import TestDeleteResponse = TestsAPI.TestDeleteResponse;
-  export import TestCreateParams = TestsAPI.TestCreateParams;
-  export import TestListParams = TestsAPI.TestListParams;
-  export import TestDeleteParams = TestsAPI.TestDeleteParams;
-  export import TestGetParams = TestsAPI.TestGetParams;
   export import ScheduleResource = ScheduleAPI.ScheduleResource;
   export import Schedule = ScheduleAPI.Schedule;
   export import ScheduleCreateResponse = ScheduleAPI.ScheduleCreateResponse;
+  export import ScheduleDeleteResponse = ScheduleAPI.ScheduleDeleteResponse;
   export import ScheduleCreateParams = ScheduleAPI.ScheduleCreateParams;
+  export import ScheduleDeleteParams = ScheduleAPI.ScheduleDeleteParams;
+  export import ScheduleGetParams = ScheduleAPI.ScheduleGetParams;
   export import Availabilities = AvailabilitiesAPI.Availabilities;
   export import Availability = AvailabilitiesAPI.Availability;
   export import AvailabilityListParams = AvailabilitiesAPI.AvailabilityListParams;
@@ -372,4 +182,5 @@ export namespace Speed {
   export import PageListResponse = PagesAPI.PageListResponse;
   export import PageListResponsesSinglePage = PagesAPI.PageListResponsesSinglePage;
   export import PageListParams = PagesAPI.PageListParams;
+  export import PageTrendParams = PagesAPI.PageTrendParams;
 }

package/src/resources/ssl/analyze.ts

@@ -34,7 +34,7 @@ export interface AnalyzeCreateParams {
    * bundle uses the shortest chain and newest intermediates. And the force bundle
    * verifies the chain, but does not otherwise modify it.
    */
-  bundle_method?: CustomHostnamesAPI.BundleMethod;
+  bundle_method?: CustomHostnamesAPI.BundleMethodParam;
 
   /**
    * Body param: The zone's SSL certificate or certificate and the intermediate(s).

package/src/resources/ssl/certificate-packs/certificate-packs.ts

@@ -34,12 +34,12 @@ export class CertificatePacks extends APIResource {
     params: CertificatePackDeleteParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<CertificatePackDeleteResponse> {
-    const { zone_id, body } = params;
+    const { zone_id } = params;
     return (
-      this._client.delete(`/zones/${zone_id}/ssl/certificate_packs/${certificatePackId}`, {
-        body: body,
-        ...options,
-      }) as Core.APIPromise<{ result: CertificatePackDeleteResponse }>
+      this._client.delete(
+        `/zones/${zone_id}/ssl/certificate_packs/${certificatePackId}`,
+        options,
+      ) as Core.APIPromise<{ result: CertificatePackDeleteResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -84,6 +84,49 @@ export class CertificatePackListResponsesSinglePage extends SinglePage<Certifica
 
 export type Host = string;
 
+export type HostParam = string;
+
+/**
+ * The number of days for which the certificate should be valid.
+ */
+export type RequestValidity = 7 | 30 | 90 | 365 | 730 | 1095 | 5475;
+
+/**
+ * The number of days for which the certificate should be valid.
+ */
+export type RequestValidityParam = 7 | 30 | 90 | 365 | 730 | 1095 | 5475;
+
+/**
+ * Status of certificate pack.
+ */
+export type Status =
+  | 'initializing'
+  | 'pending_validation'
+  | 'deleted'
+  | 'pending_issuance'
+  | 'pending_deployment'
+  | 'pending_deletion'
+  | 'pending_expiration'
+  | 'expired'
+  | 'active'
+  | 'initializing_timed_out'
+  | 'validation_timed_out'
+  | 'issuance_timed_out'
+  | 'deployment_timed_out'
+  | 'deletion_timed_out'
+  | 'pending_cleanup'
+  | 'staging_deployment'
+  | 'staging_active'
+  | 'deactivating'
+  | 'inactive'
+  | 'backup_issued'
+  | 'holding_deployment';
+
+/**
+ * Validation method in use for a certificate pack order.
+ */
+export type ValidationMethod = 'http' | 'cname' | 'txt';
+
 export type CertificatePackListResponse = unknown;
 
 export interface CertificatePackDeleteResponse {
@@ -121,28 +164,7 @@ export interface CertificatePackEditResponse {
   /**
    * Status of certificate pack.
    */
-  status?:
-    | 'initializing'
-    | 'pending_validation'
-    | 'deleted'
-    | 'pending_issuance'
-    | 'pending_deployment'
-    | 'pending_deletion'
-    | 'pending_expiration'
-    | 'expired'
-    | 'active'
-    | 'initializing_timed_out'
-    | 'validation_timed_out'
-    | 'issuance_timed_out'
-    | 'deployment_timed_out'
-    | 'deletion_timed_out'
-    | 'pending_cleanup'
-    | 'staging_deployment'
-    | 'staging_active'
-    | 'deactivating'
-    | 'inactive'
-    | 'backup_issued'
-    | 'holding_deployment';
+  status?: Status;
 
   /**
    * Type of certificate pack.
@@ -176,14 +198,9 @@ export interface CertificatePackListParams {
 
 export interface CertificatePackDeleteParams {
   /**
-   * Path param: Identifier
+   * Identifier
    */
   zone_id: string;
-
-  /**
-   * Body param:
-   */
-  body: unknown;
 }
 
 export interface CertificatePackEditParams {
@@ -207,6 +224,9 @@ export interface CertificatePackGetParams {
 
 export namespace CertificatePacks {
   export import Host = CertificatePacksAPI.Host;
+  export import RequestValidity = CertificatePacksAPI.RequestValidity;
+  export import Status = CertificatePacksAPI.Status;
+  export import ValidationMethod = CertificatePacksAPI.ValidationMethod;
   export import CertificatePackListResponse = CertificatePacksAPI.CertificatePackListResponse;
   export import CertificatePackDeleteResponse = CertificatePacksAPI.CertificatePackDeleteResponse;
   export import CertificatePackEditResponse = CertificatePacksAPI.CertificatePackEditResponse;

package/src/resources/ssl/certificate-packs/index.ts

@@ -2,6 +2,9 @@
 
 export {
   Host,
+  RequestValidity,
+  Status,
+  ValidationMethod,
   CertificatePackListResponse,
   CertificatePackDeleteResponse,
   CertificatePackEditResponse,

package/src/resources/ssl/certificate-packs/order.ts

@@ -48,28 +48,7 @@ export interface OrderCreateResponse {
   /**
    * Status of certificate pack.
    */
-  status?:
-    | 'initializing'
-    | 'pending_validation'
-    | 'deleted'
-    | 'pending_issuance'
-    | 'pending_deployment'
-    | 'pending_deletion'
-    | 'pending_expiration'
-    | 'expired'
-    | 'active'
-    | 'initializing_timed_out'
-    | 'validation_timed_out'
-    | 'issuance_timed_out'
-    | 'deployment_timed_out'
-    | 'deletion_timed_out'
-    | 'pending_cleanup'
-    | 'staging_deployment'
-    | 'staging_active'
-    | 'deactivating'
-    | 'inactive'
-    | 'backup_issued'
-    | 'holding_deployment';
+  status?: CertificatePacksAPI.Status;
 
   /**
    * Type of certificate pack.
@@ -105,7 +84,7 @@ export interface OrderCreateParams {
    * Must contain the zone apex, may not contain more than 50 hosts, and may not be
    * empty.
    */
-  hosts: Array<CertificatePacksAPI.Host>;
+  hosts: Array<CertificatePacksAPI.HostParam>;
 
   /**
    * Body param: Type of certificate pack.