Skip to content

Commit

Permalink
feat(api): update via SDK Studio (#245)
Browse files Browse the repository at this point in the history
  • Loading branch information
stainless-app[bot] committed Apr 24, 2024
1 parent 2af108f commit 98131b1
Show file tree
Hide file tree
Showing 53 changed files with 739 additions and 904 deletions.
298 changes: 149 additions & 149 deletions api.md

Large diffs are not rendered by default.

11 changes: 4 additions & 7 deletions src/resources/zones/settings/advanced-ddos.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,11 @@ export class AdvancedDDoS extends APIResource {
* website. This is an uneditable value that is 'on' in the case of Business and
* Enterprise zones.
*/
get(
params: AdvancedDDoSGetParams,
options?: Core.RequestOptions,
): Core.APIPromise<ZoneSettingAdvancedDDoS> {
get(params: AdvancedDDoSGetParams, options?: Core.RequestOptions): Core.APIPromise<AdvancedDDoS> {
const { zone_id } = params;
return (
this._client.get(`/zones/${zone_id}/settings/advanced_ddos`, options) as Core.APIPromise<{
result: ZoneSettingAdvancedDDoS;
result: AdvancedDDoS;
}>
)._thenUnwrap((obj) => obj.result);
}
Expand All @@ -28,7 +25,7 @@ export class AdvancedDDoS extends APIResource {
* website. This is an uneditable value that is 'on' in the case of Business and
* Enterprise zones.
*/
export interface ZoneSettingAdvancedDDoS {
export interface AdvancedDDoS {
/**
* ID of the zone setting.
*/
Expand Down Expand Up @@ -59,6 +56,6 @@ export interface AdvancedDDoSGetParams {
}

export namespace AdvancedDDoS {
export import ZoneSettingAdvancedDDoS = AdvancedDDoSAPI.ZoneSettingAdvancedDDoS;
export import AdvancedDDoS = AdvancedDDoSAPI.AdvancedDDoS;
export import AdvancedDDoSGetParams = AdvancedDDoSAPI.AdvancedDDoSGetParams;
}
22 changes: 8 additions & 14 deletions src/resources/zones/settings/always-online.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,21 @@ import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as AlwaysOnlineAPI from 'cloudflare/resources/zones/settings/always-online';

export class AlwaysOnline extends APIResource {
export class AlwaysOnlineResource extends APIResource {
/**
* When enabled, Cloudflare serves limited copies of web pages available from the
* [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is
* offline. Refer to
* [Always Online](https://developers.cloudflare.com/cache/about/always-online) for
* more information.
*/
edit(
params: AlwaysOnlineEditParams,
options?: Core.RequestOptions,
): Core.APIPromise<ZoneSettingAlwaysOnline> {
edit(params: AlwaysOnlineEditParams, options?: Core.RequestOptions): Core.APIPromise<AlwaysOnline> {
const { zone_id, ...body } = params;
return (
this._client.patch(`/zones/${zone_id}/settings/always_online`, {
body,
...options,
}) as Core.APIPromise<{ result: ZoneSettingAlwaysOnline }>
}) as Core.APIPromise<{ result: AlwaysOnline }>
)._thenUnwrap((obj) => obj.result);
}

Expand All @@ -32,14 +29,11 @@ export class AlwaysOnline extends APIResource {
* [Always Online](https://developers.cloudflare.com/cache/about/always-online) for
* more information.
*/
get(
params: AlwaysOnlineGetParams,
options?: Core.RequestOptions,
): Core.APIPromise<ZoneSettingAlwaysOnline> {
get(params: AlwaysOnlineGetParams, options?: Core.RequestOptions): Core.APIPromise<AlwaysOnline> {
const { zone_id } = params;
return (
this._client.get(`/zones/${zone_id}/settings/always_online`, options) as Core.APIPromise<{
result: ZoneSettingAlwaysOnline;
result: AlwaysOnline;
}>
)._thenUnwrap((obj) => obj.result);
}
Expand All @@ -52,7 +46,7 @@ export class AlwaysOnline extends APIResource {
* [Always Online](https://developers.cloudflare.com/cache/about/always-online) for
* more information.
*/
export interface ZoneSettingAlwaysOnline {
export interface AlwaysOnline {
/**
* ID of the zone setting.
*/
Expand Down Expand Up @@ -94,8 +88,8 @@ export interface AlwaysOnlineGetParams {
zone_id: string;
}

export namespace AlwaysOnline {
export import ZoneSettingAlwaysOnline = AlwaysOnlineAPI.ZoneSettingAlwaysOnline;
export namespace AlwaysOnlineResource {
export import AlwaysOnline = AlwaysOnlineAPI.AlwaysOnline;
export import AlwaysOnlineEditParams = AlwaysOnlineAPI.AlwaysOnlineEditParams;
export import AlwaysOnlineGetParams = AlwaysOnlineAPI.AlwaysOnlineGetParams;
}
18 changes: 6 additions & 12 deletions src/resources/zones/settings/always-use-https.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,13 @@ export class AlwaysUseHTTPS extends APIResource {
* equivalent "https" URL. If you only want to redirect for a subset of requests,
* consider creating an "Always use HTTPS" page rule.
*/
edit(
params: AlwaysUseHTTPSEditParams,
options?: Core.RequestOptions,
): Core.APIPromise<ZoneSettingAlwaysUseHTTPS> {
edit(params: AlwaysUseHTTPSEditParams, options?: Core.RequestOptions): Core.APIPromise<AlwaysUseHTTPS> {
const { zone_id, ...body } = params;
return (
this._client.patch(`/zones/${zone_id}/settings/always_use_https`, {
body,
...options,
}) as Core.APIPromise<{ result: ZoneSettingAlwaysUseHTTPS }>
}) as Core.APIPromise<{ result: AlwaysUseHTTPS }>
)._thenUnwrap((obj) => obj.result);
}

Expand All @@ -28,14 +25,11 @@ export class AlwaysUseHTTPS extends APIResource {
* equivalent "https" URL. If you only want to redirect for a subset of requests,
* consider creating an "Always use HTTPS" page rule.
*/
get(
params: AlwaysUseHTTPSGetParams,
options?: Core.RequestOptions,
): Core.APIPromise<ZoneSettingAlwaysUseHTTPS> {
get(params: AlwaysUseHTTPSGetParams, options?: Core.RequestOptions): Core.APIPromise<AlwaysUseHTTPS> {
const { zone_id } = params;
return (
this._client.get(`/zones/${zone_id}/settings/always_use_https`, options) as Core.APIPromise<{
result: ZoneSettingAlwaysUseHTTPS;
result: AlwaysUseHTTPS;
}>
)._thenUnwrap((obj) => obj.result);
}
Expand All @@ -46,7 +40,7 @@ export class AlwaysUseHTTPS extends APIResource {
* equivalent "https" URL. If you only want to redirect for a subset of requests,
* consider creating an "Always use HTTPS" page rule.
*/
export interface ZoneSettingAlwaysUseHTTPS {
export interface AlwaysUseHTTPS {
/**
* ID of the zone setting.
*/
Expand Down Expand Up @@ -89,7 +83,7 @@ export interface AlwaysUseHTTPSGetParams {
}

export namespace AlwaysUseHTTPS {
export import ZoneSettingAlwaysUseHTTPS = AlwaysUseHTTPSAPI.ZoneSettingAlwaysUseHTTPS;
export import AlwaysUseHTTPS = AlwaysUseHTTPSAPI.AlwaysUseHTTPS;
export import AlwaysUseHTTPSEditParams = AlwaysUseHTTPSAPI.AlwaysUseHTTPSEditParams;
export import AlwaysUseHTTPSGetParams = AlwaysUseHTTPSAPI.AlwaysUseHTTPSGetParams;
}
12 changes: 6 additions & 6 deletions src/resources/zones/settings/automatic-https-rewrites.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ export class AutomaticHTTPSRewrites extends APIResource {
edit(
params: AutomaticHTTPSRewriteEditParams,
options?: Core.RequestOptions,
): Core.APIPromise<ZoneSettingAutomaticHTTPSRewrites> {
): Core.APIPromise<AutomaticHTTPSRewrites> {
const { zone_id, ...body } = params;
return (
this._client.patch(`/zones/${zone_id}/settings/automatic_https_rewrites`, {
body,
...options,
}) as Core.APIPromise<{ result: ZoneSettingAutomaticHTTPSRewrites }>
}) as Core.APIPromise<{ result: AutomaticHTTPSRewrites }>
)._thenUnwrap((obj) => obj.result);
}

Expand All @@ -27,11 +27,11 @@ export class AutomaticHTTPSRewrites extends APIResource {
get(
params: AutomaticHTTPSRewriteGetParams,
options?: Core.RequestOptions,
): Core.APIPromise<ZoneSettingAutomaticHTTPSRewrites> {
): Core.APIPromise<AutomaticHTTPSRewrites> {
const { zone_id } = params;
return (
this._client.get(`/zones/${zone_id}/settings/automatic_https_rewrites`, options) as Core.APIPromise<{
result: ZoneSettingAutomaticHTTPSRewrites;
result: AutomaticHTTPSRewrites;
}>
)._thenUnwrap((obj) => obj.result);
}
Expand All @@ -40,7 +40,7 @@ export class AutomaticHTTPSRewrites extends APIResource {
/**
* Enable the Automatic HTTPS Rewrites feature for this zone.
*/
export interface ZoneSettingAutomaticHTTPSRewrites {
export interface AutomaticHTTPSRewrites {
/**
* ID of the zone setting.
*/
Expand Down Expand Up @@ -84,7 +84,7 @@ export interface AutomaticHTTPSRewriteGetParams {
}

export namespace AutomaticHTTPSRewrites {
export import ZoneSettingAutomaticHTTPSRewrites = AutomaticHTTPSRewritesAPI.ZoneSettingAutomaticHTTPSRewrites;
export import AutomaticHTTPSRewrites = AutomaticHTTPSRewritesAPI.AutomaticHTTPSRewrites;
export import AutomaticHTTPSRewriteEditParams = AutomaticHTTPSRewritesAPI.AutomaticHTTPSRewriteEditParams;
export import AutomaticHTTPSRewriteGetParams = AutomaticHTTPSRewritesAPI.AutomaticHTTPSRewriteGetParams;
}
18 changes: 9 additions & 9 deletions src/resources/zones/settings/automatic-platform-optimization.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as AutomaticPlatformOptimizationAPI from 'cloudflare/resources/zones/settings/automatic-platform-optimization';

export class AutomaticPlatformOptimization extends APIResource {
export class AutomaticPlatformOptimizationResource extends APIResource {
/**
* [Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/)
* serves your WordPress site from Cloudflare's edge network and caches third-party
Expand All @@ -13,13 +13,13 @@ export class AutomaticPlatformOptimization extends APIResource {
edit(
params: AutomaticPlatformOptimizationEditParams,
options?: Core.RequestOptions,
): Core.APIPromise<ZoneSettingAutomaticPlatformOptimization> {
): Core.APIPromise<AutomaticPlatformOptimization> {
const { zone_id, ...body } = params;
return (
this._client.patch(`/zones/${zone_id}/settings/automatic_platform_optimization`, {
body,
...options,
}) as Core.APIPromise<{ result: ZoneSettingAutomaticPlatformOptimization }>
}) as Core.APIPromise<{ result: AutomaticPlatformOptimization }>
)._thenUnwrap((obj) => obj.result);
}

Expand All @@ -31,18 +31,18 @@ export class AutomaticPlatformOptimization extends APIResource {
get(
params: AutomaticPlatformOptimizationGetParams,
options?: Core.RequestOptions,
): Core.APIPromise<ZoneSettingAutomaticPlatformOptimization> {
): Core.APIPromise<AutomaticPlatformOptimization> {
const { zone_id } = params;
return (
this._client.get(
`/zones/${zone_id}/settings/automatic_platform_optimization`,
options,
) as Core.APIPromise<{ result: ZoneSettingAutomaticPlatformOptimization }>
) as Core.APIPromise<{ result: AutomaticPlatformOptimization }>
)._thenUnwrap((obj) => obj.result);
}
}

export interface ZoneSettingAutomaticPlatformOptimization {
export interface AutomaticPlatformOptimization {
/**
* Indicates whether or not
* [cache by device type](https://developers.cloudflare.com/automatic-platform-optimization/reference/cache-device-type/)
Expand Down Expand Up @@ -88,7 +88,7 @@ export interface AutomaticPlatformOptimizationEditParams {
/**
* Body param:
*/
value: ZoneSettingAutomaticPlatformOptimization;
value: AutomaticPlatformOptimization;
}

export interface AutomaticPlatformOptimizationGetParams {
Expand All @@ -98,8 +98,8 @@ export interface AutomaticPlatformOptimizationGetParams {
zone_id: string;
}

export namespace AutomaticPlatformOptimization {
export import ZoneSettingAutomaticPlatformOptimization = AutomaticPlatformOptimizationAPI.ZoneSettingAutomaticPlatformOptimization;
export namespace AutomaticPlatformOptimizationResource {
export import AutomaticPlatformOptimization = AutomaticPlatformOptimizationAPI.AutomaticPlatformOptimization;
export import AutomaticPlatformOptimizationEditParams = AutomaticPlatformOptimizationAPI.AutomaticPlatformOptimizationEditParams;
export import AutomaticPlatformOptimizationGetParams = AutomaticPlatformOptimizationAPI.AutomaticPlatformOptimizationGetParams;
}
18 changes: 8 additions & 10 deletions src/resources/zones/settings/brotli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as BrotliAPI from 'cloudflare/resources/zones/settings/brotli';

export class Brotli extends APIResource {
export class BrotliResource extends APIResource {
/**
* When the client requesting an asset supports the Brotli compression algorithm,
* Cloudflare will serve a Brotli compressed version of the asset.
*/
edit(params: BrotliEditParams, options?: Core.RequestOptions): Core.APIPromise<ZoneSettingBrotli> {
edit(params: BrotliEditParams, options?: Core.RequestOptions): Core.APIPromise<Brotli> {
const { zone_id, ...body } = params;
return (
this._client.patch(`/zones/${zone_id}/settings/brotli`, { body, ...options }) as Core.APIPromise<{
result: ZoneSettingBrotli;
result: Brotli;
}>
)._thenUnwrap((obj) => obj.result);
}
Expand All @@ -22,12 +22,10 @@ export class Brotli extends APIResource {
* When the client requesting an asset supports the Brotli compression algorithm,
* Cloudflare will serve a Brotli compressed version of the asset.
*/
get(params: BrotliGetParams, options?: Core.RequestOptions): Core.APIPromise<ZoneSettingBrotli> {
get(params: BrotliGetParams, options?: Core.RequestOptions): Core.APIPromise<Brotli> {
const { zone_id } = params;
return (
this._client.get(`/zones/${zone_id}/settings/brotli`, options) as Core.APIPromise<{
result: ZoneSettingBrotli;
}>
this._client.get(`/zones/${zone_id}/settings/brotli`, options) as Core.APIPromise<{ result: Brotli }>
)._thenUnwrap((obj) => obj.result);
}
}
Expand All @@ -36,7 +34,7 @@ export class Brotli extends APIResource {
* When the client requesting an asset supports the Brotli compression algorithm,
* Cloudflare will serve a Brotli compressed version of the asset.
*/
export interface ZoneSettingBrotli {
export interface Brotli {
/**
* ID of the zone setting.
*/
Expand Down Expand Up @@ -78,8 +76,8 @@ export interface BrotliGetParams {
zone_id: string;
}

export namespace Brotli {
export import ZoneSettingBrotli = BrotliAPI.ZoneSettingBrotli;
export namespace BrotliResource {
export import Brotli = BrotliAPI.Brotli;
export import BrotliEditParams = BrotliAPI.BrotliEditParams;
export import BrotliGetParams = BrotliAPI.BrotliGetParams;
}
22 changes: 8 additions & 14 deletions src/resources/zones/settings/browser-cache-ttl.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,20 @@ import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as BrowserCacheTTLAPI from 'cloudflare/resources/zones/settings/browser-cache-ttl';

export class BrowserCacheTTL extends APIResource {
export class BrowserCacheTTLResource extends APIResource {
/**
* Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources
* will remain on your visitors' computers. Cloudflare will honor any larger times
* specified by your server.
* (https://support.cloudflare.com/hc/en-us/articles/200168276).
*/
edit(
params: BrowserCacheTTLEditParams,
options?: Core.RequestOptions,
): Core.APIPromise<ZoneSettingBrowserCacheTTL> {
edit(params: BrowserCacheTTLEditParams, options?: Core.RequestOptions): Core.APIPromise<BrowserCacheTTL> {
const { zone_id, ...body } = params;
return (
this._client.patch(`/zones/${zone_id}/settings/browser_cache_ttl`, {
body,
...options,
}) as Core.APIPromise<{ result: ZoneSettingBrowserCacheTTL }>
}) as Core.APIPromise<{ result: BrowserCacheTTL }>
)._thenUnwrap((obj) => obj.result);
}

Expand All @@ -30,14 +27,11 @@ export class BrowserCacheTTL extends APIResource {
* specified by your server.
* (https://support.cloudflare.com/hc/en-us/articles/200168276).
*/
get(
params: BrowserCacheTTLGetParams,
options?: Core.RequestOptions,
): Core.APIPromise<ZoneSettingBrowserCacheTTL> {
get(params: BrowserCacheTTLGetParams, options?: Core.RequestOptions): Core.APIPromise<BrowserCacheTTL> {
const { zone_id } = params;
return (
this._client.get(`/zones/${zone_id}/settings/browser_cache_ttl`, options) as Core.APIPromise<{
result: ZoneSettingBrowserCacheTTL;
result: BrowserCacheTTL;
}>
)._thenUnwrap((obj) => obj.result);
}
Expand All @@ -49,7 +43,7 @@ export class BrowserCacheTTL extends APIResource {
* specified by your server.
* (https://support.cloudflare.com/hc/en-us/articles/200168276).
*/
export interface ZoneSettingBrowserCacheTTL {
export interface BrowserCacheTTL {
/**
* ID of the zone setting.
*/
Expand Down Expand Up @@ -148,8 +142,8 @@ export interface BrowserCacheTTLGetParams {
zone_id: string;
}

export namespace BrowserCacheTTL {
export import ZoneSettingBrowserCacheTTL = BrowserCacheTTLAPI.ZoneSettingBrowserCacheTTL;
export namespace BrowserCacheTTLResource {
export import BrowserCacheTTL = BrowserCacheTTLAPI.BrowserCacheTTL;
export import BrowserCacheTTLEditParams = BrowserCacheTTLAPI.BrowserCacheTTLEditParams;
export import BrowserCacheTTLGetParams = BrowserCacheTTLAPI.BrowserCacheTTLGetParams;
}
Loading

0 comments on commit 98131b1

Please sign in to comment.