feat: OpenAPI spec update via Stainless API (#107)

cloudflare · Mar 5, 2024 · 71186a5 · 71186a5
1 parent a5d05d5
commit 71186a5
Show file tree

Hide file tree

Showing 470 changed files with 2,450 additions and 482 deletions.
diff --git a/README.md b/README.md
@@ -23,7 +23,10 @@ The full API of this library can be found in [api.md](api.md).
 ```js
 import Cloudflare from 'cloudflare';
 
-const cloudflare = new Cloudflare();
+const cloudflare = new Cloudflare({
+  apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted
+  apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted
+});
 
 async function main() {
   const zoneCreateResponse = await cloudflare.zones.create({
@@ -46,7 +49,10 @@ This library includes TypeScript definitions for all request params and response
 ```ts
 import Cloudflare from 'cloudflare';
 
-const cloudflare = new Cloudflare();
+const cloudflare = new Cloudflare({
+  apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted
+  apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted
+});
 
 async function main() {
   const params: Cloudflare.ZoneCreateParams = {

diff --git a/src/index.ts b/src/index.ts
@@ -274,6 +274,23 @@ export class Cloudflare extends Core.APIClient {
     const apiKeyAuth = this.apiKeyAuth(opts);
     const apiTokenAuth = this.apiTokenAuth(opts);
     const userServiceKeyAuth = this.userServiceKeyAuth(opts);
+
+    if (
+      apiEmailAuth != null &&
+      !Core.isEmptyObj(apiEmailAuth) &&
+      apiKeyAuth != null &&
+      !Core.isEmptyObj(apiKeyAuth)
+    ) {
+      return { ...apiEmailAuth, ...apiKeyAuth };
+    }
+
+    if (apiTokenAuth != null && !Core.isEmptyObj(apiTokenAuth)) {
+      return apiTokenAuth;
+    }
+
+    if (userServiceKeyAuth != null && !Core.isEmptyObj(userServiceKeyAuth)) {
+      return userServiceKeyAuth;
+    }
     return {};
   }
 

diff --git a/tests/api-resources/accounts/accounts.test.ts b/tests/api-resources/accounts/accounts.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource accounts', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/accounts/members.test.ts b/tests/api-resources/accounts/members.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource members', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/accounts/roles.test.ts b/tests/api-resources/accounts/roles.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource roles', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/acm/total-tls.test.ts b/tests/api-resources/acm/total-tls.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource totalTLS', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/addressing/address-maps/accounts.test.ts b/tests/api-resources/addressing/address-maps/accounts.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource accounts', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/addressing/address-maps/address-maps.test.ts b/tests/api-resources/addressing/address-maps/address-maps.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource addressMaps', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/addressing/address-maps/ips.test.ts b/tests/api-resources/addressing/address-maps/ips.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource ips', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/addressing/address-maps/zones.test.ts b/tests/api-resources/addressing/address-maps/zones.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource zones', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/addressing/loa-documents/downloads.test.ts b/tests/api-resources/addressing/loa-documents/downloads.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource downloads', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/addressing/loa-documents/loa-documents.test.ts b/tests/api-resources/addressing/loa-documents/loa-documents.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource loaDocuments', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/addressing/prefixes/bgp/bindings.test.ts b/tests/api-resources/addressing/prefixes/bgp/bindings.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource bindings', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/addressing/prefixes/bgp/prefixes.test.ts b/tests/api-resources/addressing/prefixes/bgp/prefixes.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource prefixes', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/addressing/prefixes/bgp/statuses.test.ts b/tests/api-resources/addressing/prefixes/bgp/statuses.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource statuses', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/addressing/prefixes/delegations.test.ts b/tests/api-resources/addressing/prefixes/delegations.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource delegations', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/addressing/prefixes/prefixes.test.ts b/tests/api-resources/addressing/prefixes/prefixes.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource prefixes', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/addressing/services.test.ts b/tests/api-resources/addressing/services.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource services', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/alerting/v3/destinations/eligible.test.ts b/tests/api-resources/alerting/v3/destinations/eligible.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource eligible', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/alerting/v3/destinations/pagerduty.test.ts b/tests/api-resources/alerting/v3/destinations/pagerduty.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource pagerduty', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/alerting/v3/destinations/webhooks.test.ts b/tests/api-resources/alerting/v3/destinations/webhooks.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource webhooks', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/alerting/v3/histories.test.ts b/tests/api-resources/alerting/v3/histories.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource histories', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/alerting/v3/policies.test.ts b/tests/api-resources/alerting/v3/policies.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource policies', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/alerting/v3/v3.test.ts b/tests/api-resources/alerting/v3/v3.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource v3', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/argo/smart-routing.test.ts b/tests/api-resources/argo/smart-routing.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource smartRouting', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/argo/tiered-caching.test.ts b/tests/api-resources/argo/tiered-caching.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource tieredCaching', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/audit-logs.test.ts b/tests/api-resources/audit-logs.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource auditLogs', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/available-plans.test.ts b/tests/api-resources/available-plans.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource availablePlans', () => {
   // skipped: tests are disabled for the time being

diff --git a/tests/api-resources/available-rate-plans.test.ts b/tests/api-resources/available-rate-plans.test.ts
@@ -3,7 +3,11 @@
 import Cloudflare from 'cloudflare';
 import { Response } from 'node-fetch';
 
-const cloudflare = new Cloudflare({ baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010' });
+const cloudflare = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: 'user@example.com',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
 
 describe('resource availableRatePlans', () => {
   // skipped: tests are disabled for the time being