Skip to content

Commit 0c1056e

Browse files
chore(api): update composite API spec
1 parent 98749d9 commit 0c1056e

22 files changed

+29
-1962
lines changed

.stats.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
configured_endpoints: 1812
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-6b48b0fcc5aad076c9e8610dcb068b9abc8935056a2894faa9a782a1be29c9b4.yml
3-
openapi_spec_hash: bf1601a44779e337eee7fa5c52db8590
1+
configured_endpoints: 1796
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-bf1e7e91f9f96239a1e75f7bbcdeeeff4a3764ed7dcc151955e58147cab2f6d2.yml
3+
openapi_spec_hash: 8ad35a62b36dc463980840ac51857e86
44
config_hash: 08d1e85e3d6166780e91482de72fa93c

api.md

Lines changed: 0 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,6 @@ Methods:
308308
Types:
309309

310310
- <code><a href="./src/resources/zones/settings.ts">AdvancedDDoS</a></code>
311-
- <code><a href="./src/resources/zones/settings.ts">Aegis</a></code>
312311
- <code><a href="./src/resources/zones/settings.ts">AlwaysOnline</a></code>
313312
- <code><a href="./src/resources/zones/settings.ts">AlwaysUseHTTPS</a></code>
314313
- <code><a href="./src/resources/zones/settings.ts">AutomaticHTTPSRewrites</a></code>
@@ -337,7 +336,6 @@ Types:
337336
- <code><a href="./src/resources/zones/settings.ts">OpportunisticOnion</a></code>
338337
- <code><a href="./src/resources/zones/settings.ts">OrangeToOrange</a></code>
339338
- <code><a href="./src/resources/zones/settings.ts">OriginErrorPagePassThru</a></code>
340-
- <code><a href="./src/resources/zones/settings.ts">OriginMaxHTTPVersion</a></code>
341339
- <code><a href="./src/resources/zones/settings.ts">Polish</a></code>
342340
- <code><a href="./src/resources/zones/settings.ts">PrefetchPreload</a></code>
343341
- <code><a href="./src/resources/zones/settings.ts">ProxyReadTimeout</a></code>
@@ -585,65 +583,12 @@ Methods:
585583

586584
## CacheReserve
587585

588-
Types:
589-
590-
- <code><a href="./src/resources/cache/cache-reserve.ts">CacheReserve</a></code>
591-
- <code><a href="./src/resources/cache/cache-reserve.ts">CacheReserveClear</a></code>
592-
- <code><a href="./src/resources/cache/cache-reserve.ts">State</a></code>
593-
- <code><a href="./src/resources/cache/cache-reserve.ts">CacheReserveClearResponse</a></code>
594-
- <code><a href="./src/resources/cache/cache-reserve.ts">CacheReserveEditResponse</a></code>
595-
- <code><a href="./src/resources/cache/cache-reserve.ts">CacheReserveGetResponse</a></code>
596-
- <code><a href="./src/resources/cache/cache-reserve.ts">CacheReserveStatusResponse</a></code>
597-
598-
Methods:
599-
600-
- <code title="post /zones/{zone_id}/cache/cache_reserve_clear">client.cache.cacheReserve.<a href="./src/resources/cache/cache-reserve.ts">clear</a>({ ...params }) -> CacheReserveClearResponse</code>
601-
- <code title="patch /zones/{zone_id}/cache/cache_reserve">client.cache.cacheReserve.<a href="./src/resources/cache/cache-reserve.ts">edit</a>({ ...params }) -> CacheReserveEditResponse</code>
602-
- <code title="get /zones/{zone_id}/cache/cache_reserve">client.cache.cacheReserve.<a href="./src/resources/cache/cache-reserve.ts">get</a>({ ...params }) -> CacheReserveGetResponse</code>
603-
- <code title="get /zones/{zone_id}/cache/cache_reserve_clear">client.cache.cacheReserve.<a href="./src/resources/cache/cache-reserve.ts">status</a>({ ...params }) -> CacheReserveStatusResponse</code>
604-
605586
## SmartTieredCache
606587

607-
Types:
608-
609-
- <code><a href="./src/resources/cache/smart-tiered-cache.ts">SmartTieredCacheDeleteResponse</a></code>
610-
- <code><a href="./src/resources/cache/smart-tiered-cache.ts">SmartTieredCacheEditResponse</a></code>
611-
- <code><a href="./src/resources/cache/smart-tiered-cache.ts">SmartTieredCacheGetResponse</a></code>
612-
613-
Methods:
614-
615-
- <code title="delete /zones/{zone_id}/cache/tiered_cache_smart_topology_enable">client.cache.smartTieredCache.<a href="./src/resources/cache/smart-tiered-cache.ts">delete</a>({ ...params }) -> SmartTieredCacheDeleteResponse</code>
616-
- <code title="patch /zones/{zone_id}/cache/tiered_cache_smart_topology_enable">client.cache.smartTieredCache.<a href="./src/resources/cache/smart-tiered-cache.ts">edit</a>({ ...params }) -> SmartTieredCacheEditResponse</code>
617-
- <code title="get /zones/{zone_id}/cache/tiered_cache_smart_topology_enable">client.cache.smartTieredCache.<a href="./src/resources/cache/smart-tiered-cache.ts">get</a>({ ...params }) -> SmartTieredCacheGetResponse</code>
618-
619588
## Variants
620589

621-
Types:
622-
623-
- <code><a href="./src/resources/cache/variants.ts">CacheVariant</a></code>
624-
- <code><a href="./src/resources/cache/variants.ts">VariantDeleteResponse</a></code>
625-
- <code><a href="./src/resources/cache/variants.ts">VariantEditResponse</a></code>
626-
- <code><a href="./src/resources/cache/variants.ts">VariantGetResponse</a></code>
627-
628-
Methods:
629-
630-
- <code title="delete /zones/{zone_id}/cache/variants">client.cache.variants.<a href="./src/resources/cache/variants.ts">delete</a>({ ...params }) -> VariantDeleteResponse</code>
631-
- <code title="patch /zones/{zone_id}/cache/variants">client.cache.variants.<a href="./src/resources/cache/variants.ts">edit</a>({ ...params }) -> VariantEditResponse</code>
632-
- <code title="get /zones/{zone_id}/cache/variants">client.cache.variants.<a href="./src/resources/cache/variants.ts">get</a>({ ...params }) -> VariantGetResponse</code>
633-
634590
## RegionalTieredCache
635591

636-
Types:
637-
638-
- <code><a href="./src/resources/cache/regional-tiered-cache.ts">RegionalTieredCache</a></code>
639-
- <code><a href="./src/resources/cache/regional-tiered-cache.ts">RegionalTieredCacheEditResponse</a></code>
640-
- <code><a href="./src/resources/cache/regional-tiered-cache.ts">RegionalTieredCacheGetResponse</a></code>
641-
642-
Methods:
643-
644-
- <code title="patch /zones/{zone_id}/cache/regional_tiered_cache">client.cache.regionalTieredCache.<a href="./src/resources/cache/regional-tiered-cache.ts">edit</a>({ ...params }) -> RegionalTieredCacheEditResponse</code>
645-
- <code title="get /zones/{zone_id}/cache/regional_tiered_cache">client.cache.regionalTieredCache.<a href="./src/resources/cache/regional-tiered-cache.ts">get</a>({ ...params }) -> RegionalTieredCacheGetResponse</code>
646-
647592
# SSL
648593

649594
## Analyze
@@ -755,16 +700,6 @@ Methods:
755700

756701
## TieredCaching
757702

758-
Types:
759-
760-
- <code><a href="./src/resources/argo/tiered-caching.ts">TieredCachingEditResponse</a></code>
761-
- <code><a href="./src/resources/argo/tiered-caching.ts">TieredCachingGetResponse</a></code>
762-
763-
Methods:
764-
765-
- <code title="patch /zones/{zone_id}/argo/tiered_caching">client.argo.tieredCaching.<a href="./src/resources/argo/tiered-caching.ts">edit</a>({ ...params }) -> TieredCachingEditResponse</code>
766-
- <code title="get /zones/{zone_id}/argo/tiered_caching">client.argo.tieredCaching.<a href="./src/resources/argo/tiered-caching.ts">get</a>({ ...params }) -> TieredCachingGetResponse</code>
767-
768703
# CertificateAuthorities
769704

770705
## HostnameAssociations
@@ -7638,16 +7573,6 @@ Methods:
76387573

76397574
# OriginPostQuantumEncryption
76407575

7641-
Types:
7642-
7643-
- <code><a href="./src/resources/origin-post-quantum-encryption.ts">OriginPostQuantumEncryptionUpdateResponse</a></code>
7644-
- <code><a href="./src/resources/origin-post-quantum-encryption.ts">OriginPostQuantumEncryptionGetResponse</a></code>
7645-
7646-
Methods:
7647-
7648-
- <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>
7649-
- <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>
7650-
76517576
# Zaraz
76527577

76537578
Types:

scripts/detect-breaking-changes

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,6 @@ TEST_PATHS=(
5050
tests/api-resources/load-balancers/regions.test.ts
5151
tests/api-resources/load-balancers/searches.test.ts
5252
tests/api-resources/cache/cache.test.ts
53-
tests/api-resources/cache/cache-reserve.test.ts
54-
tests/api-resources/cache/smart-tiered-cache.test.ts
55-
tests/api-resources/cache/variants.test.ts
56-
tests/api-resources/cache/regional-tiered-cache.test.ts
5753
tests/api-resources/ssl/ssl.test.ts
5854
tests/api-resources/ssl/analyze.test.ts
5955
tests/api-resources/ssl/certificate-packs/certificate-packs.test.ts
@@ -66,7 +62,6 @@ TEST_PATHS=(
6662
tests/api-resources/acm/total-tls.test.ts
6763
tests/api-resources/argo/argo.test.ts
6864
tests/api-resources/argo/smart-routing.test.ts
69-
tests/api-resources/argo/tiered-caching.test.ts
7065
tests/api-resources/certificate-authorities/certificate-authorities.test.ts
7166
tests/api-resources/certificate-authorities/hostname-associations.test.ts
7267
tests/api-resources/client-certificates.test.ts
@@ -646,7 +641,6 @@ TEST_PATHS=(
646641
tests/api-resources/radar/leaked-credentials/summary.test.ts
647642
tests/api-resources/radar/leaked-credentials/timeseries-groups.test.ts
648643
tests/api-resources/bot-management.test.ts
649-
tests/api-resources/origin-post-quantum-encryption.test.ts
650644
tests/api-resources/zaraz/zaraz.test.ts
651645
tests/api-resources/zaraz/config.test.ts
652646
tests/api-resources/zaraz/default.test.ts

src/resources/argo/argo.ts

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,7 @@ import {
1010
SmartRoutingGetResponse,
1111
} from './smart-routing';
1212
import * as TieredCachingAPI from './tiered-caching';
13-
import {
14-
TieredCaching,
15-
TieredCachingEditParams,
16-
TieredCachingEditResponse,
17-
TieredCachingGetParams,
18-
TieredCachingGetResponse,
19-
} from './tiered-caching';
13+
import { TieredCaching } from './tiered-caching';
2014

2115
export class Argo extends APIResource {
2216
smartRouting: SmartRoutingAPI.SmartRouting = new SmartRoutingAPI.SmartRouting(this._client);
@@ -35,11 +29,5 @@ export declare namespace Argo {
3529
type SmartRoutingGetParams as SmartRoutingGetParams,
3630
};
3731

38-
export {
39-
TieredCaching as TieredCaching,
40-
type TieredCachingEditResponse as TieredCachingEditResponse,
41-
type TieredCachingGetResponse as TieredCachingGetResponse,
42-
type TieredCachingEditParams as TieredCachingEditParams,
43-
type TieredCachingGetParams as TieredCachingGetParams,
44-
};
32+
export { TieredCaching as TieredCaching };
4533
}

src/resources/argo/index.ts

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,4 @@ export {
88
type SmartRoutingEditParams,
99
type SmartRoutingGetParams,
1010
} from './smart-routing';
11-
export {
12-
TieredCaching,
13-
type TieredCachingEditResponse,
14-
type TieredCachingGetResponse,
15-
type TieredCachingEditParams,
16-
type TieredCachingGetParams,
17-
} from './tiered-caching';
11+
export { TieredCaching } from './tiered-caching';
Lines changed: 1 addition & 139 deletions
Original file line numberDiff line numberDiff line change
@@ -1,143 +1,5 @@
11
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
22

33
import { APIResource } from '../../resource';
4-
import * as Core from '../../core';
54

6-
export class TieredCaching extends APIResource {
7-
/**
8-
* Tiered Cache works by dividing Cloudflare's data centers into a hierarchy of
9-
* lower-tiers and upper-tiers. If content is not cached in lower-tier data centers
10-
* (generally the ones closest to a visitor), the lower-tier must ask an upper-tier
11-
* to see if it has the content. If the upper-tier does not have the content, only
12-
* the upper-tier can ask the origin for content. This practice improves bandwidth
13-
* efficiency by limiting the number of data centers that can ask the origin for
14-
* content, which reduces origin load and makes websites more cost-effective to
15-
* operate. Additionally, Tiered Cache concentrates connections to origin servers
16-
* so they come from a small number of data centers rather than the full set of
17-
* network locations. This results in fewer open connections using server
18-
* resources.
19-
*
20-
* @example
21-
* ```ts
22-
* const response = await client.argo.tieredCaching.edit({
23-
* zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
24-
* value: 'on',
25-
* });
26-
* ```
27-
*/
28-
edit(
29-
params: TieredCachingEditParams,
30-
options?: Core.RequestOptions,
31-
): Core.APIPromise<TieredCachingEditResponse> {
32-
const { zone_id, ...body } = params;
33-
return (
34-
this._client.patch(`/zones/${zone_id}/argo/tiered_caching`, { body, ...options }) as Core.APIPromise<{
35-
result: TieredCachingEditResponse;
36-
}>
37-
)._thenUnwrap((obj) => obj.result);
38-
}
39-
40-
/**
41-
* Tiered Cache works by dividing Cloudflare's data centers into a hierarchy of
42-
* lower-tiers and upper-tiers. If content is not cached in lower-tier data centers
43-
* (generally the ones closest to a visitor), the lower-tier must ask an upper-tier
44-
* to see if it has the content. If the upper-tier does not have the content, only
45-
* the upper-tier can ask the origin for content. This practice improves bandwidth
46-
* efficiency by limiting the number of data centers that can ask the origin for
47-
* content, which reduces origin load and makes websites more cost-effective to
48-
* operate. Additionally, Tiered Cache concentrates connections to origin servers
49-
* so they come from a small number of data centers rather than the full set of
50-
* network locations. This results in fewer open connections using server
51-
* resources.
52-
*
53-
* @example
54-
* ```ts
55-
* const tieredCaching = await client.argo.tieredCaching.get({
56-
* zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
57-
* });
58-
* ```
59-
*/
60-
get(
61-
params: TieredCachingGetParams,
62-
options?: Core.RequestOptions,
63-
): Core.APIPromise<TieredCachingGetResponse> {
64-
const { zone_id } = params;
65-
return (
66-
this._client.get(`/zones/${zone_id}/argo/tiered_caching`, options) as Core.APIPromise<{
67-
result: TieredCachingGetResponse;
68-
}>
69-
)._thenUnwrap((obj) => obj.result);
70-
}
71-
}
72-
73-
export interface TieredCachingEditResponse {
74-
/**
75-
* The identifier of the caching setting.
76-
*/
77-
id: 'tiered_caching';
78-
79-
/**
80-
* Whether the setting is editable.
81-
*/
82-
editable: boolean;
83-
84-
/**
85-
* Value of the Tiered Cache zone setting.
86-
*/
87-
value: 'on' | 'off';
88-
89-
/**
90-
* Last time this setting was modified.
91-
*/
92-
modified_on?: string | null;
93-
}
94-
95-
export interface TieredCachingGetResponse {
96-
/**
97-
* The identifier of the caching setting.
98-
*/
99-
id: 'tiered_caching';
100-
101-
/**
102-
* Whether the setting is editable.
103-
*/
104-
editable: boolean;
105-
106-
/**
107-
* Value of the Tiered Cache zone setting.
108-
*/
109-
value: 'on' | 'off';
110-
111-
/**
112-
* Last time this setting was modified.
113-
*/
114-
modified_on?: string | null;
115-
}
116-
117-
export interface TieredCachingEditParams {
118-
/**
119-
* Path param: Identifier.
120-
*/
121-
zone_id: string;
122-
123-
/**
124-
* Body param: Enables Tiered Caching.
125-
*/
126-
value: 'on' | 'off';
127-
}
128-
129-
export interface TieredCachingGetParams {
130-
/**
131-
* Identifier.
132-
*/
133-
zone_id: string;
134-
}
135-
136-
export declare namespace TieredCaching {
137-
export {
138-
type TieredCachingEditResponse as TieredCachingEditResponse,
139-
type TieredCachingGetResponse as TieredCachingGetResponse,
140-
type TieredCachingEditParams as TieredCachingEditParams,
141-
type TieredCachingGetParams as TieredCachingGetParams,
142-
};
143-
}
5+
export class TieredCaching extends APIResource {}

0 commit comments

Comments
 (0)