cloudflare 6.3.0 → 6.4.0

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

@@ -4,6 +4,36 @@ import { APIResource } from '../../resource';
 import * as Core from '../../core';
 
 export class SmartTieredCache extends APIResource {
+  /**
+   * Smart Tiered Cache dynamically selects the single closest upper tier for each of
+   * your website's origins with no configuration required, using our in-house
+   * performance and routing data. Cloudflare collects latency data for each request
+   * to an origin, and uses the latency data to determine how well any upper-tier
+   * data center is connected with an origin. As a result, Cloudflare can select the
+   * data center with the lowest latency to be the upper-tier for an origin.
+   *
+   * @example
+   * ```ts
+   * const smartTieredCache =
+   *   await client.cache.smartTieredCache.create({
+   *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *     value: 'on',
+   *   });
+   * ```
+   */
+  create(
+    params: SmartTieredCacheCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<SmartTieredCacheCreateResponse> {
+    const { zone_id, ...body } = params;
+    return (
+      this._client.post(`/zones/${zone_id}/cache/tiered_cache_smart_topology_enable`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: SmartTieredCacheCreateResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
   /**
    * Smart Tiered Cache dynamically selects the single closest upper tier for each of
    * your website’s origins with no configuration required, using our in-house
@@ -92,6 +122,28 @@ export class SmartTieredCache extends APIResource {
   }
 }
 
+export interface SmartTieredCacheCreateResponse {
+  /**
+   * The identifier of the caching setting.
+   */
+  id: 'tiered_cache_smart_topology_enable';
+
+  /**
+   * Whether the setting is editable.
+   */
+  editable: boolean;
+
+  /**
+   * Value of the Smart Tiered Cache zone setting.
+   */
+  value: 'on' | 'off';
+
+  /**
+   * Last time this setting was modified.
+   */
+  modified_on?: string | null;
+}
+
 export interface SmartTieredCacheDeleteResponse {
   /**
    * The identifier of the caching setting.
@@ -153,6 +205,18 @@ export interface SmartTieredCacheGetResponse {
   modified_on?: string | null;
 }
 
+export interface SmartTieredCacheCreateParams {
+  /**
+   * Path param: Identifier.
+   */
+  zone_id: string;
+
+  /**
+   * Body param: Enable or disable the Smart Tiered Cache.
+   */
+  value: 'on' | 'off';
+}
+
 export interface SmartTieredCacheDeleteParams {
   /**
    * Identifier.
@@ -181,9 +245,11 @@ export interface SmartTieredCacheGetParams {
 
 export declare namespace SmartTieredCache {
   export {
+    type SmartTieredCacheCreateResponse as SmartTieredCacheCreateResponse,
     type SmartTieredCacheDeleteResponse as SmartTieredCacheDeleteResponse,
     type SmartTieredCacheEditResponse as SmartTieredCacheEditResponse,
     type SmartTieredCacheGetResponse as SmartTieredCacheGetResponse,
+    type SmartTieredCacheCreateParams as SmartTieredCacheCreateParams,
     type SmartTieredCacheDeleteParams as SmartTieredCacheDeleteParams,
     type SmartTieredCacheEditParams as SmartTieredCacheEditParams,
     type SmartTieredCacheGetParams as SmartTieredCacheGetParams,

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

@@ -5,7 +5,7 @@ import * as Core from '../../core';
 
 export class HostnameAssociations extends APIResource {
   /**
-   * Replace Hostname Associations
+   * Replace Hostname Associations.
    */
   update(
     params: HostnameAssociationUpdateParams,
@@ -21,7 +21,7 @@ export class HostnameAssociations extends APIResource {
   }
 
   /**
-   * List Hostname Associations
+   * List Hostname Associations.
    */
   get(
     params: HostnameAssociationGetParams,

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

@@ -7,7 +7,7 @@ import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../p
 
 export class ClientCertificates extends APIResource {
   /**
-   * Create a new API Shield mTLS Client Certificate
+   * Create a new API Shield mTLS Client Certificate.
    *
    * @example
    * ```ts
@@ -33,7 +33,7 @@ export class ClientCertificates extends APIResource {
 
   /**
    * List all of your Zone's API Shield mTLS Client Certificates by Status and/or
-   * using Pagination
+   * using Pagination.
    *
    * @example
    * ```ts
@@ -112,7 +112,7 @@ export class ClientCertificates extends APIResource {
   }
 
   /**
-   * Get Details for a single mTLS API Shield Client Certificate
+   * Get Details for a single mTLS API Shield Client Certificate.
    *
    * @example
    * ```ts
@@ -147,22 +147,22 @@ export interface ClientCertificate {
   id?: string;
 
   /**
-   * The Client Certificate PEM
+   * The Client Certificate PEM.
    */
   certificate?: string;
 
   /**
-   * Certificate Authority used to issue the Client Certificate
+   * Certificate Authority used to issue the Client Certificate.
    */
   certificate_authority?: ClientCertificate.CertificateAuthority;
 
   /**
-   * Common Name of the Client Certificate
+   * Common Name of the Client Certificate.
    */
   common_name?: string;
 
   /**
-   * Country, provided by the CSR
+   * Country, provided by the CSR.
    */
   country?: string;
 
@@ -172,32 +172,32 @@ export interface ClientCertificate {
   csr?: string;
 
   /**
-   * Date that the Client Certificate expires
+   * Date that the Client Certificate expires.
    */
   expires_on?: string;
 
   /**
-   * Unique identifier of the Client Certificate
+   * Unique identifier of the Client Certificate.
    */
   fingerprint_sha256?: string;
 
   /**
-   * Date that the Client Certificate was issued by the Certificate Authority
+   * Date that the Client Certificate was issued by the Certificate Authority.
    */
   issued_on?: string;
 
   /**
-   * Location, provided by the CSR
+   * Location, provided by the CSR.
    */
   location?: string;
 
   /**
-   * Organization, provided by the CSR
+   * Organization, provided by the CSR.
    */
   organization?: string;
 
   /**
-   * Organizational Unit, provided by the CSR
+   * Organizational Unit, provided by the CSR.
    */
   organizational_unit?: string;
 
@@ -212,30 +212,31 @@ export interface ClientCertificate {
   signature?: string;
 
   /**
-   * Subject Key Identifier
+   * Subject Key Identifier.
    */
   ski?: string;
 
   /**
-   * State, provided by the CSR
+   * State, provided by the CSR.
    */
   state?: string;
 
   /**
    * Client Certificates may be active or revoked, and the pending_reactivation or
-   * pending_revocation represent in-progress asynchronous transitions
+   * pending_revocation represent in-progress asynchronous transitions.
    */
   status?: CustomCertificatesAPI.Status;
 
   /**
-   * The number of days the Client Certificate will be valid after the issued_on date
+   * The number of days the Client Certificate will be valid after the issued_on
+   * date.
    */
   validity_days?: number;
 }
 
 export namespace ClientCertificate {
   /**
-   * Certificate Authority used to issue the Client Certificate
+   * Certificate Authority used to issue the Client Certificate.
    */
   export interface CertificateAuthority {
     id?: string;
@@ -257,7 +258,7 @@ export interface ClientCertificateCreateParams {
 
   /**
    * Body param: The number of days the Client Certificate will be valid after the
-   * issued_on date
+   * issued_on date.
    */
   validity_days: number;
 }
@@ -274,7 +275,7 @@ export interface ClientCertificateListParams extends V4PagePaginationArrayParams
   limit?: number;
 
   /**
-   * Query param: Offset the results
+   * Query param: Offset the results.
    */
   offset?: number;
 

package/src/resources/cloudforce-one/binary-storage.ts

@@ -5,7 +5,8 @@ import * as Core from '../../core';
 
 export class BinaryStorage extends APIResource {
   /**
-   * Posts a file to Binary Storage
+   * Uploads a binary file to Cloudforce One's binary database for malware analysis
+   * and threat intelligence correlation.
    *
    * @example
    * ```ts
@@ -28,7 +29,7 @@ export class BinaryStorage extends APIResource {
   }
 
   /**
-   * Retrieves a file from Binary Storage
+   * Retrieves a binary file from the Cloudforce One binary storage for analysis.
    *
    * @example
    * ```ts

package/src/resources/csam-scanner/api.md

@@ -0,0 +1,11 @@
+# CsamScanner
+
+Types:
+
+- <code><a href="./src/resources/csam-scanner.ts">CsamScannerEditResponse</a></code>
+- <code><a href="./src/resources/csam-scanner.ts">CsamScannerGetResponse</a></code>
+
+Methods:
+
+- <code title="patch /zones/{zone_id}/settings/csam_scanner_third_party">client.csamScanner.<a href="./src/resources/csam-scanner.ts">edit</a>({ ...params }) -> CsamScannerEditResponse</code>
+- <code title="get /zones/{zone_id}/settings/csam_scanner_third_party">client.csamScanner.<a href="./src/resources/csam-scanner.ts">get</a>({ ...params }) -> CsamScannerGetResponse</code>

package/src/resources/csam-scanner/csam-scanner.ts

@@ -0,0 +1,244 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+
+export class CsamScanner extends APIResource {
+  /**
+   * Update the CSAM Scanner configuration for a zone. Allows enabling or disabling
+   * CSAM scanning, updating the notification email, and configuring scanning
+   * sources.
+   *
+   * When a new email is provided, email verification is triggered automatically. The
+   * `enabled` field is a toggle; the server may adjust it based on whether the
+   * notification email is verified.
+   *
+   * Returns 403 if the zone or account is locked by Trust & Safety.
+   *
+   * @example
+   * ```ts
+   * const response = await client.csamScanner.edit({
+   *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   * });
+   * ```
+   */
+  edit(
+    params: CsamScannerEditParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CsamScannerEditResponse> {
+    const { zone_id, ...body } = params;
+    return (
+      this._client.patch(`/zones/${zone_id}/settings/csam_scanner_third_party`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: CsamScannerEditResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Retrieve the current CSAM Scanner configuration for a zone.
+   *
+   * The notification email is masked by default in responses.
+   *
+   * @example
+   * ```ts
+   * const csamScanner = await client.csamScanner.get({
+   *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   * });
+   * ```
+   */
+  get(params: CsamScannerGetParams, options?: Core.RequestOptions): Core.APIPromise<CsamScannerGetResponse> {
+    const { zone_id } = params;
+    return (
+      this._client.get(`/zones/${zone_id}/settings/csam_scanner_third_party`, options) as Core.APIPromise<{
+        result: CsamScannerGetResponse;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+/**
+ * CSAM Scanner configuration for a zone.
+ */
+export interface CsamScannerEditResponse {
+  /**
+   * The feature identifier.
+   */
+  id?: 'csam_scanner';
+
+  /**
+   * Whether the feature state can be changed. When false, the zone or account may be
+   * locked by Trust & Safety.
+   */
+  editable?: boolean;
+
+  /**
+   * When the setting was last modified. Currently always null as the server does not
+   * populate this field.
+   */
+  modified_on?: string | null;
+
+  /**
+   * The CSAM Scanner feature configuration values. Contains the notification email
+   * and scanning enablement settings.
+   */
+  value?: CsamScannerEditResponse.Value;
+}
+
+export namespace CsamScannerEditResponse {
+  /**
+   * The CSAM Scanner feature configuration values. Contains the notification email
+   * and scanning enablement settings.
+   */
+  export interface Value {
+    /**
+     * Notification email address for CSAM scan results. Masked in responses unless
+     * explicitly unmasked via admin endpoint.
+     */
+    email?: string;
+
+    /**
+     * Current verification state of the notification email.
+     */
+    email_state?: 'valid' | 'pending' | 'unverified';
+
+    /**
+     * Whether CSAM scanning is enabled for this zone.
+     */
+    enabled?: boolean;
+
+    /**
+     * Map of scanning sources and their enabled state.
+     */
+    sources?: { [key: string]: boolean };
+
+    /**
+     * The zone's plan level.
+     */
+    zone_plan?: string;
+  }
+}
+
+/**
+ * CSAM Scanner configuration for a zone.
+ */
+export interface CsamScannerGetResponse {
+  /**
+   * The feature identifier.
+   */
+  id?: 'csam_scanner';
+
+  /**
+   * Whether the feature state can be changed. When false, the zone or account may be
+   * locked by Trust & Safety.
+   */
+  editable?: boolean;
+
+  /**
+   * When the setting was last modified. Currently always null as the server does not
+   * populate this field.
+   */
+  modified_on?: string | null;
+
+  /**
+   * The CSAM Scanner feature configuration values. Contains the notification email
+   * and scanning enablement settings.
+   */
+  value?: CsamScannerGetResponse.Value;
+}
+
+export namespace CsamScannerGetResponse {
+  /**
+   * The CSAM Scanner feature configuration values. Contains the notification email
+   * and scanning enablement settings.
+   */
+  export interface Value {
+    /**
+     * Notification email address for CSAM scan results. Masked in responses unless
+     * explicitly unmasked via admin endpoint.
+     */
+    email?: string;
+
+    /**
+     * Current verification state of the notification email.
+     */
+    email_state?: 'valid' | 'pending' | 'unverified';
+
+    /**
+     * Whether CSAM scanning is enabled for this zone.
+     */
+    enabled?: boolean;
+
+    /**
+     * Map of scanning sources and their enabled state.
+     */
+    sources?: { [key: string]: boolean };
+
+    /**
+     * The zone's plan level.
+     */
+    zone_plan?: string;
+  }
+}
+
+export interface CsamScannerEditParams {
+  /**
+   * Path param: Identifier for the zone.
+   */
+  zone_id: string;
+
+  /**
+   * Body param: The feature identifier.
+   */
+  id?: 'csam_scanner';
+
+  /**
+   * Body param: Writable CSAM Scanner feature configuration values.
+   */
+  value?: CsamScannerEditParams.Value;
+}
+
+export namespace CsamScannerEditParams {
+  /**
+   * Writable CSAM Scanner feature configuration values.
+   */
+  export interface Value {
+    /**
+     * Notification email address for CSAM scan results. When changed, email
+     * verification is triggered automatically.
+     */
+    email?: string;
+
+    /**
+     * Whether CSAM scanning is enabled for this zone.
+     */
+    enabled?: boolean;
+
+    /**
+     * Set to true to trigger re-sending the email verification. Write-only; never
+     * appears in responses (omitted when false).
+     */
+    resend_email?: boolean;
+
+    /**
+     * Map of scanning sources and their enabled state.
+     */
+    sources?: { [key: string]: boolean };
+  }
+}
+
+export interface CsamScannerGetParams {
+  /**
+   * Identifier for the zone.
+   */
+  zone_id: string;
+}
+
+export declare namespace CsamScanner {
+  export {
+    type CsamScannerEditResponse as CsamScannerEditResponse,
+    type CsamScannerGetResponse as CsamScannerGetResponse,
+    type CsamScannerEditParams as CsamScannerEditParams,
+    type CsamScannerGetParams as CsamScannerGetParams,
+  };
+}

package/src/resources/csam-scanner/index.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { CsamScanner } from './csam-scanner';

package/src/resources/csam-scanner.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './csam-scanner/index';

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

@@ -267,7 +267,7 @@ export interface GeoRestrictionsParam {
 
 /**
  * Client Certificates may be active or revoked, and the pending_reactivation or
- * pending_revocation represent in-progress asynchronous transitions
+ * pending_revocation represent in-progress asynchronous transitions.
  */
 export type Status = 'active' | 'pending_reactivation' | 'pending_revocation' | 'revoked';
 
@@ -303,7 +303,8 @@ export interface CustomCertificateCreateParams {
   custom_csr_id?: string;
 
   /**
-   * Body param: The environment to deploy the certificate to, defaults to production
+   * Body param: The environment to deploy the certificate to, defaults to
+   * production.
    */
   deploy?: 'staging' | 'production';
 
@@ -396,7 +397,8 @@ export interface CustomCertificateEditParams {
   custom_csr_id?: string;
 
   /**
-   * Body param: The environment to deploy the certificate to, defaults to production
+   * Body param: The environment to deploy the certificate to, defaults to
+   * production.
    */
   deploy?: 'staging' | 'production';
 

package/src/resources/custom-csrs/api.md

@@ -0,0 +1,16 @@
+# CustomCsrs
+
+Types:
+
+- <code><a href="./src/resources/custom-csrs.ts">CustomCsr</a></code>
+- <code><a href="./src/resources/custom-csrs.ts">CustomCsrCreateResponse</a></code>
+- <code><a href="./src/resources/custom-csrs.ts">CustomCsrListResponse</a></code>
+- <code><a href="./src/resources/custom-csrs.ts">CustomCsrDeleteResponse</a></code>
+- <code><a href="./src/resources/custom-csrs.ts">CustomCsrGetResponse</a></code>
+
+Methods:
+
+- <code title="post /{accounts_or_zones}/{account_or_zone_id}/custom_csrs">client.customCsrs.<a href="./src/resources/custom-csrs.ts">create</a>({ ...params }) -> CustomCsrCreateResponse</code>
+- <code title="get /{accounts_or_zones}/{account_or_zone_id}/custom_csrs">client.customCsrs.<a href="./src/resources/custom-csrs.ts">list</a>({ ...params }) -> CustomCsrListResponsesV4PagePaginationArray</code>
+- <code title="delete /{accounts_or_zones}/{account_or_zone_id}/custom_csrs/{custom_csr_id}">client.customCsrs.<a href="./src/resources/custom-csrs.ts">delete</a>(customCsrId, { ...params }) -> CustomCsrDeleteResponse</code>
+- <code title="get /{accounts_or_zones}/{account_or_zone_id}/custom_csrs/{custom_csr_id}">client.customCsrs.<a href="./src/resources/custom-csrs.ts">get</a>(customCsrId, { ...params }) -> CustomCsrGetResponse</code>