feat(api): api update (#2285)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
-configured_endpoints: 1490
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-85569f0482730af4e8c6afc9b33c7ba894e47b2d8fa36a3e013daf5390adb647.yml
+configured_endpoints: 1489
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-de7ae109130349e5b0b35b4d0944270435dfddb3ce7079da9b85f5dffaf86639.yml

api.md

@@ -615,12 +615,13 @@ Methods:
 Types:
 
 - <code><a href="./src/resources/cache/variants.ts">CacheVariant</a></code>
+- <code><a href="./src/resources/cache/variants.ts">VariantDeleteResponse</a></code>
 - <code><a href="./src/resources/cache/variants.ts">VariantEditResponse</a></code>
 - <code><a href="./src/resources/cache/variants.ts">VariantGetResponse</a></code>
 
 Methods:
 
-- <code title="delete /zones/{zone_id}/cache/variants">client.cache.variants.<a href="./src/resources/cache/variants.ts">delete</a>({ ...params }) -> CacheVariant</code>
+- <code title="delete /zones/{zone_id}/cache/variants">client.cache.variants.<a href="./src/resources/cache/variants.ts">delete</a>({ ...params }) -> VariantDeleteResponse</code>
 - <code title="patch /zones/{zone_id}/cache/variants">client.cache.variants.<a href="./src/resources/cache/variants.ts">edit</a>({ ...params }) -> VariantEditResponse</code>
 - <code title="get /zones/{zone_id}/cache/variants">client.cache.variants.<a href="./src/resources/cache/variants.ts">get</a>({ ...params }) -> VariantGetResponse</code>
 
@@ -4318,8 +4319,8 @@ Types:
 
 Methods:
 
-- <code title="patch /zones/{zone_id}/devices/policy/certificates">client.zeroTrust.devices.policies.default.certificates.<a href="./src/resources/zero-trust/devices/policies/default/certificates.ts">edit</a>({ ...params }) -> CertificateEditResponse</code>
-- <code title="get /zones/{zone_id}/devices/policy/certificates">client.zeroTrust.devices.policies.default.certificates.<a href="./src/resources/zero-trust/devices/policies/default/certificates.ts">get</a>({ ...params }) -> CertificateGetResponse</code>
+- <code title="patch /zones/{zone_id}/devices/policy/certificates">client.zeroTrust.devices.policies.default.certificates.<a href="./src/resources/zero-trust/devices/policies/default/certificates.ts">edit</a>({ ...params }) -> CertificateEditResponse | null</code>
+- <code title="get /zones/{zone_id}/devices/policy/certificates">client.zeroTrust.devices.policies.default.certificates.<a href="./src/resources/zero-trust/devices/policies/default/certificates.ts">get</a>({ ...params }) -> CertificateGetResponse | null</code>
 
 #### Custom
 
@@ -4414,7 +4415,7 @@ Methods:
 
 - <code title="post /accounts/{account_id}/devices/posture/integration">client.zeroTrust.devices.posture.integrations.<a href="./src/resources/zero-trust/devices/posture/integrations.ts">create</a>({ ...params }) -> Integration | null</code>
 - <code title="get /accounts/{account_id}/devices/posture/integration">client.zeroTrust.devices.posture.integrations.<a href="./src/resources/zero-trust/devices/posture/integrations.ts">list</a>({ ...params }) -> IntegrationsSinglePage</code>
-- <code title="delete /accounts/{account_id}/devices/posture/integration/{integration_id}">client.zeroTrust.devices.posture.integrations.<a href="./src/resources/zero-trust/devices/posture/integrations.ts">delete</a>(integrationId, { ...params }) -> IntegrationDeleteResponse</code>
+- <code title="delete /accounts/{account_id}/devices/posture/integration/{integration_id}">client.zeroTrust.devices.posture.integrations.<a href="./src/resources/zero-trust/devices/posture/integrations.ts">delete</a>(integrationId, { ...params }) -> IntegrationDeleteResponse | null</code>
 - <code title="patch /accounts/{account_id}/devices/posture/integration/{integration_id}">client.zeroTrust.devices.posture.integrations.<a href="./src/resources/zero-trust/devices/posture/integrations.ts">edit</a>(integrationId, { ...params }) -> Integration | null</code>
 - <code title="get /accounts/{account_id}/devices/posture/integration/{integration_id}">client.zeroTrust.devices.posture.integrations.<a href="./src/resources/zero-trust/devices/posture/integrations.ts">get</a>(integrationId, { ...params }) -> Integration | null</code>
 
@@ -4426,7 +4427,7 @@ Types:
 
 Methods:
 
-- <code title="post /accounts/{account_id}/devices/revoke">client.zeroTrust.devices.revoke.<a href="./src/resources/zero-trust/devices/revoke.ts">create</a>([ ...body ]) -> RevokeCreateResponse</code>
+- <code title="post /accounts/{account_id}/devices/revoke">client.zeroTrust.devices.revoke.<a href="./src/resources/zero-trust/devices/revoke.ts">create</a>([ ...body ]) -> RevokeCreateResponse | null</code>
 
 ### Settings
 
@@ -4448,7 +4449,7 @@ Types:
 
 Methods:
 
-- <code title="post /accounts/{account_id}/devices/unrevoke">client.zeroTrust.devices.unrevoke.<a href="./src/resources/zero-trust/devices/unrevoke.ts">create</a>([ ...body ]) -> UnrevokeCreateResponse</code>
+- <code title="post /accounts/{account_id}/devices/unrevoke">client.zeroTrust.devices.unrevoke.<a href="./src/resources/zero-trust/devices/unrevoke.ts">create</a>([ ...body ]) -> UnrevokeCreateResponse | null</code>
 
 ### OverrideCodes
 
@@ -5689,7 +5690,7 @@ Methods:
 
 - <code title="post /accounts/{account_id}/vectorize/v2/indexes">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes/indexes.ts">create</a>({ ...params }) -> CreateIndex | null</code>
 - <code title="get /accounts/{account_id}/vectorize/v2/indexes">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes/indexes.ts">list</a>({ ...params }) -> CreateIndicesSinglePage</code>
-- <code title="delete /accounts/{account_id}/vectorize/v2/indexes/{index_name}">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes/indexes.ts">delete</a>(indexName, { ...params }) -> IndexDeleteResponse</code>
+- <code title="delete /accounts/{account_id}/vectorize/v2/indexes/{index_name}">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes/indexes.ts">delete</a>(indexName, { ...params }) -> IndexDeleteResponse | null</code>
 - <code title="post /accounts/{account_id}/vectorize/v2/indexes/{index_name}/delete_by_ids">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes/indexes.ts">deleteByIds</a>(indexName, { ...params }) -> IndexDeleteByIDsResponse | null</code>
 - <code title="get /accounts/{account_id}/vectorize/v2/indexes/{index_name}">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes/indexes.ts">get</a>(indexName, { ...params }) -> CreateIndex | null</code>
 - <code title="post /accounts/{account_id}/vectorize/v2/indexes/{index_name}/get_by_ids">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes/indexes.ts">getByIds</a>(indexName, { ...params }) -> IndexGetByIDsResponse | null</code>
@@ -6743,12 +6744,10 @@ Methods:
 
 Types:
 
-- <code><a href="./src/resources/origin-post-quantum-encryption.ts">OriginPostQuantumEncryptionUpdateResponse</a></code>
 - <code><a href="./src/resources/origin-post-quantum-encryption.ts">OriginPostQuantumEncryptionGetResponse</a></code>
 
 Methods:
 
-- <code title="put /zones/{zone_id}/cache/origin_post_quantum_encryption">client.originPostQuantumEncryption.<a href="./src/resources/origin-post-quantum-encryption.ts">update</a>({ ...params }) -> OriginPostQuantumEncryptionUpdateResponse</code>
 - <code title="get /zones/{zone_id}/cache/origin_post_quantum_encryption">client.originPostQuantumEncryption.<a href="./src/resources/origin-post-quantum-encryption.ts">get</a>({ ...params }) -> OriginPostQuantumEncryptionGetResponse</code>
 
 # Speed

src/resources/argo/tiered-caching.ts

@@ -5,7 +5,17 @@ import * as Core from '../../core';
 
 export class TieredCaching extends APIResource {
   /**
-   * Updates enablement of Tiered Caching
+   * Tiered Cache works by dividing Cloudflare's data centers into a hierarchy of
+   * lower-tiers and upper-tiers. If content is not cached in lower-tier data centers
+   * (generally the ones closest to a visitor), the lower-tier must ask an upper-tier
+   * to see if it has the content. If the upper-tier does not have the content, only
+   * the upper-tier can ask the origin for content. This practice improves bandwidth
+   * efficiency by limiting the number of data centers that can ask the origin for
+   * content, which reduces origin load and makes websites more cost-effective to
+   * operate. Additionally, Tiered Cache concentrates connections to origin servers
+   * so they come from a small number of data centers rather than the full set of
+   * network locations. This results in fewer open connections using server
+   * resources.
    */
   edit(
     params: TieredCachingEditParams,
@@ -20,7 +30,17 @@ export class TieredCaching extends APIResource {
   }
 
   /**
-   * Get Tiered Caching setting
+   * Tiered Cache works by dividing Cloudflare's data centers into a hierarchy of
+   * lower-tiers and upper-tiers. If content is not cached in lower-tier data centers
+   * (generally the ones closest to a visitor), the lower-tier must ask an upper-tier
+   * to see if it has the content. If the upper-tier does not have the content, only
+   * the upper-tier can ask the origin for content. This practice improves bandwidth
+   * efficiency by limiting the number of data centers that can ask the origin for
+   * content, which reduces origin load and makes websites more cost-effective to
+   * operate. Additionally, Tiered Cache concentrates connections to origin servers
+   * so they come from a small number of data centers rather than the full set of
+   * network locations. This results in fewer open connections using server
+   * resources.
    */
   get(
     params: TieredCachingGetParams,
@@ -37,46 +57,46 @@ export class TieredCaching extends APIResource {
 
 export interface TieredCachingEditResponse {
   /**
-   * The identifier of the caching setting
+   * ID of the zone setting.
    */
-  id: string;
+  id: 'tiered_caching';
 
   /**
    * Whether the setting is editable
    */
   editable: boolean;
 
   /**
-   * The time when the setting was last modified
+   * The value of the feature
    */
-  modified_on: string;
+  value: 'on' | 'off';
 
   /**
-   * The status of the feature being on / off
+   * Last time this setting was modified.
    */
-  value: 'on' | 'off';
+  modified_on?: string | null;
 }
 
 export interface TieredCachingGetResponse {
   /**
-   * The identifier of the caching setting
+   * ID of the zone setting.
    */
-  id: string;
+  id: 'tiered_caching';
 
   /**
    * Whether the setting is editable
    */
   editable: boolean;
 
   /**
-   * The time when the setting was last modified
+   * The value of the feature
    */
-  modified_on: string;
+  value: 'on' | 'off';
 
   /**
-   * The status of the feature being on / off
+   * Last time this setting was modified.
    */
-  value: 'on' | 'off';
+  modified_on?: string | null;
 }
 
 export interface TieredCachingEditParams {

src/resources/cache/cache-reserve.ts

@@ -109,11 +109,6 @@ export interface CacheReserveClearResponse {
    */
   id: CacheReserveClear;
 
-  /**
-   * last time this setting was modified.
-   */
-  modified_on: string | null;
-
   /**
    * The time that the latest Cache Reserve Clear operation started.
    */
@@ -128,56 +123,55 @@ export interface CacheReserveClearResponse {
    * The time that the latest Cache Reserve Clear operation completed.
    */
   end_ts?: string;
+
+  /**
+   * Last time this setting was modified.
+   */
+  modified_on?: string | null;
 }
 
-/**
- * Increase cache lifetimes by automatically storing all cacheable files into
- * Cloudflare's persistent object storage buckets. Requires Cache Reserve
- * subscription. Note: using Tiered Cache with Cache Reserve is highly recommended
- * to reduce Reserve operations costs. See the
- * [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve)
- * for more information.
- */
 export interface CacheReserveEditResponse {
   /**
    * ID of the zone setting.
    */
   id: CacheReserve;
 
   /**
-   * last time this setting was modified.
+   * Whether the setting is editable
    */
-  modified_on: string | null;
+  editable: boolean;
 
   /**
-   * Value of the Cache Reserve zone setting.
+   * The value of the feature
    */
   value: 'on' | 'off';
+
+  /**
+   * Last time this setting was modified.
+   */
+  modified_on?: string | null;
 }
 
-/**
- * Increase cache lifetimes by automatically storing all cacheable files into
- * Cloudflare's persistent object storage buckets. Requires Cache Reserve
- * subscription. Note: using Tiered Cache with Cache Reserve is highly recommended
- * to reduce Reserve operations costs. See the
- * [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve)
- * for more information.
- */
 export interface CacheReserveGetResponse {
   /**
    * ID of the zone setting.
    */
   id: CacheReserve;
 
   /**
-   * last time this setting was modified.
+   * Whether the setting is editable
    */
-  modified_on: string | null;
+  editable: boolean;
 
   /**
-   * Value of the Cache Reserve zone setting.
+   * The value of the feature
    */
   value: 'on' | 'off';
+
+  /**
+   * Last time this setting was modified.
+   */
+  modified_on?: string | null;
 }
 
 /**
@@ -192,11 +186,6 @@ export interface CacheReserveStatusResponse {
    */
   id: CacheReserveClear;
 
-  /**
-   * last time this setting was modified.
-   */
-  modified_on: string | null;
-
   /**
    * The time that the latest Cache Reserve Clear operation started.
    */
@@ -211,6 +200,11 @@ export interface CacheReserveStatusResponse {
    * The time that the latest Cache Reserve Clear operation completed.
    */
   end_ts?: string;
+
+  /**
+   * Last time this setting was modified.
+   */
+  modified_on?: string | null;
 }
 
 export interface CacheReserveClearParams {

src/resources/cache/cache.ts

@@ -40,6 +40,7 @@ import * as VariantsAPI from './variants';
 import {
   CacheVariant,
   VariantDeleteParams,
+  VariantDeleteResponse,
   VariantEditParams,
   VariantEditResponse,
   VariantGetParams,
@@ -273,6 +274,7 @@ export declare namespace Cache {
   export {
     Variants as Variants,
     type CacheVariant as CacheVariant,
+    type VariantDeleteResponse as VariantDeleteResponse,
     type VariantEditResponse as VariantEditResponse,
     type VariantGetResponse as VariantGetResponse,
     type VariantDeleteParams as VariantDeleteParams,

src/resources/cache/index.ts

@@ -35,6 +35,7 @@ export {
 export {
   Variants,
   type CacheVariant,
+  type VariantDeleteResponse,
   type VariantEditResponse,
   type VariantGetResponse,
   type VariantDeleteParams,