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

Author: stainless-app[bot]

README.md

@@ -26,13 +26,13 @@ const cloudflare = new Cloudflare({
 });
 
 async function main() {
-  const zoneCreateResponse = await cloudflare.zones.create({
+  const zone = await cloudflare.zones.create({
     account: { id: '023e105f4ecef8ad9ca31a8372d0c353' },
     name: 'example.com',
     type: 'full',
   });
 
-  console.log(zoneCreateResponse.id);
+  console.log(zone.id);
 }
 
 main();
@@ -57,7 +57,7 @@ async function main() {
     name: 'example.com',
     type: 'full',
   };
-  const zoneCreateResponse: Cloudflare.ZoneCreateResponse = await cloudflare.zones.create(params);
+  const zone: Cloudflare.Zone = await cloudflare.zones.create(params);
 }
 
 main();
@@ -194,11 +194,11 @@ const response = await cloudflare.zones
 console.log(response.headers.get('X-My-Header'));
 console.log(response.statusText); // access the underlying Response object
 
-const { data: zoneCreateResponse, response: raw } = await cloudflare.zones
+const { data: zone, response: raw } = await cloudflare.zones
   .create({ account: { id: '023e105f4ecef8ad9ca31a8372d0c353' }, name: 'example.com', type: 'full' })
   .withResponse();
 console.log(raw.headers.get('X-My-Header'));
-console.log(zoneCreateResponse.id);
+console.log(zone.id);
 ```
 
 ## Customizing the fetch client
@@ -264,7 +264,7 @@ await cloudflare.zones.delete(
 );
 ```
 
-## Semantic Versioning
+## Semantic versioning
 
 This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
 

api.md

@@ -310,19 +310,15 @@ Methods:
 Types:
 
 - <code><a href="./src/resources/zones/zones.ts">Zone</a></code>
-- <code><a href="./src/resources/zones/zones.ts">ZoneCreateResponse</a></code>
-- <code><a href="./src/resources/zones/zones.ts">ZoneListResponse</a></code>
 - <code><a href="./src/resources/zones/zones.ts">ZoneDeleteResponse</a></code>
-- <code><a href="./src/resources/zones/zones.ts">ZoneEditResponse</a></code>
-- <code><a href="./src/resources/zones/zones.ts">ZoneGetResponse</a></code>
 
 Methods:
 
-- <code title="post /zones">client.zones.<a href="./src/resources/zones/zones.ts">create</a>({ ...params }) -> ZoneCreateResponse</code>
-- <code title="get /zones">client.zones.<a href="./src/resources/zones/zones.ts">list</a>({ ...params }) -> ZoneListResponsesV4PagePaginationArray</code>
+- <code title="post /zones">client.zones.<a href="./src/resources/zones/zones.ts">create</a>({ ...params }) -> Zone</code>
+- <code title="get /zones">client.zones.<a href="./src/resources/zones/zones.ts">list</a>({ ...params }) -> ZonesV4PagePaginationArray</code>
 - <code title="delete /zones/{zone_id}">client.zones.<a href="./src/resources/zones/zones.ts">delete</a>({ ...params }) -> ZoneDeleteResponse | null</code>
-- <code title="patch /zones/{zone_id}">client.zones.<a href="./src/resources/zones/zones.ts">edit</a>({ ...params }) -> ZoneEditResponse</code>
-- <code title="get /zones/{zone_id}">client.zones.<a href="./src/resources/zones/zones.ts">get</a>({ ...params }) -> ZoneGetResponse</code>
+- <code title="patch /zones/{zone_id}">client.zones.<a href="./src/resources/zones/zones.ts">edit</a>({ ...params }) -> Zone</code>
+- <code title="get /zones/{zone_id}">client.zones.<a href="./src/resources/zones/zones.ts">get</a>({ ...params }) -> Zone</code>
 
 ## ActivationCheck
 
@@ -1424,25 +1420,20 @@ Methods:
 Types:
 
 - <code><a href="./src/resources/dns/records.ts">DNSRecord</a></code>
-- <code><a href="./src/resources/dns/records.ts">RecordCreateResponse</a></code>
-- <code><a href="./src/resources/dns/records.ts">RecordUpdateResponse</a></code>
-- <code><a href="./src/resources/dns/records.ts">RecordListResponse</a></code>
 - <code><a href="./src/resources/dns/records.ts">RecordDeleteResponse</a></code>
-- <code><a href="./src/resources/dns/records.ts">RecordEditResponse</a></code>
 - <code><a href="./src/resources/dns/records.ts">RecordExportResponse</a></code>
-- <code><a href="./src/resources/dns/records.ts">RecordGetResponse</a></code>
 - <code><a href="./src/resources/dns/records.ts">RecordImportResponse</a></code>
 - <code><a href="./src/resources/dns/records.ts">RecordScanResponse</a></code>
 
 Methods:
 
-- <code title="post /zones/{zone_id}/dns_records">client.dns.records.<a href="./src/resources/dns/records.ts">create</a>({ ...params }) -> RecordCreateResponse</code>
-- <code title="put /zones/{zone_id}/dns_records/{dns_record_id}">client.dns.records.<a href="./src/resources/dns/records.ts">update</a>(dnsRecordId, { ...params }) -> RecordUpdateResponse</code>
-- <code title="get /zones/{zone_id}/dns_records">client.dns.records.<a href="./src/resources/dns/records.ts">list</a>({ ...params }) -> RecordListResponsesV4PagePaginationArray</code>
+- <code title="post /zones/{zone_id}/dns_records">client.dns.records.<a href="./src/resources/dns/records.ts">create</a>({ ...params }) -> DNSRecord</code>
+- <code title="put /zones/{zone_id}/dns_records/{dns_record_id}">client.dns.records.<a href="./src/resources/dns/records.ts">update</a>(dnsRecordId, { ...params }) -> DNSRecord</code>
+- <code title="get /zones/{zone_id}/dns_records">client.dns.records.<a href="./src/resources/dns/records.ts">list</a>({ ...params }) -> DNSRecordsV4PagePaginationArray</code>
 - <code title="delete /zones/{zone_id}/dns_records/{dns_record_id}">client.dns.records.<a href="./src/resources/dns/records.ts">delete</a>(dnsRecordId, { ...params }) -> RecordDeleteResponse</code>
-- <code title="patch /zones/{zone_id}/dns_records/{dns_record_id}">client.dns.records.<a href="./src/resources/dns/records.ts">edit</a>(dnsRecordId, { ...params }) -> RecordEditResponse</code>
+- <code title="patch /zones/{zone_id}/dns_records/{dns_record_id}">client.dns.records.<a href="./src/resources/dns/records.ts">edit</a>(dnsRecordId, { ...params }) -> DNSRecord</code>
 - <code title="get /zones/{zone_id}/dns_records/export">client.dns.records.<a href="./src/resources/dns/records.ts">export</a>({ ...params }) -> string</code>
-- <code title="get /zones/{zone_id}/dns_records/{dns_record_id}">client.dns.records.<a href="./src/resources/dns/records.ts">get</a>(dnsRecordId, { ...params }) -> RecordGetResponse</code>
+- <code title="get /zones/{zone_id}/dns_records/{dns_record_id}">client.dns.records.<a href="./src/resources/dns/records.ts">get</a>(dnsRecordId, { ...params }) -> DNSRecord</code>
 - <code title="post /zones/{zone_id}/dns_records/import">client.dns.records.<a href="./src/resources/dns/records.ts">import</a>({ ...params }) -> RecordImportResponse</code>
 - <code title="post /zones/{zone_id}/dns_records/scan">client.dns.records.<a href="./src/resources/dns/records.ts">scan</a>({ ...params }) -> RecordScanResponse</code>
 

src/index.ts

@@ -429,12 +429,8 @@ export namespace Cloudflare {
 
   export import Zones = API.Zones;
   export import Zone = API.Zone;
-  export import ZoneCreateResponse = API.ZoneCreateResponse;
-  export import ZoneListResponse = API.ZoneListResponse;
   export import ZoneDeleteResponse = API.ZoneDeleteResponse;
-  export import ZoneEditResponse = API.ZoneEditResponse;
-  export import ZoneGetResponse = API.ZoneGetResponse;
-  export import ZoneListResponsesV4PagePaginationArray = API.ZoneListResponsesV4PagePaginationArray;
+  export import ZonesV4PagePaginationArray = API.ZonesV4PagePaginationArray;
   export import ZoneCreateParams = API.ZoneCreateParams;
   export import ZoneListParams = API.ZoneListParams;
   export import ZoneDeleteParams = API.ZoneDeleteParams;

src/resources/dns/dns.ts

@@ -14,16 +14,11 @@ export class DNS extends APIResource {
 export namespace DNS {
   export import Records = RecordsAPI.Records;
   export import DNSRecord = RecordsAPI.DNSRecord;
-  export import RecordCreateResponse = RecordsAPI.RecordCreateResponse;
-  export import RecordUpdateResponse = RecordsAPI.RecordUpdateResponse;
-  export import RecordListResponse = RecordsAPI.RecordListResponse;
   export import RecordDeleteResponse = RecordsAPI.RecordDeleteResponse;
-  export import RecordEditResponse = RecordsAPI.RecordEditResponse;
   export import RecordExportResponse = RecordsAPI.RecordExportResponse;
-  export import RecordGetResponse = RecordsAPI.RecordGetResponse;
   export import RecordImportResponse = RecordsAPI.RecordImportResponse;
   export import RecordScanResponse = RecordsAPI.RecordScanResponse;
-  export import RecordListResponsesV4PagePaginationArray = RecordsAPI.RecordListResponsesV4PagePaginationArray;
+  export import DNSRecordsV4PagePaginationArray = RecordsAPI.DNSRecordsV4PagePaginationArray;
   export import RecordCreateParams = RecordsAPI.RecordCreateParams;
   export import RecordUpdateParams = RecordsAPI.RecordUpdateParams;
   export import RecordListParams = RecordsAPI.RecordListParams;

src/resources/dns/index.ts

@@ -15,13 +15,8 @@ export {
 } from './firewall/index';
 export {
   DNSRecord,
-  RecordCreateResponse,
-  RecordUpdateResponse,
-  RecordListResponse,
   RecordDeleteResponse,
-  RecordEditResponse,
   RecordExportResponse,
-  RecordGetResponse,
   RecordImportResponse,
   RecordScanResponse,
   RecordCreateParams,
@@ -33,6 +28,6 @@ export {
   RecordGetParams,
   RecordImportParams,
   RecordScanParams,
-  RecordListResponsesV4PagePaginationArray,
+  DNSRecordsV4PagePaginationArray,
   Records,
 } from './records';