cloudflare 6.3.0 → 6.5.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/cloudforce-one/threat-events/datasets/datasets.ts

@@ -41,8 +41,8 @@ export class Datasets extends APIResource {
    * ```
    */
   list(params: DatasetListParams, options?: Core.RequestOptions): Core.APIPromise<DatasetListResponse> {
-    const { account_id } = params;
-    return this._client.get(`/accounts/${account_id}/cloudforce-one/events/dataset`, options);
+    const { account_id, ...query } = params;
+    return this._client.get(`/accounts/${account_id}/cloudforce-one/events/dataset`, { query, ...options });
   }
 
   /**
@@ -128,6 +128,8 @@ export interface DatasetCreateResponse {
   name: string;
 
   uuid: string;
+
+  deletedAt?: string;
 }
 
 export type DatasetListResponse = Array<DatasetListResponse.DatasetListResponseItem>;
@@ -139,6 +141,8 @@ export namespace DatasetListResponse {
     name: string;
 
     uuid: string;
+
+    deletedAt?: string;
   }
 }
 
@@ -148,6 +152,8 @@ export interface DatasetEditResponse {
   name: string;
 
   uuid: string;
+
+  deletedAt?: string;
 }
 
 export interface DatasetGetResponse {
@@ -156,6 +162,8 @@ export interface DatasetGetResponse {
   name: string;
 
   uuid: string;
+
+  deletedAt?: string;
 }
 
 export interface DatasetRawResponse {
@@ -192,9 +200,15 @@ export interface DatasetCreateParams {
 
 export interface DatasetListParams {
   /**
-   * Account ID.
+   * Path param: Account ID.
    */
   account_id: string;
+
+  /**
+   * Query param: When true, include soft-deleted datasets in the response. Each item
+   * includes a `deletedAt` field (ISO 8601 or null). Default: false.
+   */
+  includeDeleted?: boolean;
 }
 
 export interface DatasetEditParams {

package/src/resources/cloudforce-one/threat-events/tags.ts

@@ -34,6 +34,12 @@ export interface TagCreateResponse {
 
   actorCategory?: string;
 
+  /**
+   * Structured aliases ({ value, confidence 1-10, tlp }). CFONE-only: stripped from
+   * responses to non-CFONE accounts.
+   */
+  aliases?: Array<TagCreateResponse.Alias>;
+
   aliasGroupNames?: Array<string>;
 
   aliasGroupNamesInternal?: Array<string>;
@@ -42,14 +48,24 @@ export interface TagCreateResponse {
 
   attributionConfidence?: string;
 
+  attributionConfidenceScore?: number;
+
   attributionOrganization?: string;
 
   categoryName?: string;
 
   categoryUuid?: string;
 
+  dateOfDiscovery?: string;
+
   externalReferenceLinks?: Array<string>;
 
+  /**
+   * Internal structured aliases ({ value, confidence 1-10, tlp }). CFONE-only: never
+   * returned to non-CFONE accounts.
+   */
+  internalAliases?: Array<TagCreateResponse.InternalAlias>;
+
   internalDescription?: string;
 
   motive?: string;
@@ -58,11 +74,31 @@ export interface TagCreateResponse {
 
   originCountryISO?: string;
 
+  originCountryISOAlpha3?: string;
+
   priority?: number;
 
   sophisticationLevel?: string;
 }
 
+export namespace TagCreateResponse {
+  export interface Alias {
+    value: string;
+
+    confidence?: number | null;
+
+    tlp?: 'red' | 'amber' | 'green' | 'white' | null;
+  }
+
+  export interface InternalAlias {
+    value: string;
+
+    confidence?: number | null;
+
+    tlp?: 'red' | 'amber' | 'green' | 'white' | null;
+  }
+}
+
 export interface TagCreateParams {
   /**
    * Path param: Account ID.
@@ -80,10 +116,18 @@ export interface TagCreateParams {
   activeDuration?: string;
 
   /**
-   * Body param
+   * Body param: Actor variety. Allowed values: Activist, Competitor, Customer, Crime
+   * Syndicate, Former Employee, Nation State, Organized Crime, Nation State
+   * Affiliated, Terrorist, Unaffiliated.
    */
   actorCategory?: string;
 
+  /**
+   * Body param: Structured aliases ({ value, confidence 1-10, tlp }). CFONE-only:
+   * stripped from responses to non-CFONE accounts.
+   */
+  aliases?: Array<TagCreateParams.Alias>;
+
   /**
    * Body param
    */
@@ -104,6 +148,11 @@ export interface TagCreateParams {
    */
   attributionConfidence?: string;
 
+  /**
+   * Body param
+   */
+  attributionConfidenceScore?: number;
+
   /**
    * Body param
    */
@@ -114,18 +163,30 @@ export interface TagCreateParams {
    */
   categoryUuid?: string;
 
+  /**
+   * Body param: Date the actor was discovered (ISO YYYY-MM-DD).
+   */
+  dateOfDiscovery?: string;
+
   /**
    * Body param
    */
   externalReferenceLinks?: Array<string>;
 
+  /**
+   * Body param: Internal structured aliases ({ value, confidence 1-10, tlp }).
+   * CFONE-only: never returned to non-CFONE accounts.
+   */
+  internalAliases?: Array<TagCreateParams.InternalAlias>;
+
   /**
    * Body param
    */
   internalDescription?: string;
 
   /**
-   * Body param
+   * Body param: Actor motive. Allowed values: Convenience, Fear, Fun, Financial,
+   * Grudge, Ideology, Espionage.
    */
   motive?: string;
 
@@ -150,6 +211,24 @@ export interface TagCreateParams {
   sophisticationLevel?: string;
 }
 
+export namespace TagCreateParams {
+  export interface Alias {
+    value: string;
+
+    confidence?: number | null;
+
+    tlp?: 'red' | 'amber' | 'green' | 'white' | null;
+  }
+
+  export interface InternalAlias {
+    value: string;
+
+    confidence?: number | null;
+
+    tlp?: 'red' | 'amber' | 'green' | 'white' | null;
+  }
+}
+
 export declare namespace Tags {
   export { type TagCreateResponse as TagCreateResponse, type TagCreateParams as TagCreateParams };
 }

package/src/resources/cloudforce-one/threat-events/threat-events.ts

@@ -204,6 +204,8 @@ export interface ThreatEventCreateResponse {
 
   attackerCountry: string;
 
+  attackerCountryAlpha3: string;
+
   category: string;
 
   datasetId: string;
@@ -244,6 +246,8 @@ export interface ThreatEventCreateResponse {
 
   targetCountry: string;
 
+  targetCountryAlpha3: string;
+
   targetIndustry: string;
 
   tlp: string;
@@ -263,6 +267,8 @@ export namespace ThreatEventListResponse {
 
     attackerCountry: string;
 
+    attackerCountryAlpha3: string;
+
     category: string;
 
     datasetId: string;
@@ -303,6 +309,8 @@ export namespace ThreatEventListResponse {
 
     targetCountry: string;
 
+    targetCountryAlpha3: string;
+
     targetIndustry: string;
 
     tlp: string;
@@ -392,6 +400,8 @@ export interface ThreatEventEditResponse {
 
   attackerCountry: string;
 
+  attackerCountryAlpha3: string;
+
   category: string;
 
   datasetId: string;
@@ -432,6 +442,8 @@ export interface ThreatEventEditResponse {
 
   targetCountry: string;
 
+  targetCountryAlpha3: string;
+
   targetIndustry: string;
 
   tlp: string;
@@ -448,6 +460,8 @@ export interface ThreatEventGetResponse {
 
   attackerCountry: string;
 
+  attackerCountryAlpha3: string;
+
   category: string;
 
   datasetId: string;
@@ -488,6 +502,8 @@ export interface ThreatEventGetResponse {
 
   targetCountry: string;
 
+  targetCountryAlpha3: string;
+
   targetIndustry: string;
 
   tlp: string;

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>