cloudflare-api-js 0.12.0 → 0.12.1

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> cloudflare-api-js@0.12.0 build /home/runner/work/openapi-clients/openapi-clients/packages/cloudflare-api
+> cloudflare-api-js@0.12.1 build /home/runner/work/openapi-clients/openapi-clients/packages/cloudflare-api
 > unbuild
 
 [info] Automatically detected entries: src/index [esm] [cjs] [dts]

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # cloudflare-api-js
 
+## 0.12.1
+
+### Patch Changes
+
+- bdaac6f: Add x-auditable field to various types in schemas
+
 ## 0.12.0
 
 ### Minor Changes

package/dist/index.d.cts

@@ -29028,6 +29028,7 @@ type ObservatoryApiResponseCommon = {
      * Whether the API call was successful.
      *
      * @example true
+     * @x-auditable true
      */
     success: boolean;
 };
@@ -29053,6 +29054,7 @@ type ObservatoryAvailabilities = {
          * Cloudflare plan.
          *
          * @example free
+         * @x-auditable true
          */
         plan?: string;
         /**
@@ -29065,12 +29067,14 @@ type ObservatoryAvailabilities = {
          * The number of remaining schedules available.
          *
          * @example 1
+         * @x-auditable true
          */
         remainingSchedules?: number;
         /**
          * The number of remaining tests available.
          *
          * @example 30
+         * @x-auditable true
          */
         remainingTests?: number;
         /**
@@ -29100,6 +29104,7 @@ type ObservatoryCountResponse = ObservatoryApiResponseSingle & {
          * Number of items affected.
          *
          * @example 1
+         * @x-auditable true
          */
         count?: number;
     };
@@ -29114,6 +29119,7 @@ type ObservatoryCreateScheduleResponse = ObservatoryApiResponseSingle & {
  * The type of device.
  *
  * @example DESKTOP
+ * @x-auditable true
  */
 type ObservatoryDeviceType = 'DESKTOP' | 'MOBILE';
 /**
@@ -29129,6 +29135,7 @@ type ObservatoryIdentifier = string;
 type ObservatoryLabeledRegion = {
     /**
      * @example Iowa, USA
+     * @x-auditable true
      */
     label?: string;
     value?: ObservatoryRegion;
@@ -29137,6 +29144,7 @@ type ObservatoryLabeledRegion = {
  * The error code of the Lighthouse result.
  *
  * @example NOT_REACHABLE
+ * @x-auditable true
  */
 type ObservatoryLighthouseErrorCode = 'NOT_REACHABLE' | 'DNS_FAILURE' | 'NOT_HTML' | 'LIGHTHOUSE_TIMEOUT' | 'UNKNOWN';
 /**
@@ -29147,6 +29155,7 @@ type ObservatoryLighthouseReport = {
      * Cumulative Layout Shift.
      *
      * @example 100
+     * @x-auditable true
      */
     cls?: number;
     deviceType?: ObservatoryDeviceType;
@@ -29156,12 +29165,14 @@ type ObservatoryLighthouseReport = {
          * Detailed error message.
          *
          * @example Details: net::ERR_CONNECTION_CLOSED
+         * @x-auditable true
          */
         detail?: string;
         /**
          * The final URL displayed to the user.
          *
          * @example example.com
+         * @x-auditable true
          */
         finalDisplayedUrl?: string;
     };
@@ -29169,28 +29180,34 @@ type ObservatoryLighthouseReport = {
      * First Contentful Paint.
      *
      * @example 100
+     * @x-auditable true
      */
     fcp?: number;
     /**
      * The URL to the full Lighthouse JSON report.
+     *
+     * @x-auditable true
      */
     jsonReportUrl?: string;
     /**
      * Largest Contentful Paint.
      *
      * @example 100
+     * @x-auditable true
      */
     lcp?: number;
     /**
      * The Lighthouse performance score.
      *
      * @example 90
+     * @x-auditable true
      */
     performanceScore?: number;
     /**
      * Speed Index.
      *
      * @example 100
+     * @x-auditable true
      */
     si?: number;
     state?: ObservatoryLighthouseState;
@@ -29198,18 +29215,21 @@ type ObservatoryLighthouseReport = {
      * Total Blocking Time.
      *
      * @example 100
+     * @x-auditable true
      */
     tbt?: number;
     /**
      * Time To First Byte.
      *
      * @example 100
+     * @x-auditable true
      */
     ttfb?: number;
     /**
      * Time To Interactive.
      *
      * @example 100
+     * @x-auditable true
      */
     tti?: number;
 };
@@ -29217,13 +29237,18 @@ type ObservatoryLighthouseReport = {
  * The state of the Lighthouse report.
  *
  * @example COMPLETE
+ * @x-auditable true
  */
 type ObservatoryLighthouseState = 'RUNNING' | 'COMPLETE' | 'FAILED';
 type ObservatoryMessages = {
     /**
      * @minimum 1000
+     * @x-auditable true
      */
     code: number;
+    /**
+     * @x-auditable true
+     */
     message: string;
 }[];
 type ObservatoryPageTestResponseCollection = ObservatoryApiResponseCollection & {
@@ -29257,18 +29282,22 @@ type ObservatoryPagesResponseCollection = ObservatoryApiResponseCollection & {
 type ObservatoryPlanPropertiesInfo = {
     /**
      * @example 1
+     * @x-auditable true
      */
     business?: number;
     /**
      * @example 1
+     * @x-auditable true
      */
     enterprise?: number;
     /**
      * @example 1
+     * @x-auditable true
      */
     free?: number;
     /**
      * @example 1
+     * @x-auditable true
      */
     pro?: number;
 };
@@ -29276,23 +29305,28 @@ type ObservatoryPlanPropertiesInfo = {
  * A test region.
  *
  * @example us-central1
+ * @x-auditable true
  */
 type ObservatoryRegion = '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';
 type ObservatoryResultInfo = {
     /**
      * @example 5
+     * @x-auditable true
      */
     count?: number;
     /**
      * @example 1
+     * @x-auditable true
      */
     page?: number;
     /**
      * @example 5
+     * @x-auditable true
      */
     per_page?: number;
     /**
      * @example 3
+     * @x-auditable true
      */
     total_count?: number;
 };
@@ -29311,6 +29345,7 @@ type ObservatoryScheduleResponseSingle = ObservatoryApiResponseSingle & {
  * The frequency of the test.
  *
  * @example DAILY
+ * @x-auditable true
  */
 type ObservatoryScheduleFrequency = 'DAILY' | 'WEEKLY';
 type ObservatorySchemasMessages = {
@@ -29370,6 +29405,7 @@ type ObservatoryTrendResponse = ObservatoryApiResponseSingle & {
  * A URL.
  *
  * @example example.com
+ * @x-auditable true
  */
 type ObservatoryUrl = string;
 /**
@@ -151043,6 +151079,7 @@ type SpeedDeleteTestsQueryParams = {
      * A test region.
      *
      * @example us-central1
+     * @x-auditable true
      * @default us-central1
      */
     region?: ObservatoryRegion & void;
@@ -151078,6 +151115,7 @@ type SpeedListTestHistoryQueryParams = {
      * A test region.
      *
      * @example us-central1
+     * @x-auditable true
      * @default us-central1
      */
     region?: ObservatoryRegion & void;
@@ -151107,6 +151145,7 @@ type SpeedCreateTestRequestBody = {
      * A test region.
      *
      * @example us-central1
+     * @x-auditable true
      * @default us-central1
      */
     region?: ObservatoryRegion & void;
@@ -151176,6 +151215,7 @@ type SpeedDeleteTestScheduleQueryParams = {
      * A test region.
      *
      * @example us-central1
+     * @x-auditable true
      * @default us-central1
      */
     region?: ObservatoryRegion & void;
@@ -151201,6 +151241,7 @@ type SpeedGetScheduledTestQueryParams = {
      * A test region.
      *
      * @example us-central1
+     * @x-auditable true
      * @default us-central1
      */
     region?: ObservatoryRegion & void;
@@ -151226,6 +151267,7 @@ type SpeedCreateScheduledTestQueryParams = {
      * A test region.
      *
      * @example us-central1
+     * @x-auditable true
      * @default us-central1
      */
     region?: ObservatoryRegion & void;

package/dist/index.d.mts

@@ -29028,6 +29028,7 @@ type ObservatoryApiResponseCommon = {
      * Whether the API call was successful.
      *
      * @example true
+     * @x-auditable true
      */
     success: boolean;
 };
@@ -29053,6 +29054,7 @@ type ObservatoryAvailabilities = {
          * Cloudflare plan.
          *
          * @example free
+         * @x-auditable true
          */
         plan?: string;
         /**
@@ -29065,12 +29067,14 @@ type ObservatoryAvailabilities = {
          * The number of remaining schedules available.
          *
          * @example 1
+         * @x-auditable true
          */
         remainingSchedules?: number;
         /**
          * The number of remaining tests available.
          *
          * @example 30
+         * @x-auditable true
          */
         remainingTests?: number;
         /**
@@ -29100,6 +29104,7 @@ type ObservatoryCountResponse = ObservatoryApiResponseSingle & {
          * Number of items affected.
          *
          * @example 1
+         * @x-auditable true
          */
         count?: number;
     };
@@ -29114,6 +29119,7 @@ type ObservatoryCreateScheduleResponse = ObservatoryApiResponseSingle & {
  * The type of device.
  *
  * @example DESKTOP
+ * @x-auditable true
  */
 type ObservatoryDeviceType = 'DESKTOP' | 'MOBILE';
 /**
@@ -29129,6 +29135,7 @@ type ObservatoryIdentifier = string;
 type ObservatoryLabeledRegion = {
     /**
      * @example Iowa, USA
+     * @x-auditable true
      */
     label?: string;
     value?: ObservatoryRegion;
@@ -29137,6 +29144,7 @@ type ObservatoryLabeledRegion = {
  * The error code of the Lighthouse result.
  *
  * @example NOT_REACHABLE
+ * @x-auditable true
  */
 type ObservatoryLighthouseErrorCode = 'NOT_REACHABLE' | 'DNS_FAILURE' | 'NOT_HTML' | 'LIGHTHOUSE_TIMEOUT' | 'UNKNOWN';
 /**
@@ -29147,6 +29155,7 @@ type ObservatoryLighthouseReport = {
      * Cumulative Layout Shift.
      *
      * @example 100
+     * @x-auditable true
      */
     cls?: number;
     deviceType?: ObservatoryDeviceType;
@@ -29156,12 +29165,14 @@ type ObservatoryLighthouseReport = {
          * Detailed error message.
          *
          * @example Details: net::ERR_CONNECTION_CLOSED
+         * @x-auditable true
          */
         detail?: string;
         /**
          * The final URL displayed to the user.
          *
          * @example example.com
+         * @x-auditable true
          */
         finalDisplayedUrl?: string;
     };
@@ -29169,28 +29180,34 @@ type ObservatoryLighthouseReport = {
      * First Contentful Paint.
      *
      * @example 100
+     * @x-auditable true
      */
     fcp?: number;
     /**
      * The URL to the full Lighthouse JSON report.
+     *
+     * @x-auditable true
      */
     jsonReportUrl?: string;
     /**
      * Largest Contentful Paint.
      *
      * @example 100
+     * @x-auditable true
      */
     lcp?: number;
     /**
      * The Lighthouse performance score.
      *
      * @example 90
+     * @x-auditable true
      */
     performanceScore?: number;
     /**
      * Speed Index.
      *
      * @example 100
+     * @x-auditable true
      */
     si?: number;
     state?: ObservatoryLighthouseState;
@@ -29198,18 +29215,21 @@ type ObservatoryLighthouseReport = {
      * Total Blocking Time.
      *
      * @example 100
+     * @x-auditable true
      */
     tbt?: number;
     /**
      * Time To First Byte.
      *
      * @example 100
+     * @x-auditable true
      */
     ttfb?: number;
     /**
      * Time To Interactive.
      *
      * @example 100
+     * @x-auditable true
      */
     tti?: number;
 };
@@ -29217,13 +29237,18 @@ type ObservatoryLighthouseReport = {
  * The state of the Lighthouse report.
  *
  * @example COMPLETE
+ * @x-auditable true
  */
 type ObservatoryLighthouseState = 'RUNNING' | 'COMPLETE' | 'FAILED';
 type ObservatoryMessages = {
     /**
      * @minimum 1000
+     * @x-auditable true
      */
     code: number;
+    /**
+     * @x-auditable true
+     */
     message: string;
 }[];
 type ObservatoryPageTestResponseCollection = ObservatoryApiResponseCollection & {
@@ -29257,18 +29282,22 @@ type ObservatoryPagesResponseCollection = ObservatoryApiResponseCollection & {
 type ObservatoryPlanPropertiesInfo = {
     /**
      * @example 1
+     * @x-auditable true
      */
     business?: number;
     /**
      * @example 1
+     * @x-auditable true
      */
     enterprise?: number;
     /**
      * @example 1
+     * @x-auditable true
      */
     free?: number;
     /**
      * @example 1
+     * @x-auditable true
      */
     pro?: number;
 };
@@ -29276,23 +29305,28 @@ type ObservatoryPlanPropertiesInfo = {
  * A test region.
  *
  * @example us-central1
+ * @x-auditable true
  */
 type ObservatoryRegion = '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';
 type ObservatoryResultInfo = {
     /**
      * @example 5
+     * @x-auditable true
      */
     count?: number;
     /**
      * @example 1
+     * @x-auditable true
      */
     page?: number;
     /**
      * @example 5
+     * @x-auditable true
      */
     per_page?: number;
     /**
      * @example 3
+     * @x-auditable true
      */
     total_count?: number;
 };
@@ -29311,6 +29345,7 @@ type ObservatoryScheduleResponseSingle = ObservatoryApiResponseSingle & {
  * The frequency of the test.
  *
  * @example DAILY
+ * @x-auditable true
  */
 type ObservatoryScheduleFrequency = 'DAILY' | 'WEEKLY';
 type ObservatorySchemasMessages = {
@@ -29370,6 +29405,7 @@ type ObservatoryTrendResponse = ObservatoryApiResponseSingle & {
  * A URL.
  *
  * @example example.com
+ * @x-auditable true
  */
 type ObservatoryUrl = string;
 /**
@@ -151043,6 +151079,7 @@ type SpeedDeleteTestsQueryParams = {
      * A test region.
      *
      * @example us-central1
+     * @x-auditable true
      * @default us-central1
      */
     region?: ObservatoryRegion & void;
@@ -151078,6 +151115,7 @@ type SpeedListTestHistoryQueryParams = {
      * A test region.
      *
      * @example us-central1
+     * @x-auditable true
      * @default us-central1
      */
     region?: ObservatoryRegion & void;
@@ -151107,6 +151145,7 @@ type SpeedCreateTestRequestBody = {
      * A test region.
      *
      * @example us-central1
+     * @x-auditable true
      * @default us-central1
      */
     region?: ObservatoryRegion & void;
@@ -151176,6 +151215,7 @@ type SpeedDeleteTestScheduleQueryParams = {
      * A test region.
      *
      * @example us-central1
+     * @x-auditable true
      * @default us-central1
      */
     region?: ObservatoryRegion & void;
@@ -151201,6 +151241,7 @@ type SpeedGetScheduledTestQueryParams = {
      * A test region.
      *
      * @example us-central1
+     * @x-auditable true
      * @default us-central1
      */
     region?: ObservatoryRegion & void;
@@ -151226,6 +151267,7 @@ type SpeedCreateScheduledTestQueryParams = {
      * A test region.
      *
      * @example us-central1
+     * @x-auditable true
      * @default us-central1
      */
     region?: ObservatoryRegion & void;

package/dist/index.d.ts

@@ -29028,6 +29028,7 @@ type ObservatoryApiResponseCommon = {
      * Whether the API call was successful.
      *
      * @example true
+     * @x-auditable true
      */
     success: boolean;
 };
@@ -29053,6 +29054,7 @@ type ObservatoryAvailabilities = {
          * Cloudflare plan.
          *
          * @example free
+         * @x-auditable true
          */
         plan?: string;
         /**
@@ -29065,12 +29067,14 @@ type ObservatoryAvailabilities = {
          * The number of remaining schedules available.
          *
          * @example 1
+         * @x-auditable true
          */
         remainingSchedules?: number;
         /**
          * The number of remaining tests available.
          *
          * @example 30
+         * @x-auditable true
          */
         remainingTests?: number;
         /**
@@ -29100,6 +29104,7 @@ type ObservatoryCountResponse = ObservatoryApiResponseSingle & {
          * Number of items affected.
          *
          * @example 1
+         * @x-auditable true
          */
         count?: number;
     };
@@ -29114,6 +29119,7 @@ type ObservatoryCreateScheduleResponse = ObservatoryApiResponseSingle & {
  * The type of device.
  *
  * @example DESKTOP
+ * @x-auditable true
  */
 type ObservatoryDeviceType = 'DESKTOP' | 'MOBILE';
 /**
@@ -29129,6 +29135,7 @@ type ObservatoryIdentifier = string;
 type ObservatoryLabeledRegion = {
     /**
      * @example Iowa, USA
+     * @x-auditable true
      */
     label?: string;
     value?: ObservatoryRegion;
@@ -29137,6 +29144,7 @@ type ObservatoryLabeledRegion = {
  * The error code of the Lighthouse result.
  *
  * @example NOT_REACHABLE
+ * @x-auditable true
  */
 type ObservatoryLighthouseErrorCode = 'NOT_REACHABLE' | 'DNS_FAILURE' | 'NOT_HTML' | 'LIGHTHOUSE_TIMEOUT' | 'UNKNOWN';
 /**
@@ -29147,6 +29155,7 @@ type ObservatoryLighthouseReport = {
      * Cumulative Layout Shift.
      *
      * @example 100
+     * @x-auditable true
      */
     cls?: number;
     deviceType?: ObservatoryDeviceType;
@@ -29156,12 +29165,14 @@ type ObservatoryLighthouseReport = {
          * Detailed error message.
          *
          * @example Details: net::ERR_CONNECTION_CLOSED
+         * @x-auditable true
          */
         detail?: string;
         /**
          * The final URL displayed to the user.
          *
          * @example example.com
+         * @x-auditable true
          */
         finalDisplayedUrl?: string;
     };
@@ -29169,28 +29180,34 @@ type ObservatoryLighthouseReport = {
      * First Contentful Paint.
      *
      * @example 100
+     * @x-auditable true
      */
     fcp?: number;
     /**
      * The URL to the full Lighthouse JSON report.
+     *
+     * @x-auditable true
      */
     jsonReportUrl?: string;
     /**
      * Largest Contentful Paint.
      *
      * @example 100
+     * @x-auditable true
      */
     lcp?: number;
     /**
      * The Lighthouse performance score.
      *
      * @example 90
+     * @x-auditable true
      */
     performanceScore?: number;
     /**
      * Speed Index.
      *
      * @example 100
+     * @x-auditable true
      */
     si?: number;
     state?: ObservatoryLighthouseState;
@@ -29198,18 +29215,21 @@ type ObservatoryLighthouseReport = {
      * Total Blocking Time.
      *
      * @example 100
+     * @x-auditable true
      */
     tbt?: number;
     /**
      * Time To First Byte.
      *
      * @example 100
+     * @x-auditable true
      */
     ttfb?: number;
     /**
      * Time To Interactive.
      *
      * @example 100
+     * @x-auditable true
      */
     tti?: number;
 };
@@ -29217,13 +29237,18 @@ type ObservatoryLighthouseReport = {
  * The state of the Lighthouse report.
  *
  * @example COMPLETE
+ * @x-auditable true
  */
 type ObservatoryLighthouseState = 'RUNNING' | 'COMPLETE' | 'FAILED';
 type ObservatoryMessages = {
     /**
      * @minimum 1000
+     * @x-auditable true
      */
     code: number;
+    /**
+     * @x-auditable true
+     */
     message: string;
 }[];
 type ObservatoryPageTestResponseCollection = ObservatoryApiResponseCollection & {
@@ -29257,18 +29282,22 @@ type ObservatoryPagesResponseCollection = ObservatoryApiResponseCollection & {
 type ObservatoryPlanPropertiesInfo = {
     /**
      * @example 1
+     * @x-auditable true
      */
     business?: number;
     /**
      * @example 1
+     * @x-auditable true
      */
     enterprise?: number;
     /**
      * @example 1
+     * @x-auditable true
      */
     free?: number;
     /**
      * @example 1
+     * @x-auditable true
      */
     pro?: number;
 };
@@ -29276,23 +29305,28 @@ type ObservatoryPlanPropertiesInfo = {
  * A test region.
  *
  * @example us-central1
+ * @x-auditable true
  */
 type ObservatoryRegion = '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';
 type ObservatoryResultInfo = {
     /**
      * @example 5
+     * @x-auditable true
      */
     count?: number;
     /**
      * @example 1
+     * @x-auditable true
      */
     page?: number;
     /**
      * @example 5
+     * @x-auditable true
      */
     per_page?: number;
     /**
      * @example 3
+     * @x-auditable true
      */
     total_count?: number;
 };
@@ -29311,6 +29345,7 @@ type ObservatoryScheduleResponseSingle = ObservatoryApiResponseSingle & {
  * The frequency of the test.
  *
  * @example DAILY
+ * @x-auditable true
  */
 type ObservatoryScheduleFrequency = 'DAILY' | 'WEEKLY';
 type ObservatorySchemasMessages = {
@@ -29370,6 +29405,7 @@ type ObservatoryTrendResponse = ObservatoryApiResponseSingle & {
  * A URL.
  *
  * @example example.com
+ * @x-auditable true
  */
 type ObservatoryUrl = string;
 /**
@@ -151043,6 +151079,7 @@ type SpeedDeleteTestsQueryParams = {
      * A test region.
      *
      * @example us-central1
+     * @x-auditable true
      * @default us-central1
      */
     region?: ObservatoryRegion & void;
@@ -151078,6 +151115,7 @@ type SpeedListTestHistoryQueryParams = {
      * A test region.
      *
      * @example us-central1
+     * @x-auditable true
      * @default us-central1
      */
     region?: ObservatoryRegion & void;
@@ -151107,6 +151145,7 @@ type SpeedCreateTestRequestBody = {
      * A test region.
      *
      * @example us-central1
+     * @x-auditable true
      * @default us-central1
      */
     region?: ObservatoryRegion & void;
@@ -151176,6 +151215,7 @@ type SpeedDeleteTestScheduleQueryParams = {
      * A test region.
      *
      * @example us-central1
+     * @x-auditable true
      * @default us-central1
      */
     region?: ObservatoryRegion & void;
@@ -151201,6 +151241,7 @@ type SpeedGetScheduledTestQueryParams = {
      * A test region.
      *
      * @example us-central1
+     * @x-auditable true
      * @default us-central1
      */
     region?: ObservatoryRegion & void;
@@ -151226,6 +151267,7 @@ type SpeedCreateScheduledTestQueryParams = {
      * A test region.
      *
      * @example us-central1
+     * @x-auditable true
      * @default us-central1
      */
     region?: ObservatoryRegion & void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloudflare-api-js",
-  "version": "0.12.0",
+  "version": "0.12.1",
   "description": "Cloudflare auto-generated type-safe API client",
   "author": "SferaDev",
   "license": "ISC",