feat(api): OpenAPI spec update via Stainless API (#3269)

cloudflare · Oct 1, 2024 · fa9e358 · fa9e358
1 parent 5edcc78
commit fa9e358
Show file tree

Hide file tree

Showing 25 changed files with 205 additions and 112 deletions.
diff --git a/.stats.yml b/.stats.yml
@@ -1,2 +1,2 @@
 configured_endpoints: 1351
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-c1faa173d1005d5b8f389709e68fb42ea2e9a3cd46cd297edb6cedfb82498c44.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-b4dba4430b26f417c70439d217f2331c4fc6ad5fec2364423ae4802bb610bdc3.yml
diff --git a/api.md b/api.md
@@ -6838,15 +6838,10 @@ Methods:
 
 # OriginPostQuantumEncryption
 
-Response Types:
-
-- <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/origin_post_quantum_encryption">origin_post_quantum_encryption</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/origin_post_quantum_encryption#OriginPostQuantumEncryptionUpdateResponse">OriginPostQuantumEncryptionUpdateResponse</a>
-- <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/origin_post_quantum_encryption">origin_post_quantum_encryption</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/origin_post_quantum_encryption#OriginPostQuantumEncryptionGetResponse">OriginPostQuantumEncryptionGetResponse</a>
-
 Methods:
 
-- <code title="put /zones/{zone_id}/cache/origin_post_quantum_encryption">client.OriginPostQuantumEncryption.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/origin_post_quantum_encryption#OriginPostQuantumEncryptionService.Update">Update</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, params <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/origin_post_quantum_encryption">origin_post_quantum_encryption</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/origin_post_quantum_encryption#OriginPostQuantumEncryptionUpdateParams">OriginPostQuantumEncryptionUpdateParams</a>) (<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/origin_post_quantum_encryption">origin_post_quantum_encryption</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/origin_post_quantum_encryption#OriginPostQuantumEncryptionUpdateResponse">OriginPostQuantumEncryptionUpdateResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
-- <code title="get /zones/{zone_id}/cache/origin_post_quantum_encryption">client.OriginPostQuantumEncryption.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/origin_post_quantum_encryption#OriginPostQuantumEncryptionService.Get">Get</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, query <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/origin_post_quantum_encryption">origin_post_quantum_encryption</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/origin_post_quantum_encryption#OriginPostQuantumEncryptionGetParams">OriginPostQuantumEncryptionGetParams</a>) (<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/origin_post_quantum_encryption">origin_post_quantum_encryption</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/origin_post_quantum_encryption#OriginPostQuantumEncryptionGetResponse">OriginPostQuantumEncryptionGetResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
+- <code title="put /zones/{zone_id}/cache/origin_post_quantum_encryption">client.OriginPostQuantumEncryption.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/origin_post_quantum_encryption#OriginPostQuantumEncryptionService.Update">Update</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, params <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/origin_post_quantum_encryption">origin_post_quantum_encryption</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/origin_post_quantum_encryption#OriginPostQuantumEncryptionUpdateParams">OriginPostQuantumEncryptionUpdateParams</a>) (interface{}, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
+- <code title="get /zones/{zone_id}/cache/origin_post_quantum_encryption">client.OriginPostQuantumEncryption.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/origin_post_quantum_encryption#OriginPostQuantumEncryptionService.Get">Get</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, query <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/origin_post_quantum_encryption">origin_post_quantum_encryption</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/origin_post_quantum_encryption#OriginPostQuantumEncryptionGetParams">OriginPostQuantumEncryptionGetParams</a>) (interface{}, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
 
 # Speed
 

diff --git a/argo/tieredcaching.go b/argo/tieredcaching.go
@@ -191,11 +191,11 @@ func (r TieredCachingEditParamsValue) IsKnown() bool {
 }
 
 type TieredCachingEditResponseEnvelope struct {
-	Errors   []shared.ResponseInfo `json:"errors,required"`
-	Messages []shared.ResponseInfo `json:"messages,required"`
+	Errors   []shared.ResponseInfo     `json:"errors,required"`
+	Messages []shared.ResponseInfo     `json:"messages,required"`
+	Result   TieredCachingEditResponse `json:"result,required"`
 	// Whether the API call was successful
 	Success TieredCachingEditResponseEnvelopeSuccess `json:"success,required"`
-	Result  TieredCachingEditResponse                `json:"result"`
 	JSON    tieredCachingEditResponseEnvelopeJSON    `json:"-"`
 }
 
@@ -204,8 +204,8 @@ type TieredCachingEditResponseEnvelope struct {
 type tieredCachingEditResponseEnvelopeJSON struct {
 	Errors      apijson.Field
 	Messages    apijson.Field
-	Success     apijson.Field
 	Result      apijson.Field
+	Success     apijson.Field
 	raw         string
 	ExtraFields map[string]apijson.Field
 }
@@ -239,11 +239,11 @@ type TieredCachingGetParams struct {
 }
 
 type TieredCachingGetResponseEnvelope struct {
-	Errors   []shared.ResponseInfo `json:"errors,required"`
-	Messages []shared.ResponseInfo `json:"messages,required"`
+	Errors   []shared.ResponseInfo    `json:"errors,required"`
+	Messages []shared.ResponseInfo    `json:"messages,required"`
+	Result   TieredCachingGetResponse `json:"result,required"`
 	// Whether the API call was successful
 	Success TieredCachingGetResponseEnvelopeSuccess `json:"success,required"`
-	Result  TieredCachingGetResponse                `json:"result"`
 	JSON    tieredCachingGetResponseEnvelopeJSON    `json:"-"`
 }
 
@@ -252,8 +252,8 @@ type TieredCachingGetResponseEnvelope struct {
 type tieredCachingGetResponseEnvelopeJSON struct {
 	Errors      apijson.Field
 	Messages    apijson.Field
-	Success     apijson.Field
 	Result      apijson.Field
+	Success     apijson.Field
 	raw         string
 	ExtraFields map[string]apijson.Field
 }

diff --git a/cache/cachereserve.go b/cache/cachereserve.go
@@ -354,23 +354,23 @@ func (r CacheReserveClearParams) MarshalJSON() (data []byte, err error) {
 type CacheReserveClearResponseEnvelope struct {
 	Errors   []shared.ResponseInfo `json:"errors,required"`
 	Messages []shared.ResponseInfo `json:"messages,required"`
-	// Whether the API call was successful
-	Success CacheReserveClearResponseEnvelopeSuccess `json:"success,required"`
 	// 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.
 	// You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind
 	// that you cannot undo or cancel this operation.
-	Result CacheReserveClearResponse             `json:"result"`
-	JSON   cacheReserveClearResponseEnvelopeJSON `json:"-"`
+	Result CacheReserveClearResponse `json:"result,required"`
+	// Whether the API call was successful
+	Success CacheReserveClearResponseEnvelopeSuccess `json:"success,required"`
+	JSON    cacheReserveClearResponseEnvelopeJSON    `json:"-"`
 }
 
 // cacheReserveClearResponseEnvelopeJSON contains the JSON metadata for the struct
 // [CacheReserveClearResponseEnvelope]
 type cacheReserveClearResponseEnvelopeJSON struct {
 	Errors      apijson.Field
 	Messages    apijson.Field
-	Success     apijson.Field
 	Result      apijson.Field
+	Success     apijson.Field
 	raw         string
 	ExtraFields map[string]apijson.Field
 }
@@ -428,25 +428,25 @@ func (r CacheReserveEditParamsValue) IsKnown() bool {
 type CacheReserveEditResponseEnvelope struct {
 	Errors   []shared.ResponseInfo `json:"errors,required"`
 	Messages []shared.ResponseInfo `json:"messages,required"`
-	// Whether the API call was successful
-	Success CacheReserveEditResponseEnvelopeSuccess `json:"success,required"`
 	// 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.
-	Result CacheReserveEditResponse             `json:"result"`
-	JSON   cacheReserveEditResponseEnvelopeJSON `json:"-"`
+	Result CacheReserveEditResponse `json:"result,required"`
+	// Whether the API call was successful
+	Success CacheReserveEditResponseEnvelopeSuccess `json:"success,required"`
+	JSON    cacheReserveEditResponseEnvelopeJSON    `json:"-"`
 }
 
 // cacheReserveEditResponseEnvelopeJSON contains the JSON metadata for the struct
 // [CacheReserveEditResponseEnvelope]
 type cacheReserveEditResponseEnvelopeJSON struct {
 	Errors      apijson.Field
 	Messages    apijson.Field
-	Success     apijson.Field
 	Result      apijson.Field
+	Success     apijson.Field
 	raw         string
 	ExtraFields map[string]apijson.Field
 }
@@ -482,25 +482,25 @@ type CacheReserveGetParams struct {
 type CacheReserveGetResponseEnvelope struct {
 	Errors   []shared.ResponseInfo `json:"errors,required"`
 	Messages []shared.ResponseInfo `json:"messages,required"`
-	// Whether the API call was successful
-	Success CacheReserveGetResponseEnvelopeSuccess `json:"success,required"`
 	// 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.
-	Result CacheReserveGetResponse             `json:"result"`
-	JSON   cacheReserveGetResponseEnvelopeJSON `json:"-"`
+	Result CacheReserveGetResponse `json:"result,required"`
+	// Whether the API call was successful
+	Success CacheReserveGetResponseEnvelopeSuccess `json:"success,required"`
+	JSON    cacheReserveGetResponseEnvelopeJSON    `json:"-"`
 }
 
 // cacheReserveGetResponseEnvelopeJSON contains the JSON metadata for the struct
 // [CacheReserveGetResponseEnvelope]
 type cacheReserveGetResponseEnvelopeJSON struct {
 	Errors      apijson.Field
 	Messages    apijson.Field
-	Success     apijson.Field
 	Result      apijson.Field
+	Success     apijson.Field
 	raw         string
 	ExtraFields map[string]apijson.Field
 }
@@ -536,23 +536,23 @@ type CacheReserveStatusParams struct {
 type CacheReserveStatusResponseEnvelope struct {
 	Errors   []shared.ResponseInfo `json:"errors,required"`
 	Messages []shared.ResponseInfo `json:"messages,required"`
-	// Whether the API call was successful
-	Success CacheReserveStatusResponseEnvelopeSuccess `json:"success,required"`
 	// 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.
 	// You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind
 	// that you cannot undo or cancel this operation.
-	Result CacheReserveStatusResponse             `json:"result"`
-	JSON   cacheReserveStatusResponseEnvelopeJSON `json:"-"`
+	Result CacheReserveStatusResponse `json:"result,required"`
+	// Whether the API call was successful
+	Success CacheReserveStatusResponseEnvelopeSuccess `json:"success,required"`
+	JSON    cacheReserveStatusResponseEnvelopeJSON    `json:"-"`
 }
 
 // cacheReserveStatusResponseEnvelopeJSON contains the JSON metadata for the struct
 // [CacheReserveStatusResponseEnvelope]
 type cacheReserveStatusResponseEnvelopeJSON struct {
 	Errors      apijson.Field
 	Messages    apijson.Field
-	Success     apijson.Field
 	Result      apijson.Field
+	Success     apijson.Field
 	raw         string
 	ExtraFields map[string]apijson.Field
 }

diff --git a/cache/regionaltieredcache.go b/cache/regionaltieredcache.go
@@ -240,22 +240,22 @@ func (r RegionalTieredCacheEditParamsValue) IsKnown() bool {
 type RegionalTieredCacheEditResponseEnvelope struct {
 	Errors   []shared.ResponseInfo `json:"errors,required"`
 	Messages []shared.ResponseInfo `json:"messages,required"`
-	// Whether the API call was successful
-	Success RegionalTieredCacheEditResponseEnvelopeSuccess `json:"success,required"`
 	// Instructs Cloudflare to check a regional hub data center on the way to your
 	// upper tier. This can help improve performance for smart and custom tiered cache
 	// topologies.
-	Result RegionalTieredCacheEditResponse             `json:"result"`
-	JSON   regionalTieredCacheEditResponseEnvelopeJSON `json:"-"`
+	Result RegionalTieredCacheEditResponse `json:"result,required"`
+	// Whether the API call was successful
+	Success RegionalTieredCacheEditResponseEnvelopeSuccess `json:"success,required"`
+	JSON    regionalTieredCacheEditResponseEnvelopeJSON    `json:"-"`
 }
 
 // regionalTieredCacheEditResponseEnvelopeJSON contains the JSON metadata for the
 // struct [RegionalTieredCacheEditResponseEnvelope]
 type regionalTieredCacheEditResponseEnvelopeJSON struct {
 	Errors      apijson.Field
 	Messages    apijson.Field
-	Success     apijson.Field
 	Result      apijson.Field
+	Success     apijson.Field
 	raw         string
 	ExtraFields map[string]apijson.Field
 }
@@ -291,22 +291,22 @@ type RegionalTieredCacheGetParams struct {
 type RegionalTieredCacheGetResponseEnvelope struct {
 	Errors   []shared.ResponseInfo `json:"errors,required"`
 	Messages []shared.ResponseInfo `json:"messages,required"`
-	// Whether the API call was successful
-	Success RegionalTieredCacheGetResponseEnvelopeSuccess `json:"success,required"`
 	// Instructs Cloudflare to check a regional hub data center on the way to your
 	// upper tier. This can help improve performance for smart and custom tiered cache
 	// topologies.
-	Result RegionalTieredCacheGetResponse             `json:"result"`
-	JSON   regionalTieredCacheGetResponseEnvelopeJSON `json:"-"`
+	Result RegionalTieredCacheGetResponse `json:"result,required"`
+	// Whether the API call was successful
+	Success RegionalTieredCacheGetResponseEnvelopeSuccess `json:"success,required"`
+	JSON    regionalTieredCacheGetResponseEnvelopeJSON    `json:"-"`
 }
 
 // regionalTieredCacheGetResponseEnvelopeJSON contains the JSON metadata for the
 // struct [RegionalTieredCacheGetResponseEnvelope]
 type regionalTieredCacheGetResponseEnvelopeJSON struct {
 	Errors      apijson.Field
 	Messages    apijson.Field
-	Success     apijson.Field
 	Result      apijson.Field
+	Success     apijson.Field
 	raw         string
 	ExtraFields map[string]apijson.Field
 }

diff --git a/cache/smarttieredcache.go b/cache/smarttieredcache.go
@@ -233,11 +233,11 @@ type SmartTieredCacheDeleteParams struct {
 }
 
 type SmartTieredCacheDeleteResponseEnvelope struct {
-	Errors   []shared.ResponseInfo `json:"errors,required"`
-	Messages []shared.ResponseInfo `json:"messages,required"`
+	Errors   []shared.ResponseInfo          `json:"errors,required"`
+	Messages []shared.ResponseInfo          `json:"messages,required"`
+	Result   SmartTieredCacheDeleteResponse `json:"result,required"`
 	// Whether the API call was successful
 	Success SmartTieredCacheDeleteResponseEnvelopeSuccess `json:"success,required"`
-	Result  SmartTieredCacheDeleteResponse                `json:"result"`
 	JSON    smartTieredCacheDeleteResponseEnvelopeJSON    `json:"-"`
 }
 
@@ -246,8 +246,8 @@ type SmartTieredCacheDeleteResponseEnvelope struct {
 type smartTieredCacheDeleteResponseEnvelopeJSON struct {
 	Errors      apijson.Field
 	Messages    apijson.Field
-	Success     apijson.Field
 	Result      apijson.Field
+	Success     apijson.Field
 	raw         string
 	ExtraFields map[string]apijson.Field
 }
@@ -303,11 +303,11 @@ func (r SmartTieredCacheEditParamsValue) IsKnown() bool {
 }
 
 type SmartTieredCacheEditResponseEnvelope struct {
-	Errors   []shared.ResponseInfo `json:"errors,required"`
-	Messages []shared.ResponseInfo `json:"messages,required"`
+	Errors   []shared.ResponseInfo        `json:"errors,required"`
+	Messages []shared.ResponseInfo        `json:"messages,required"`
+	Result   SmartTieredCacheEditResponse `json:"result,required"`
 	// Whether the API call was successful
 	Success SmartTieredCacheEditResponseEnvelopeSuccess `json:"success,required"`
-	Result  SmartTieredCacheEditResponse                `json:"result"`
 	JSON    smartTieredCacheEditResponseEnvelopeJSON    `json:"-"`
 }
 
@@ -316,8 +316,8 @@ type SmartTieredCacheEditResponseEnvelope struct {
 type smartTieredCacheEditResponseEnvelopeJSON struct {
 	Errors      apijson.Field
 	Messages    apijson.Field
-	Success     apijson.Field
 	Result      apijson.Field
+	Success     apijson.Field
 	raw         string
 	ExtraFields map[string]apijson.Field
 }
@@ -351,11 +351,11 @@ type SmartTieredCacheGetParams struct {
 }
 
 type SmartTieredCacheGetResponseEnvelope struct {
-	Errors   []shared.ResponseInfo `json:"errors,required"`
-	Messages []shared.ResponseInfo `json:"messages,required"`
+	Errors   []shared.ResponseInfo       `json:"errors,required"`
+	Messages []shared.ResponseInfo       `json:"messages,required"`
+	Result   SmartTieredCacheGetResponse `json:"result,required"`
 	// Whether the API call was successful
 	Success SmartTieredCacheGetResponseEnvelopeSuccess `json:"success,required"`
-	Result  SmartTieredCacheGetResponse                `json:"result"`
 	JSON    smartTieredCacheGetResponseEnvelopeJSON    `json:"-"`
 }
 
@@ -364,8 +364,8 @@ type SmartTieredCacheGetResponseEnvelope struct {
 type smartTieredCacheGetResponseEnvelopeJSON struct {
 	Errors      apijson.Field
 	Messages    apijson.Field
-	Success     apijson.Field
 	Result      apijson.Field
+	Success     apijson.Field
 	raw         string
 	ExtraFields map[string]apijson.Field
 }