cloudflare 3.1.0 → 3.2.0

package/src/resources/cache/cache-reserve.ts

@@ -93,6 +93,11 @@ export type CacheReserve = 'cache_reserve';
  */
 export type CacheReserveClear = 'cache_reserve_clear';
 
+/**
+ * The current state of the Cache Reserve Clear operation.
+ */
+export type State = 'In-progress' | 'Completed';
+
 /**
  * You can use Cache Reserve Clear to clear your Cache Reserve, but you must first
  * disable Cache Reserve. In most cases, this will be accomplished within 24 hours.
@@ -118,7 +123,7 @@ export interface CacheReserveClearResponse {
   /**
    * The current state of the Cache Reserve Clear operation.
    */
-  state: 'In-progress' | 'Completed';
+  state: State;
 
   /**
    * The time that the latest Cache Reserve Clear operation completed.
@@ -201,7 +206,7 @@ export interface CacheReserveStatusResponse {
   /**
    * The current state of the Cache Reserve Clear operation.
    */
-  state: 'In-progress' | 'Completed';
+  state: State;
 
   /**
    * The time that the latest Cache Reserve Clear operation completed.
@@ -250,6 +255,7 @@ export interface CacheReserveStatusParams {
 export namespace CacheReserveResource {
   export import CacheReserve = CacheReserveAPI.CacheReserve;
   export import CacheReserveClear = CacheReserveAPI.CacheReserveClear;
+  export import State = CacheReserveAPI.State;
   export import CacheReserveClearResponse = CacheReserveAPI.CacheReserveClearResponse;
   export import CacheReserveEditResponse = CacheReserveAPI.CacheReserveEditResponse;
   export import CacheReserveGetResponse = CacheReserveAPI.CacheReserveGetResponse;

package/src/resources/cache/cache.ts

@@ -146,6 +146,7 @@ export namespace Cache {
   export import CacheReserveResource = CacheReserveAPI.CacheReserveResource;
   export import CacheReserve = CacheReserveAPI.CacheReserve;
   export import CacheReserveClear = CacheReserveAPI.CacheReserveClear;
+  export import State = CacheReserveAPI.State;
   export import CacheReserveClearResponse = CacheReserveAPI.CacheReserveClearResponse;
   export import CacheReserveEditResponse = CacheReserveAPI.CacheReserveEditResponse;
   export import CacheReserveGetResponse = CacheReserveAPI.CacheReserveGetResponse;

package/src/resources/cache/index.ts

@@ -4,6 +4,7 @@ export { Cache } from './cache';
 export {
   CacheReserve,
   CacheReserveClear,
+  State,
   CacheReserveClearResponse,
   CacheReserveEditResponse,
   CacheReserveGetResponse,

package/src/resources/cache/smart-tiered-cache.ts

@@ -12,12 +12,12 @@ export class SmartTieredCache extends APIResource {
     params: SmartTieredCacheDeleteParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<SmartTieredCacheDeleteResponse> {
-    const { zone_id, body } = params;
+    const { zone_id } = params;
     return (
-      this._client.delete(`/zones/${zone_id}/cache/tiered_cache_smart_topology_enable`, {
-        body: body,
-        ...options,
-      }) as Core.APIPromise<{ result: SmartTieredCacheDeleteResponse }>
+      this._client.delete(
+        `/zones/${zone_id}/cache/tiered_cache_smart_topology_enable`,
+        options,
+      ) as Core.APIPromise<{ result: SmartTieredCacheDeleteResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -62,14 +62,9 @@ export type SmartTieredCacheGetResponse = unknown | string | null;
 
 export interface SmartTieredCacheDeleteParams {
   /**
-   * Path param: Identifier
+   * Identifier
    */
   zone_id: string;
-
-  /**
-   * Body param:
-   */
-  body: unknown;
 }
 
 export interface SmartTieredCacheEditParams {

package/src/resources/cache/variants.ts

@@ -13,9 +13,9 @@ export class Variants extends APIResource {
    * be indicated with BYPASS cache status in the response headers.
    */
   delete(params: VariantDeleteParams, options?: Core.RequestOptions): Core.APIPromise<CacheVariant> {
-    const { zone_id, body } = params;
+    const { zone_id } = params;
     return (
-      this._client.delete(`/zones/${zone_id}/cache/variants`, { body: body, ...options }) as Core.APIPromise<{
+      this._client.delete(`/zones/${zone_id}/cache/variants`, options) as Core.APIPromise<{
         result: CacheVariant;
       }>
     )._thenUnwrap((obj) => obj.result);
@@ -274,14 +274,9 @@ export namespace VariantGetResponse {
 
 export interface VariantDeleteParams {
   /**
-   * Path param: Identifier
+   * Identifier
    */
   zone_id: string;
-
-  /**
-   * Body param:
-   */
-  body: unknown;
 }
 
 export interface VariantEditParams {

package/src/resources/certificate-authorities/hostname-associations.ts

@@ -40,6 +40,8 @@ export class HostnameAssociations extends APIResource {
 
 export type HostnameAssociation = string;
 
+export type HostnameAssociationParam = string;
+
 export interface TLSHostnameAssociation {
   hostnames?: Array<HostnameAssociation>;
 
@@ -68,7 +70,7 @@ export interface HostnameAssociationUpdateParams {
   /**
    * Body param:
    */
-  hostnames?: Array<HostnameAssociation>;
+  hostnames?: Array<HostnameAssociationParam>;
 
   /**
    * Body param: The UUID for a certificate that was uploaded to the mTLS Certificate

package/src/resources/challenges/widgets.ts

@@ -171,6 +171,12 @@ export interface Widget {
  */
 export type WidgetDomain = string;
 
+/**
+ * Hosts as a hostname or IPv4/IPv6 address represented by strings. The widget will
+ * only work on these domains, and their subdomains.
+ */
+export type WidgetDomainParam = string;
+
 /**
  * A Turnstile Widgets configuration as it appears in listings
  */
@@ -236,7 +242,7 @@ export interface WidgetCreateParams {
   /**
    * Body param:
    */
-  domains: Array<WidgetDomain>;
+  domains: Array<WidgetDomainParam>;
 
   /**
    * Body param: Widget Mode
@@ -303,7 +309,7 @@ export interface WidgetUpdateParams {
   /**
    * Body param:
    */
-  domains: Array<WidgetDomain>;
+  domains: Array<WidgetDomainParam>;
 
   /**
    * Body param: Widget Mode

package/src/resources/client-certificates.ts

@@ -2,6 +2,7 @@
 
 import * as Core from "../core";
 import { APIResource } from "../resource";
+import * as CustomCertificatesAPI from "./custom-certificates/custom-certificates";
 import { V4PagePaginationArray, type V4PagePaginationArrayParams } from "../pagination";
 
 export class ClientCertificates extends APIResource {
@@ -177,7 +178,7 @@ export interface ClientCertificate {
    * Client Certificates may be active or revoked, and the pending_reactivation or
    * pending_revocation represent in-progress asynchronous transitions
    */
-  status?: 'active' | 'pending_reactivation' | 'pending_revocation' | 'revoked';
+  status?: CustomCertificatesAPI.Status;
 
   /**
    * The number of days the Client Certificate will be valid after the issued_on date

package/src/resources/cloudforce-one/requests/message.ts

@@ -3,6 +3,7 @@
 import * as Core from "../../../core";
 import { APIResource } from "../../../resource";
 import * as MessageAPI from "./message";
+import * as Shared from "../../shared";
 
 export class MessageResource extends APIResource {
   /**
@@ -51,12 +52,10 @@ export class MessageResource extends APIResource {
     messageIdentifer: number,
     options?: Core.RequestOptions,
   ): Core.APIPromise<MessageDeleteResponse> {
-    return (
-      this._client.delete(
-        `/accounts/${accountIdentifier}/cloudforce-one/requests/${requestIdentifier}/message/${messageIdentifer}`,
-        options,
-      ) as Core.APIPromise<{ result: MessageDeleteResponse }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.delete(
+      `/accounts/${accountIdentifier}/cloudforce-one/requests/${requestIdentifier}/message/${messageIdentifer}`,
+      options,
+    );
   }
 
   /**
@@ -109,7 +108,16 @@ export interface Message {
   created?: string;
 }
 
-export type MessageDeleteResponse = unknown | Array<unknown> | string;
+export interface MessageDeleteResponse {
+  errors: Array<Shared.ResponseInfo>;
+
+  messages: Array<Shared.ResponseInfo>;
+
+  /**
+   * Whether the API call was successful
+   */
+  success: true;
+}
 
 export type MessageGetResponse = Array<Message>;
 

package/src/resources/cloudforce-one/requests/priority.ts

@@ -3,6 +3,7 @@
 import * as Core from "../../../core";
 import { APIResource } from "../../../resource";
 import * as PriorityAPI from "./priority";
+import * as Shared from "../../shared";
 import * as RequestsAPI from "./requests";
 
 export class PriorityResource extends APIResource {
@@ -47,12 +48,10 @@ export class PriorityResource extends APIResource {
     priorityIdentifer: string,
     options?: Core.RequestOptions,
   ): Core.APIPromise<PriorityDeleteResponse> {
-    return (
-      this._client.delete(
-        `/accounts/${accountIdentifier}/cloudforce-one/requests/priority/${priorityIdentifer}`,
-        options,
-      ) as Core.APIPromise<{ result: PriorityDeleteResponse }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.delete(
+      `/accounts/${accountIdentifier}/cloudforce-one/requests/priority/${priorityIdentifer}`,
+      options,
+    );
   }
 
   /**
@@ -86,6 +85,8 @@ export class PriorityResource extends APIResource {
 
 export type Label = string;
 
+export type LabelParam = string;
+
 export interface Priority {
   /**
    * UUID
@@ -145,13 +146,22 @@ export interface PriorityEdit {
   tlp: 'clear' | 'amber' | 'amber-strict' | 'green' | 'red';
 }
 
-export type PriorityDeleteResponse = unknown | Array<unknown> | string;
+export interface PriorityDeleteResponse {
+  errors: Array<Shared.ResponseInfo>;
+
+  messages: Array<Shared.ResponseInfo>;
+
+  /**
+   * Whether the API call was successful
+   */
+  success: true;
+}
 
 export interface PriorityCreateParams {
   /**
    * List of labels
    */
-  labels: Array<Label>;
+  labels: Array<LabelParam>;
 
   /**
    * Priority
@@ -173,7 +183,7 @@ export interface PriorityUpdateParams {
   /**
    * List of labels
    */
-  labels: Array<Label>;
+  labels: Array<LabelParam>;
 
   /**
    * Priority

package/src/resources/cloudforce-one/requests/requests.ts

@@ -3,6 +3,7 @@
 import * as Core from "../../../core";
 import { APIResource } from "../../../resource";
 import * as RequestsAPI from "./requests";
+import * as Shared from "../../shared";
 import * as MessageAPI from "./message";
 import * as PriorityAPI from "./priority";
 import { V4PagePaginationArray, type V4PagePaginationArrayParams } from "../../../pagination";
@@ -71,12 +72,10 @@ export class Requests extends APIResource {
     requestIdentifier: string,
     options?: Core.RequestOptions,
   ): Core.APIPromise<RequestDeleteResponse> {
-    return (
-      this._client.delete(
-        `/accounts/${accountIdentifier}/cloudforce-one/requests/${requestIdentifier}`,
-        options,
-      ) as Core.APIPromise<{ result: RequestDeleteResponse }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.delete(
+      `/accounts/${accountIdentifier}/cloudforce-one/requests/${requestIdentifier}`,
+      options,
+    );
   }
 
   /**
@@ -280,7 +279,16 @@ export interface RequestConstants {
 
 export type RequestTypes = Array<string>;
 
-export type RequestDeleteResponse = unknown | Array<unknown> | string;
+export interface RequestDeleteResponse {
+  errors: Array<Shared.ResponseInfo>;
+
+  messages: Array<Shared.ResponseInfo>;
+
+  /**
+   * Whether the API call was successful
+   */
+  success: true;
+}
 
 export interface RequestCreateParams {
   /**

package/src/resources/custom-certificates/custom-certificates.ts

@@ -50,12 +50,12 @@ export class CustomCertificates extends APIResource {
     params: CustomCertificateDeleteParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<CustomCertificateDeleteResponse> {
-    const { zone_id, body } = params;
+    const { zone_id } = params;
     return (
-      this._client.delete(`/zones/${zone_id}/custom_certificates/${customCertificateId}`, {
-        body: body,
-        ...options,
-      }) as Core.APIPromise<{ result: CustomCertificateDeleteResponse }>
+      this._client.delete(
+        `/zones/${zone_id}/custom_certificates/${customCertificateId}`,
+        options,
+      ) as Core.APIPromise<{ result: CustomCertificateDeleteResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -197,6 +197,25 @@ export interface GeoRestrictions {
   label?: 'us' | 'eu' | 'highest_security';
 }
 
+/**
+ * Specify the region where your private key can be held locally for optimal TLS
+ * performance. HTTPS connections to any excluded data center will still be fully
+ * encrypted, but will incur some latency while Keyless SSL is used to complete the
+ * handshake with the nearest allowed data center. Options allow distribution to
+ * only to U.S. data centers, only to E.U. data centers, or only to highest
+ * security data centers. Default distribution is to all Cloudflare datacenters,
+ * for optimal performance.
+ */
+export interface GeoRestrictionsParam {
+  label?: 'us' | 'eu' | 'highest_security';
+}
+
+/**
+ * Client Certificates may be active or revoked, and the pending_reactivation or
+ * pending_revocation represent in-progress asynchronous transitions
+ */
+export type Status = 'active' | 'pending_reactivation' | 'pending_revocation' | 'revoked';
+
 export type CustomCertificateCreateResponse = unknown | string | null;
 
 export interface CustomCertificateDeleteResponse {
@@ -232,7 +251,7 @@ export interface CustomCertificateCreateParams {
    * 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: Specify the region where your private key can be held locally for
@@ -243,7 +262,7 @@ export interface CustomCertificateCreateParams {
    * highest security data centers. Default distribution is to all Cloudflare
    * datacenters, for optimal performance.
    */
-  geo_restrictions?: GeoRestrictions;
+  geo_restrictions?: GeoRestrictionsParam;
 
   /**
    * Body param: Specify the policy that determines the region where your private key
@@ -284,14 +303,9 @@ export interface CustomCertificateListParams extends V4PagePaginationArrayParams
 
 export interface CustomCertificateDeleteParams {
   /**
-   * Path param: Identifier
+   * Identifier
    */
   zone_id: string;
-
-  /**
-   * Body param:
-   */
-  body: unknown;
 }
 
 export interface CustomCertificateEditParams {
@@ -306,7 +320,7 @@ export interface CustomCertificateEditParams {
    * 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).
@@ -322,7 +336,7 @@ export interface CustomCertificateEditParams {
    * highest security data centers. Default distribution is to all Cloudflare
    * datacenters, for optimal performance.
    */
-  geo_restrictions?: GeoRestrictions;
+  geo_restrictions?: GeoRestrictionsParam;
 
   /**
    * Body param: Specify the policy that determines the region where your private key

package/src/resources/custom-hostnames/custom-hostnames.ts

@@ -3,6 +3,7 @@
 import * as Core from "../../core";
 import { APIResource } from "../../resource";
 import * as CustomHostnamesAPI from "./custom-hostnames";
+import * as Shared from "../shared";
 import * as FallbackOriginAPI from "./fallback-origin";
 import { V4PagePaginationArray, type V4PagePaginationArrayParams } from "../../pagination";
 
@@ -53,11 +54,8 @@ export class CustomHostnames extends APIResource {
     params: CustomHostnameDeleteParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<CustomHostnameDeleteResponse> {
-    const { zone_id, body } = params;
-    return this._client.delete(`/zones/${zone_id}/custom_hostnames/${customHostnameId}`, {
-      body: body,
-      ...options,
-    });
+    const { zone_id } = params;
+    return this._client.delete(`/zones/${zone_id}/custom_hostnames/${customHostnameId}`, options);
   }
 
   /**
@@ -107,6 +105,14 @@ export class CustomHostnameListResponsesV4PagePaginationArray extends V4PagePagi
  */
 export type BundleMethod = 'ubiquitous' | 'optimal' | 'force';
 
+/**
+ * A ubiquitous bundle has the highest probability of being verified everywhere,
+ * even by clients using outdated or unusual trust stores. An optimal bundle uses
+ * the shortest chain and newest intermediates. And the force bundle verifies the
+ * chain, but does not otherwise modify it.
+ */
+export type BundleMethodParam = 'ubiquitous' | 'optimal' | 'force';
+
 export interface CustomHostname {
   /**
    * Identifier
@@ -207,7 +213,7 @@ export namespace CustomHostname {
     /**
      * The Certificate Authority that will issue the certificate
      */
-    certificate_authority?: 'digicert' | 'google' | 'lets_encrypt';
+    certificate_authority?: Shared.CertificateCA;
 
     /**
      * If a custom uploaded certificate is used.
@@ -437,12 +443,23 @@ export namespace CustomHostname {
  */
 export type DCVMethod = 'http' | 'txt' | 'email';
 
+/**
+ * Domain control validation (DCV) method used for this hostname.
+ */
+export type DCVMethodParam = 'http' | 'txt' | 'email';
+
 /**
  * Level of validation to be used for this hostname. Domain validation (dv) must be
  * used.
  */
 export type DomainValidationType = 'dv';
 
+/**
+ * Level of validation to be used for this hostname. Domain validation (dv) must be
+ * used.
+ */
+export type DomainValidationTypeParam = 'dv';
+
 export interface CustomHostnameCreateResponse {
   /**
    * Identifier
@@ -543,7 +560,7 @@ export namespace CustomHostnameCreateResponse {
     /**
      * The Certificate Authority that will issue the certificate
      */
-    certificate_authority?: 'digicert' | 'google' | 'lets_encrypt';
+    certificate_authority?: Shared.CertificateCA;
 
     /**
      * If a custom uploaded certificate is used.
@@ -868,7 +885,7 @@ export namespace CustomHostnameListResponse {
     /**
      * The Certificate Authority that will issue the certificate
      */
-    certificate_authority?: 'digicert' | 'google' | 'lets_encrypt';
+    certificate_authority?: Shared.CertificateCA;
 
     /**
      * If a custom uploaded certificate is used.
@@ -1200,7 +1217,7 @@ export namespace CustomHostnameEditResponse {
     /**
      * The Certificate Authority that will issue the certificate
      */
-    certificate_authority?: 'digicert' | 'google' | 'lets_encrypt';
+    certificate_authority?: Shared.CertificateCA;
 
     /**
      * If a custom uploaded certificate is used.
@@ -1525,7 +1542,7 @@ export namespace CustomHostnameGetResponse {
     /**
      * The Certificate Authority that will issue the certificate
      */
-    certificate_authority?: 'digicert' | 'google' | 'lets_encrypt';
+    certificate_authority?: Shared.CertificateCA;
 
     /**
      * If a custom uploaded certificate is used.
@@ -1783,12 +1800,12 @@ export namespace CustomHostnameCreateParams {
      * 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;
 
     /**
      * The Certificate Authority that will issue the certificate
      */
-    certificate_authority?: 'digicert' | 'google' | 'lets_encrypt';
+    certificate_authority?: Shared.CertificateCAParam;
 
     /**
      * If a custom uploaded certificate is used.
@@ -1803,7 +1820,7 @@ export namespace CustomHostnameCreateParams {
     /**
      * Domain control validation (DCV) method used for this hostname.
      */
-    method?: CustomHostnamesAPI.DCVMethod;
+    method?: CustomHostnamesAPI.DCVMethodParam;
 
     /**
      * SSL specific settings.
@@ -1814,7 +1831,7 @@ export namespace CustomHostnameCreateParams {
      * Level of validation to be used for this hostname. Domain validation (dv) must be
      * used.
      */
-    type?: CustomHostnamesAPI.DomainValidationType;
+    type?: CustomHostnamesAPI.DomainValidationTypeParam;
 
     /**
      * Indicates whether the certificate covers a wildcard.
@@ -1903,14 +1920,9 @@ export interface CustomHostnameListParams extends V4PagePaginationArrayParams {
 
 export interface CustomHostnameDeleteParams {
   /**
-   * Path param: Identifier
+   * Identifier
    */
   zone_id: string;
-
-  /**
-   * Body param:
-   */
-  body: unknown;
 }
 
 export interface CustomHostnameEditParams {
@@ -1966,12 +1978,12 @@ export namespace CustomHostnameEditParams {
      * 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;
 
     /**
      * The Certificate Authority that will issue the certificate
      */
-    certificate_authority?: 'digicert' | 'google' | 'lets_encrypt';
+    certificate_authority?: Shared.CertificateCAParam;
 
     /**
      * If a custom uploaded certificate is used.
@@ -1986,7 +1998,7 @@ export namespace CustomHostnameEditParams {
     /**
      * Domain control validation (DCV) method used for this hostname.
      */
-    method?: CustomHostnamesAPI.DCVMethod;
+    method?: CustomHostnamesAPI.DCVMethodParam;
 
     /**
      * SSL specific settings.
@@ -1997,7 +2009,7 @@ export namespace CustomHostnameEditParams {
      * Level of validation to be used for this hostname. Domain validation (dv) must be
      * used.
      */
-    type?: CustomHostnamesAPI.DomainValidationType;
+    type?: CustomHostnamesAPI.DomainValidationTypeParam;
 
     /**
      * Indicates whether the certificate covers a wildcard.

package/src/resources/custom-hostnames/fallback-origin.ts

@@ -28,12 +28,11 @@ export class FallbackOrigin extends APIResource {
     params: FallbackOriginDeleteParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<FallbackOriginDeleteResponse> {
-    const { zone_id, body } = params;
+    const { zone_id } = params;
     return (
-      this._client.delete(`/zones/${zone_id}/custom_hostnames/fallback_origin`, {
-        body: body,
-        ...options,
-      }) as Core.APIPromise<{ result: FallbackOriginDeleteResponse }>
+      this._client.delete(`/zones/${zone_id}/custom_hostnames/fallback_origin`, options) as Core.APIPromise<{
+        result: FallbackOriginDeleteResponse;
+      }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -74,14 +73,9 @@ export interface FallbackOriginUpdateParams {
 
 export interface FallbackOriginDeleteParams {
   /**
-   * Path param: Identifier
+   * Identifier
    */
   zone_id: string;
-
-  /**
-   * Body param:
-   */
-  body: unknown;
 }
 
 export interface FallbackOriginGetParams {