release: 3.0.0-beta.10 (#183)

* feat(api): update via SDK Studio (#182)

* feat(api): update via SDK Studio (#184)

* feat(api): update via SDK Studio (#185)

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

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

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

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

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

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

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

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

* feat(api): update via SDK Studio (#194)

* release: 3.0.0-beta.10

---------

Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com>

Author: stainless-app[bot]

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "3.0.0-beta.9"
+  ".": "3.0.0-beta.10"
 }

.stats.yml

@@ -1 +1 @@
-configured_endpoints: 1288
+configured_endpoints: 1290

CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## 3.0.0-beta.10 (2024-03-22)
+
+Full Changelog: [v3.0.0-beta.9...v3.0.0-beta.10](https://github.com/cloudflare/cloudflare-typescript/compare/v3.0.0-beta.9...v3.0.0-beta.10)
+
+### Features
+
+* **api:** OpenAPI spec update via Stainless API ([#186](https://github.com/cloudflare/cloudflare-typescript/issues/186)) ([024ba76](https://github.com/cloudflare/cloudflare-typescript/commit/024ba7680bff3727e2a36bf69927986241d5d917))
+* **api:** OpenAPI spec update via Stainless API ([#187](https://github.com/cloudflare/cloudflare-typescript/issues/187)) ([5b84f38](https://github.com/cloudflare/cloudflare-typescript/commit/5b84f380e47f8b651bbfc6c85fb61fe520ca3c1d))
+* **api:** OpenAPI spec update via Stainless API ([#188](https://github.com/cloudflare/cloudflare-typescript/issues/188)) ([3b4fe72](https://github.com/cloudflare/cloudflare-typescript/commit/3b4fe72c2a4d292d99ff4f429267e92ee9f37527))
+* **api:** OpenAPI spec update via Stainless API ([#189](https://github.com/cloudflare/cloudflare-typescript/issues/189)) ([354cf29](https://github.com/cloudflare/cloudflare-typescript/commit/354cf29b191629b5a8aea8421adbb84fc4b2e6e1))
+* **api:** OpenAPI spec update via Stainless API ([#190](https://github.com/cloudflare/cloudflare-typescript/issues/190)) ([9bbb0b2](https://github.com/cloudflare/cloudflare-typescript/commit/9bbb0b225fd0491df79cdf79a3176741dc88ce78))
+* **api:** OpenAPI spec update via Stainless API ([#191](https://github.com/cloudflare/cloudflare-typescript/issues/191)) ([588680a](https://github.com/cloudflare/cloudflare-typescript/commit/588680a0980dca8f5f3fcb9bfce85b13820aeddf))
+* **api:** OpenAPI spec update via Stainless API ([#192](https://github.com/cloudflare/cloudflare-typescript/issues/192)) ([3506528](https://github.com/cloudflare/cloudflare-typescript/commit/3506528c28e585dc6c4b9304d245f78543b33299))
+* **api:** OpenAPI spec update via Stainless API ([#193](https://github.com/cloudflare/cloudflare-typescript/issues/193)) ([282f368](https://github.com/cloudflare/cloudflare-typescript/commit/282f36847679192774a9e3b80610212b54f0e509))
+* **api:** update via SDK Studio ([#182](https://github.com/cloudflare/cloudflare-typescript/issues/182)) ([2274ba0](https://github.com/cloudflare/cloudflare-typescript/commit/2274ba02940a382c2958504eaf31a7a1cd66efd7))
+* **api:** update via SDK Studio ([#184](https://github.com/cloudflare/cloudflare-typescript/issues/184)) ([84eba2c](https://github.com/cloudflare/cloudflare-typescript/commit/84eba2cd4b8d375f0eed13319d79f7fcbda74005))
+* **api:** update via SDK Studio ([#185](https://github.com/cloudflare/cloudflare-typescript/issues/185)) ([3ba723d](https://github.com/cloudflare/cloudflare-typescript/commit/3ba723d01f2bf9a90c90b640fa3e8c42ad6b8f39))
+* **api:** update via SDK Studio ([#194](https://github.com/cloudflare/cloudflare-typescript/issues/194)) ([5fd3ecf](https://github.com/cloudflare/cloudflare-typescript/commit/5fd3ecfd964ab6623c37bf01a979b57b0623745a))
+
 ## 3.0.0-beta.9 (2024-03-20)
 
 Full Changelog: [v3.0.0-beta.8...v3.0.0-beta.9](https://github.com/cloudflare/cloudflare-typescript/compare/v3.0.0-beta.8...v3.0.0-beta.9)

README.md

@@ -6,6 +6,8 @@ This library provides convenient access to the Cloudflare REST API from server-s
 
 The REST API documentation can be found [on developers.cloudflare.com](https://developers.cloudflare.com/api). The full API of this library can be found in [api.md](api.md).
 
+It is generated with [Stainless](https://www.stainlessapi.com/).
+
 ## Installation
 
 ```sh
@@ -201,7 +203,51 @@ console.log(raw.headers.get('X-My-Header'));
 console.log(zone.id);
 ```
 
-## Customizing the fetch client
+### Making custom/undocumented requests
+
+This library is typed for convenient access to the documented API. If you need to access undocumented
+endpoints, params, or response properties, the library can still be used.
+
+#### Undocumented endpoints
+
+To make requests to undocumented endpoints, you can use `client.get`, `client.post`, and other HTTP verbs.
+Options on the client, such as retries, will be respected when making these requests.
+
+```ts
+await client.post('/some/path', {
+  body: { some_prop: 'foo' },
+  query: { some_query_arg: 'bar' },
+});
+```
+
+#### Undocumented params
+
+To make requests using undocumented parameters, you may use `// @ts-expect-error` on the undocumented
+parameter. This library doesn't validate at runtime that the request matches the type, so any extra values you
+send will be sent as-is.
+
+```ts
+client.foo.create({
+  foo: 'my_param',
+  bar: 12,
+  // @ts-expect-error baz is not yet public
+  baz: 'undocumented option',
+});
+```
+
+For requests with the `GET` verb, any extra params will be in the query, all other requests will send the
+extra param in the body.
+
+If you want to explicitly send an extra argument, you can do so with the `query`, `body`, and `headers` request
+options.
+
+#### Undocumented properties
+
+To access undocumented response properties, you may access the response object with `// @ts-expect-error` on
+the response object, or cast the response object to the requisite type. Like the request params, we do not
+validate or strip extra properties from the response from the API.
+
+### Customizing the fetch client
 
 By default, this library uses `node-fetch` in Node, and expects a global `fetch` function in other environments.
 
@@ -219,6 +265,8 @@ import Cloudflare from 'cloudflare';
 To do the inverse, add `import "cloudflare/shims/node"` (which does import polyfills).
 This can also be useful if you are getting the wrong TypeScript types for `Response` ([more details](https://github.com/cloudflare/cloudflare-typescript/tree/main/src/_shims#readme)).
 
+### Logging and middleware
+
 You may also provide a custom `fetch` function when instantiating the client,
 which can be used to inspect or alter the `Request` or `Response` before/after each request:
 
@@ -239,7 +287,7 @@ const client = new Cloudflare({
 Note that if given a `DEBUG=true` environment variable, this library will log all requests and responses automatically.
 This is intended for debugging purposes only and may change in the future without notice.
 
-## Configuring an HTTP(S) Agent (e.g., for proxies)
+### Configuring an HTTP(S) Agent (e.g., for proxies)
 
 By default, this library uses a stable agent for all http/https requests to reuse TCP connections, eliminating many TCP & TLS handshakes and shaving around 100ms off most requests.
 

api.md

@@ -1,3 +1,9 @@
+# Shared
+
+Types:
+
+- <code><a href="./src/resources/shared.ts">ErrorData</a></code>
+
 # Accounts
 
 Types:
@@ -330,6 +336,18 @@ Methods:
 
 - <code title="put /zones/{zone_id}/activation_check">client.zones.activationCheck.<a href="./src/resources/zones/activation-check.ts">trigger</a>({ ...params }) -> ActivationCheckTriggerResponse</code>
 
+## DNSSettings
+
+Types:
+
+- <code><a href="./src/resources/zones/dns-settings.ts">DNSSettingEditResponse</a></code>
+- <code><a href="./src/resources/zones/dns-settings.ts">DNSSettingGetResponse</a></code>
+
+Methods:
+
+- <code title="patch /zones/{zone_id}/dns_settings">client.zones.dnsSettings.<a href="./src/resources/zones/dns-settings.ts">edit</a>({ ...params }) -> DNSSettingEditResponse</code>
+- <code title="get /zones/{zone_id}/dns_settings">client.zones.dnsSettings.<a href="./src/resources/zones/dns-settings.ts">get</a>({ ...params }) -> DNSSettingGetResponse</code>
+
 ## Settings
 
 Types:
@@ -3173,33 +3191,33 @@ Methods:
 
 Types:
 
-- <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IntelIndicatorFeedItem</a></code>
-- <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IntelIndicatorFeedMetadata</a></code>
-- <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IntelUpdateFeed</a></code>
+- <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IndicatorFeedCreateResponse</a></code>
+- <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IndicatorFeedUpdateResponse</a></code>
 - <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IndicatorFeedListResponse</a></code>
 - <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IndicatorFeedDataResponse</a></code>
+- <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IndicatorFeedGetResponse</a></code>
 
 Methods:
 
-- <code title="post /accounts/{account_id}/intel/indicator-feeds">client.intel.indicatorFeeds.<a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">create</a>({ ...params }) -> IntelIndicatorFeedItem</code>
-- <code title="put /accounts/{account_id}/intel/indicator-feeds/{feed_id}/snapshot">client.intel.indicatorFeeds.<a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">update</a>(feedId, { ...params }) -> IntelUpdateFeed</code>
+- <code title="post /accounts/{account_id}/intel/indicator-feeds">client.intel.indicatorFeeds.<a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">create</a>({ ...params }) -> IndicatorFeedCreateResponse</code>
+- <code title="put /accounts/{account_id}/intel/indicator-feeds/{feed_id}/snapshot">client.intel.indicatorFeeds.<a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">update</a>(feedId, { ...params }) -> IndicatorFeedUpdateResponse</code>
 - <code title="get /accounts/{account_id}/intel/indicator-feeds">client.intel.indicatorFeeds.<a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">list</a>({ ...params }) -> IndicatorFeedListResponse</code>
 - <code title="get /accounts/{account_id}/intel/indicator-feeds/{feed_id}/data">client.intel.indicatorFeeds.<a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">data</a>(feedId, { ...params }) -> string</code>
-- <code title="get /accounts/{account_id}/intel/indicator-feeds/{feed_id}">client.intel.indicatorFeeds.<a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">get</a>(feedId, { ...params }) -> IntelIndicatorFeedMetadata</code>
+- <code title="get /accounts/{account_id}/intel/indicator-feeds/{feed_id}">client.intel.indicatorFeeds.<a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">get</a>(feedId, { ...params }) -> IndicatorFeedGetResponse</code>
 
 ### Permissions
 
 Types:
 
-- <code><a href="./src/resources/intel/indicator-feeds/permissions.ts">IntelPermissionListItem</a></code>
-- <code><a href="./src/resources/intel/indicator-feeds/permissions.ts">IntelPermissionsUpdate</a></code>
+- <code><a href="./src/resources/intel/indicator-feeds/permissions.ts">PermissionCreateResponse</a></code>
 - <code><a href="./src/resources/intel/indicator-feeds/permissions.ts">PermissionListResponse</a></code>
+- <code><a href="./src/resources/intel/indicator-feeds/permissions.ts">PermissionDeleteResponse</a></code>
 
 Methods:
 
-- <code title="put /accounts/{account_id}/intel/indicator-feeds/permissions/add">client.intel.indicatorFeeds.permissions.<a href="./src/resources/intel/indicator-feeds/permissions.ts">create</a>({ ...params }) -> IntelPermissionsUpdate</code>
+- <code title="put /accounts/{account_id}/intel/indicator-feeds/permissions/add">client.intel.indicatorFeeds.permissions.<a href="./src/resources/intel/indicator-feeds/permissions.ts">create</a>({ ...params }) -> PermissionCreateResponse</code>
 - <code title="get /accounts/{account_id}/intel/indicator-feeds/permissions/view">client.intel.indicatorFeeds.permissions.<a href="./src/resources/intel/indicator-feeds/permissions.ts">list</a>({ ...params }) -> PermissionListResponse</code>
-- <code title="put /accounts/{account_id}/intel/indicator-feeds/permissions/remove">client.intel.indicatorFeeds.permissions.<a href="./src/resources/intel/indicator-feeds/permissions.ts">delete</a>({ ...params }) -> IntelPermissionsUpdate</code>
+- <code title="put /accounts/{account_id}/intel/indicator-feeds/permissions/remove">client.intel.indicatorFeeds.permissions.<a href="./src/resources/intel/indicator-feeds/permissions.ts">delete</a>({ ...params }) -> PermissionDeleteResponse</code>
 
 ## Sinkholes
 
@@ -3398,17 +3416,17 @@ Types:
 
 Methods:
 
-- <code title="post /accounts/{account_identifier}/mnm/config">client.magicNetworkMonitoring.configs.<a href="./src/resources/magic-network-monitoring/configs/configs.ts">create</a>(accountIdentifier) -> MagicVisibilityMNMConfig</code>
-- <code title="put /accounts/{account_identifier}/mnm/config">client.magicNetworkMonitoring.configs.<a href="./src/resources/magic-network-monitoring/configs/configs.ts">update</a>(accountIdentifier) -> MagicVisibilityMNMConfig</code>
-- <code title="delete /accounts/{account_identifier}/mnm/config">client.magicNetworkMonitoring.configs.<a href="./src/resources/magic-network-monitoring/configs/configs.ts">delete</a>(accountIdentifier) -> MagicVisibilityMNMConfig</code>
-- <code title="patch /accounts/{account_identifier}/mnm/config">client.magicNetworkMonitoring.configs.<a href="./src/resources/magic-network-monitoring/configs/configs.ts">edit</a>(accountIdentifier) -> MagicVisibilityMNMConfig</code>
-- <code title="get /accounts/{account_identifier}/mnm/config">client.magicNetworkMonitoring.configs.<a href="./src/resources/magic-network-monitoring/configs/configs.ts">get</a>(accountIdentifier) -> MagicVisibilityMNMConfig</code>
+- <code title="post /accounts/{account_id}/mnm/config">client.magicNetworkMonitoring.configs.<a href="./src/resources/magic-network-monitoring/configs/configs.ts">create</a>({ ...params }) -> MagicVisibilityMNMConfig</code>
+- <code title="put /accounts/{account_id}/mnm/config">client.magicNetworkMonitoring.configs.<a href="./src/resources/magic-network-monitoring/configs/configs.ts">update</a>({ ...params }) -> MagicVisibilityMNMConfig</code>
+- <code title="delete /accounts/{account_id}/mnm/config">client.magicNetworkMonitoring.configs.<a href="./src/resources/magic-network-monitoring/configs/configs.ts">delete</a>({ ...params }) -> MagicVisibilityMNMConfig</code>
+- <code title="patch /accounts/{account_id}/mnm/config">client.magicNetworkMonitoring.configs.<a href="./src/resources/magic-network-monitoring/configs/configs.ts">edit</a>({ ...params }) -> MagicVisibilityMNMConfig</code>
+- <code title="get /accounts/{account_id}/mnm/config">client.magicNetworkMonitoring.configs.<a href="./src/resources/magic-network-monitoring/configs/configs.ts">get</a>({ ...params }) -> MagicVisibilityMNMConfig</code>
 
 ### Full
 
 Methods:
 
-- <code title="get /accounts/{account_identifier}/mnm/config/full">client.magicNetworkMonitoring.configs.full.<a href="./src/resources/magic-network-monitoring/configs/full.ts">get</a>(accountIdentifier) -> MagicVisibilityMNMConfig</code>
+- <code title="get /accounts/{account_id}/mnm/config/full">client.magicNetworkMonitoring.configs.full.<a href="./src/resources/magic-network-monitoring/configs/full.ts">get</a>({ ...params }) -> MagicVisibilityMNMConfig</code>
 
 ## Rules
 
@@ -3419,12 +3437,12 @@ Types:
 
 Methods:
 
-- <code title="post /accounts/{account_identifier}/mnm/rules">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">create</a>(accountIdentifier) -> MagicVisibilityMNMRule | null</code>
-- <code title="put /accounts/{account_identifier}/mnm/rules">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">update</a>(accountIdentifier) -> MagicVisibilityMNMRule | null</code>
-- <code title="get /accounts/{account_identifier}/mnm/rules">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">list</a>(accountIdentifier) -> RuleListResponse | null</code>
-- <code title="delete /accounts/{account_identifier}/mnm/rules/{rule_identifier}">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">delete</a>(accountIdentifier, ruleIdentifier) -> MagicVisibilityMNMRule | null</code>
-- <code title="patch /accounts/{account_identifier}/mnm/rules/{rule_identifier}">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">edit</a>(accountIdentifier, ruleIdentifier) -> MagicVisibilityMNMRule | null</code>
-- <code title="get /accounts/{account_identifier}/mnm/rules/{rule_identifier}">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">get</a>(accountIdentifier, ruleIdentifier) -> MagicVisibilityMNMRule | null</code>
+- <code title="post /accounts/{account_id}/mnm/rules">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">create</a>({ ...params }) -> MagicVisibilityMNMRule | null</code>
+- <code title="put /accounts/{account_id}/mnm/rules">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">update</a>({ ...params }) -> MagicVisibilityMNMRule | null</code>
+- <code title="get /accounts/{account_id}/mnm/rules">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">list</a>({ ...params }) -> RuleListResponse | null</code>
+- <code title="delete /accounts/{account_id}/mnm/rules/{rule_id}">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">delete</a>(ruleId, { ...params }) -> MagicVisibilityMNMRule | null</code>
+- <code title="patch /accounts/{account_id}/mnm/rules/{rule_id}">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">edit</a>(ruleId, { ...params }) -> MagicVisibilityMNMRule | null</code>
+- <code title="get /accounts/{account_id}/mnm/rules/{rule_id}">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">get</a>(ruleId, { ...params }) -> MagicVisibilityMNMRule | null</code>
 
 ### Advertisements
 
@@ -3434,7 +3452,7 @@ Types:
 
 Methods:
 
-- <code title="patch /accounts/{account_identifier}/mnm/rules/{rule_identifier}/advertisement">client.magicNetworkMonitoring.rules.advertisements.<a href="./src/resources/magic-network-monitoring/rules/advertisements.ts">edit</a>(accountIdentifier, ruleIdentifier) -> MagicVisibilityMNMRuleAdvertisable | null</code>
+- <code title="patch /accounts/{account_id}/mnm/rules/{rule_id}/advertisement">client.magicNetworkMonitoring.rules.advertisements.<a href="./src/resources/magic-network-monitoring/rules/advertisements.ts">edit</a>(ruleId, { ...params }) -> MagicVisibilityMNMRuleAdvertisable | null</code>
 
 # MTLSCertificates
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloudflare",
-  "version": "3.0.0-beta.9",
+  "version": "3.0.0-beta.10",
   "description": "The official TypeScript library for the Cloudflare API",
   "author": "Cloudflare <[email protected]>",
   "types": "dist/index.d.ts",

src/core.ts

@@ -1059,7 +1059,7 @@ function applyHeadersMut(targetHeaders: Headers, newHeaders: Headers): void {
 }
 
 export function debug(action: string, ...args: any[]) {
-  if (typeof process !== 'undefined' && process.env['DEBUG'] === 'true') {
+  if (typeof process !== 'undefined' && process?.env?.['DEBUG'] === 'true') {
     console.log(`Cloudflare:DEBUG:${action}`, ...args);
   }
 }

src/error.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { castToError, Headers } from './core';
+import * as Shared from 'cloudflare/resources/shared';
 
 export class CloudflareError extends Error {}
 
@@ -9,6 +10,8 @@ export class APIError extends CloudflareError {
   readonly headers: Headers | undefined;
   readonly error: Object | undefined;
 
+  readonly errors: Array<Shared.ErrorData>;
+
   constructor(
     status: number | undefined,
     error: Object | undefined,
@@ -18,7 +21,10 @@ export class APIError extends CloudflareError {
     super(`${APIError.makeMessage(status, error, message)}`);
     this.status = status;
     this.headers = headers;
-    this.error = error;
+
+    const data = error as Record<string, any>;
+    this.error = data;
+    this.errors = data?.['errors'] ?? [];
   }
 
   private static makeMessage(status: number | undefined, error: any, message: string | undefined) {