cloudflare 5.1.0 → 6.0.0-beta.1

package/src/resources/d1/index.ts

@@ -22,4 +22,4 @@ export {
   type DatabaseImportParams,
   type DatabaseQueryParams,
   type DatabaseRawParams,
-} from './database';
+} from './database/index';

package/src/resources/dns/dns.ts

@@ -41,9 +41,15 @@ import {
   RecordImportResponse,
   RecordListParams,
   RecordResponse,
+  RecordResponsesSinglePage,
   RecordResponsesV4PagePaginationArray,
+  RecordScanListParams,
   RecordScanParams,
   RecordScanResponse,
+  RecordScanReviewParams,
+  RecordScanReviewResponse,
+  RecordScanTriggerParams,
+  RecordScanTriggerResponse,
   RecordTags,
   RecordUpdateParams,
   Records,
@@ -59,7 +65,7 @@ import {
 import * as AnalyticsAPI from './analytics/analytics';
 import { Analytics } from './analytics/analytics';
 import * as SettingsAPI from './settings/settings';
-import { DNSSetting, Settings } from './settings/settings';
+import { Settings } from './settings/settings';
 import * as ZoneTransfersAPI from './zone-transfers/zone-transfers';
 import { ZoneTransfers } from './zone-transfers/zone-transfers';
 
@@ -74,6 +80,7 @@ export class DNS extends APIResource {
 DNS.DNSSECResource = DNSSECResource;
 DNS.Records = Records;
 DNS.RecordResponsesV4PagePaginationArray = RecordResponsesV4PagePaginationArray;
+DNS.RecordResponsesSinglePage = RecordResponsesSinglePage;
 DNS.Settings = Settings;
 DNS.Analytics = Analytics;
 DNS.ZoneTransfers = ZoneTransfers;
@@ -121,7 +128,10 @@ export declare namespace DNS {
     type RecordExportResponse as RecordExportResponse,
     type RecordImportResponse as RecordImportResponse,
     type RecordScanResponse as RecordScanResponse,
+    type RecordScanReviewResponse as RecordScanReviewResponse,
+    type RecordScanTriggerResponse as RecordScanTriggerResponse,
     RecordResponsesV4PagePaginationArray as RecordResponsesV4PagePaginationArray,
+    RecordResponsesSinglePage as RecordResponsesSinglePage,
     type RecordCreateParams as RecordCreateParams,
     type RecordUpdateParams as RecordUpdateParams,
     type RecordListParams as RecordListParams,
@@ -132,9 +142,12 @@ export declare namespace DNS {
     type RecordGetParams as RecordGetParams,
     type RecordImportParams as RecordImportParams,
     type RecordScanParams as RecordScanParams,
+    type RecordScanListParams as RecordScanListParams,
+    type RecordScanReviewParams as RecordScanReviewParams,
+    type RecordScanTriggerParams as RecordScanTriggerParams,
   };
 
-  export { Settings as Settings, type DNSSetting as DNSSetting };
+  export { Settings as Settings };
 
   export { Analytics as Analytics };
 

package/src/resources/dns/index.ts

@@ -12,6 +12,7 @@ export {
 } from './dnssec';
 export {
   RecordResponsesV4PagePaginationArray,
+  RecordResponsesSinglePage,
   Records,
   type ARecord,
   type AAAARecord,
@@ -44,6 +45,8 @@ export {
   type RecordExportResponse,
   type RecordImportResponse,
   type RecordScanResponse,
+  type RecordScanReviewResponse,
+  type RecordScanTriggerResponse,
   type RecordCreateParams,
   type RecordUpdateParams,
   type RecordListParams,
@@ -54,6 +57,9 @@ export {
   type RecordGetParams,
   type RecordImportParams,
   type RecordScanParams,
+  type RecordScanListParams,
+  type RecordScanReviewParams,
+  type RecordScanTriggerParams,
 } from './records';
-export { Settings, type DNSSetting } from './settings/index';
+export { Settings } from './settings/index';
 export { ZoneTransfers } from './zone-transfers/index';

package/src/resources/dns/records.ts

@@ -4,7 +4,7 @@ import { APIResource } from '../../resource';
 import * as Core from '../../core';
 import * as RecordsAPI from './records';
 import * as Shared from '../shared';
-import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../pagination';
+import { SinglePage, V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../pagination';
 
 export class Records extends APIResource {
   /**
@@ -273,13 +273,7 @@ export class Records extends APIResource {
    * Scan for common DNS records on your domain and automatically add them to your
    * zone. Useful if you haven't updated your nameservers yet.
    *
-   * @example
-   * ```ts
-   * const response = await client.dns.records.scan({
-   *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *   body: {},
-   * });
-   * ```
+   * @deprecated This endpoint is deprecated in favor of a new asynchronous version. Please use the [/scan/trigger](https://developers.cloudflare.com/api/resources/dns/subresources/records/methods/scan/trigger) and [/scan/review](https://developers.cloudflare.com/api/resources/dns/subresources/records/methods/scan/review) endpoints instead.
    */
   scan(params: RecordScanParams, options?: Core.RequestOptions): Core.APIPromise<RecordScanResponse> {
     const { zone_id, body } = params;
@@ -289,10 +283,86 @@ export class Records extends APIResource {
       }>
     )._thenUnwrap((obj) => obj.result);
   }
+
+  /**
+   * Retrieves the list of DNS records discovered up to this point by the
+   * asynchronous scan. These records are temporary until explicitly accepted or
+   * rejected via `POST /scan/review`. Additional records may be discovered by the
+   * scan later.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const recordResponse of client.dns.records.scanList(
+   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  scanList(
+    params: RecordScanListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<RecordResponsesSinglePage, RecordResponse> {
+    const { zone_id } = params;
+    return this._client.getAPIList(
+      `/zones/${zone_id}/dns_records/scan/review`,
+      RecordResponsesSinglePage,
+      options,
+    );
+  }
+
+  /**
+   * Accept or reject DNS records found by the DNS records scan. Accepted records
+   * will be permanently added to the zone, while rejected records will be
+   * permanently deleted.
+   *
+   * @example
+   * ```ts
+   * const response = await client.dns.records.scanReview({
+   *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   * });
+   * ```
+   */
+  scanReview(
+    params: RecordScanReviewParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<RecordScanReviewResponse> {
+    const { zone_id, ...body } = params;
+    return (
+      this._client.post(`/zones/${zone_id}/dns_records/scan/review`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: RecordScanReviewResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Initiates an asynchronous scan for common DNS records on your domain. Note that
+   * this **does not** automatically add records to your zone. The scan runs in the
+   * background, and results can be reviewed later using the `/scan/review`
+   * endpoints. Useful if you haven't updated your nameservers yet.
+   *
+   * @example
+   * ```ts
+   * const response = await client.dns.records.scanTrigger({
+   *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   * });
+   * ```
+   */
+  scanTrigger(
+    params: RecordScanTriggerParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<RecordScanTriggerResponse> {
+    const { zone_id } = params;
+    return this._client.post(`/zones/${zone_id}/dns_records/scan/trigger`, options);
+  }
 }
 
 export class RecordResponsesV4PagePaginationArray extends V4PagePaginationArray<RecordResponse> {}
 
+export class RecordResponsesSinglePage extends SinglePage<RecordResponse> {}
+
 export interface ARecord {
   /**
    * Complete DNS record name, including the zone name, in Punycode.
@@ -3631,30 +3701,30 @@ export namespace Record {
 }
 
 export type RecordResponse =
-  | RecordResponse.ARecord
-  | RecordResponse.AAAARecord
-  | RecordResponse.CNAMERecord
-  | RecordResponse.MXRecord
-  | RecordResponse.NSRecord
-  | RecordResponse.OpenpgpkeyRecord
-  | RecordResponse.PTRRecord
-  | RecordResponse.TXTRecord
-  | RecordResponse.CAARecord
-  | RecordResponse.CERTRecord
-  | RecordResponse.DNSKEYRecord
-  | RecordResponse.DSRecord
-  | RecordResponse.HTTPSRecord
-  | RecordResponse.LOCRecord
-  | RecordResponse.NAPTRRecord
-  | RecordResponse.SMIMEARecord
-  | RecordResponse.SRVRecord
-  | RecordResponse.SSHFPRecord
-  | RecordResponse.SVCBRecord
-  | RecordResponse.TLSARecord
-  | RecordResponse.URIRecord;
+  | RecordResponse.A
+  | RecordResponse.AAAA
+  | RecordResponse.CNAME
+  | RecordResponse.MX
+  | RecordResponse.NS
+  | RecordResponse.Openpgpkey
+  | RecordResponse.PTR
+  | RecordResponse.TXT
+  | RecordResponse.CAA
+  | RecordResponse.CERT
+  | RecordResponse.DNSKEY
+  | RecordResponse.DS
+  | RecordResponse.HTTPS
+  | RecordResponse.LOC
+  | RecordResponse.NAPTR
+  | RecordResponse.SMIMEA
+  | RecordResponse.SRV
+  | RecordResponse.SSHFP
+  | RecordResponse.SVCB
+  | RecordResponse.TLSA
+  | RecordResponse.URI;
 
 export namespace RecordResponse {
-  export interface ARecord extends RecordsAPI.ARecord {
+  export interface A extends RecordsAPI.ARecord {
     /**
      * Identifier.
      */
@@ -3691,7 +3761,7 @@ export namespace RecordResponse {
     tags_modified_on?: string;
   }
 
-  export interface AAAARecord extends RecordsAPI.AAAARecord {
+  export interface AAAA extends RecordsAPI.AAAARecord {
     /**
      * Identifier.
      */
@@ -3728,7 +3798,7 @@ export namespace RecordResponse {
     tags_modified_on?: string;
   }
 
-  export interface CNAMERecord extends RecordsAPI.CNAMERecord {
+  export interface CNAME extends RecordsAPI.CNAMERecord {
     /**
      * Identifier.
      */
@@ -3765,7 +3835,7 @@ export namespace RecordResponse {
     tags_modified_on?: string;
   }
 
-  export interface MXRecord extends RecordsAPI.MXRecord {
+  export interface MX extends RecordsAPI.MXRecord {
     /**
      * Identifier.
      */
@@ -3802,7 +3872,7 @@ export namespace RecordResponse {
     tags_modified_on?: string;
   }
 
-  export interface NSRecord extends RecordsAPI.NSRecord {
+  export interface NS extends RecordsAPI.NSRecord {
     /**
      * Identifier.
      */
@@ -3839,7 +3909,7 @@ export namespace RecordResponse {
     tags_modified_on?: string;
   }
 
-  export interface OpenpgpkeyRecord {
+  export interface Openpgpkey {
     /**
      * Identifier.
      */
@@ -3890,7 +3960,7 @@ export namespace RecordResponse {
     /**
      * Settings for the DNS record.
      */
-    settings: OpenpgpkeyRecord.Settings;
+    settings: Openpgpkey.Settings;
 
     /**
      * Custom tags for the DNS record. This field has no effect on DNS responses.
@@ -3920,7 +3990,7 @@ export namespace RecordResponse {
     tags_modified_on?: string;
   }
 
-  export namespace OpenpgpkeyRecord {
+  export namespace Openpgpkey {
     /**
      * Settings for the DNS record.
      */
@@ -3943,7 +4013,7 @@ export namespace RecordResponse {
     }
   }
 
-  export interface PTRRecord extends RecordsAPI.PTRRecord {
+  export interface PTR extends RecordsAPI.PTRRecord {
     /**
      * Identifier.
      */
@@ -3980,7 +4050,7 @@ export namespace RecordResponse {
     tags_modified_on?: string;
   }
 
-  export interface TXTRecord extends RecordsAPI.TXTRecord {
+  export interface TXT extends RecordsAPI.TXTRecord {
     /**
      * Identifier.
      */
@@ -4017,7 +4087,7 @@ export namespace RecordResponse {
     tags_modified_on?: string;
   }
 
-  export interface CAARecord extends RecordsAPI.CAARecord {
+  export interface CAA extends RecordsAPI.CAARecord {
     /**
      * Identifier.
      */
@@ -4054,7 +4124,7 @@ export namespace RecordResponse {
     tags_modified_on?: string;
   }
 
-  export interface CERTRecord extends RecordsAPI.CERTRecord {
+  export interface CERT extends RecordsAPI.CERTRecord {
     /**
      * Identifier.
      */
@@ -4091,7 +4161,7 @@ export namespace RecordResponse {
     tags_modified_on?: string;
   }
 
-  export interface DNSKEYRecord extends RecordsAPI.DNSKEYRecord {
+  export interface DNSKEY extends RecordsAPI.DNSKEYRecord {
     /**
      * Identifier.
      */
@@ -4128,7 +4198,7 @@ export namespace RecordResponse {
     tags_modified_on?: string;
   }
 
-  export interface DSRecord extends RecordsAPI.DSRecord {
+  export interface DS extends RecordsAPI.DSRecord {
     /**
      * Identifier.
      */
@@ -4165,7 +4235,7 @@ export namespace RecordResponse {
     tags_modified_on?: string;
   }
 
-  export interface HTTPSRecord extends RecordsAPI.HTTPSRecord {
+  export interface HTTPS extends RecordsAPI.HTTPSRecord {
     /**
      * Identifier.
      */
@@ -4202,7 +4272,7 @@ export namespace RecordResponse {
     tags_modified_on?: string;
   }
 
-  export interface LOCRecord extends RecordsAPI.LOCRecord {
+  export interface LOC extends RecordsAPI.LOCRecord {
     /**
      * Identifier.
      */
@@ -4239,7 +4309,7 @@ export namespace RecordResponse {
     tags_modified_on?: string;
   }
 
-  export interface NAPTRRecord extends RecordsAPI.NAPTRRecord {
+  export interface NAPTR extends RecordsAPI.NAPTRRecord {
     /**
      * Identifier.
      */
@@ -4276,7 +4346,7 @@ export namespace RecordResponse {
     tags_modified_on?: string;
   }
 
-  export interface SMIMEARecord extends RecordsAPI.SMIMEARecord {
+  export interface SMIMEA extends RecordsAPI.SMIMEARecord {
     /**
      * Identifier.
      */
@@ -4313,7 +4383,7 @@ export namespace RecordResponse {
     tags_modified_on?: string;
   }
 
-  export interface SRVRecord extends RecordsAPI.SRVRecord {
+  export interface SRV extends RecordsAPI.SRVRecord {
     /**
      * Identifier.
      */
@@ -4350,7 +4420,7 @@ export namespace RecordResponse {
     tags_modified_on?: string;
   }
 
-  export interface SSHFPRecord extends RecordsAPI.SSHFPRecord {
+  export interface SSHFP extends RecordsAPI.SSHFPRecord {
     /**
      * Identifier.
      */
@@ -4387,7 +4457,7 @@ export namespace RecordResponse {
     tags_modified_on?: string;
   }
 
-  export interface SVCBRecord extends RecordsAPI.SVCBRecord {
+  export interface SVCB extends RecordsAPI.SVCBRecord {
     /**
      * Identifier.
      */
@@ -4424,7 +4494,7 @@ export namespace RecordResponse {
     tags_modified_on?: string;
   }
 
-  export interface TLSARecord extends RecordsAPI.TLSARecord {
+  export interface TLSA extends RecordsAPI.TLSARecord {
     /**
      * Identifier.
      */
@@ -4461,7 +4531,7 @@ export namespace RecordResponse {
     tags_modified_on?: string;
   }
 
-  export interface URIRecord extends RecordsAPI.URIRecord {
+  export interface URI extends RecordsAPI.URIRecord {
     /**
      * Identifier.
      */
@@ -5852,6 +5922,57 @@ export interface RecordScanResponse {
   total_records_parsed?: number;
 }
 
+export interface RecordScanReviewResponse {
+  accepts?: Array<RecordResponse>;
+
+  rejects?: Array<string>;
+}
+
+export interface RecordScanTriggerResponse {
+  errors: Array<RecordScanTriggerResponse.Error>;
+
+  messages: Array<RecordScanTriggerResponse.Message>;
+
+  /**
+   * Whether the API call was successful.
+   */
+  success: true;
+}
+
+export namespace RecordScanTriggerResponse {
+  export interface Error {
+    code: number;
+
+    message: string;
+
+    documentation_url?: string;
+
+    source?: Error.Source;
+  }
+
+  export namespace Error {
+    export interface Source {
+      pointer?: string;
+    }
+  }
+
+  export interface Message {
+    code: number;
+
+    message: string;
+
+    documentation_url?: string;
+
+    source?: Message.Source;
+  }
+
+  export namespace Message {
+    export interface Source {
+      pointer?: string;
+    }
+  }
+}
+
 export type RecordCreateParams =
   | RecordCreateParams.ARecord
   | RecordCreateParams.AAAARecord
@@ -12166,7 +12287,139 @@ export interface RecordScanParams {
   body: unknown;
 }
 
+export interface RecordScanListParams {
+  /**
+   * Identifier.
+   */
+  zone_id: string;
+}
+
+export interface RecordScanReviewParams {
+  /**
+   * Path param: Identifier.
+   */
+  zone_id: string;
+
+  /**
+   * Body param:
+   */
+  accepts?: Array<
+    | ARecordParam
+    | AAAARecordParam
+    | CNAMERecordParam
+    | MXRecordParam
+    | NSRecordParam
+    | RecordScanReviewParams.DNSRecordsOpenpgpkeyRecord
+    | PTRRecordParam
+    | TXTRecordParam
+    | CAARecordParam
+    | CERTRecordParam
+    | DNSKEYRecordParam
+    | DSRecordParam
+    | HTTPSRecordParam
+    | LOCRecordParam
+    | NAPTRRecordParam
+    | SMIMEARecordParam
+    | SRVRecordParam
+    | SSHFPRecordParam
+    | SVCBRecordParam
+    | TLSARecordParam
+    | URIRecordParam
+  >;
+
+  /**
+   * Body param:
+   */
+  rejects?: Array<RecordScanReviewParams.Reject>;
+}
+
+export namespace RecordScanReviewParams {
+  export interface DNSRecordsOpenpgpkeyRecord {
+    /**
+     * Complete DNS record name, including the zone name, in Punycode.
+     */
+    name: string;
+
+    /**
+     * Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'.
+     * Value must be between 60 and 86400, with the minimum reduced to 30 for
+     * Enterprise zones.
+     */
+    ttl: RecordsAPI.TTLParam;
+
+    /**
+     * Record type.
+     */
+    type: 'OPENPGPKEY';
+
+    /**
+     * Comments or notes about the DNS record. This field has no effect on DNS
+     * responses.
+     */
+    comment?: string;
+
+    /**
+     * A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1)
+     */
+    content?: string;
+
+    /**
+     * Whether the record is receiving the performance and security benefits of
+     * Cloudflare.
+     */
+    proxied?: boolean;
+
+    /**
+     * Settings for the DNS record.
+     */
+    settings?: DNSRecordsOpenpgpkeyRecord.Settings;
+
+    /**
+     * Custom tags for the DNS record. This field has no effect on DNS responses.
+     */
+    tags?: Array<RecordsAPI.RecordTagsParam>;
+  }
+
+  export namespace DNSRecordsOpenpgpkeyRecord {
+    /**
+     * Settings for the DNS record.
+     */
+    export interface Settings {
+      /**
+       * When enabled, only A records will be generated, and AAAA records will not be
+       * created. This setting is intended for exceptional cases. Note that this option
+       * only applies to proxied records and it has no effect on whether Cloudflare
+       * communicates with the origin using IPv4 or IPv6.
+       */
+      ipv4_only?: boolean;
+
+      /**
+       * When enabled, only AAAA records will be generated, and A records will not be
+       * created. This setting is intended for exceptional cases. Note that this option
+       * only applies to proxied records and it has no effect on whether Cloudflare
+       * communicates with the origin using IPv4 or IPv6.
+       */
+      ipv6_only?: boolean;
+    }
+  }
+
+  export interface Reject {
+    /**
+     * Identifier.
+     */
+    id: string;
+  }
+}
+
+export interface RecordScanTriggerParams {
+  /**
+   * Identifier.
+   */
+  zone_id: string;
+}
+
 Records.RecordResponsesV4PagePaginationArray = RecordResponsesV4PagePaginationArray;
+Records.RecordResponsesSinglePage = RecordResponsesSinglePage;
 
 export declare namespace Records {
   export {
@@ -12201,7 +12454,10 @@ export declare namespace Records {
     type RecordExportResponse as RecordExportResponse,
     type RecordImportResponse as RecordImportResponse,
     type RecordScanResponse as RecordScanResponse,
+    type RecordScanReviewResponse as RecordScanReviewResponse,
+    type RecordScanTriggerResponse as RecordScanTriggerResponse,
     RecordResponsesV4PagePaginationArray as RecordResponsesV4PagePaginationArray,
+    RecordResponsesSinglePage as RecordResponsesSinglePage,
     type RecordCreateParams as RecordCreateParams,
     type RecordUpdateParams as RecordUpdateParams,
     type RecordListParams as RecordListParams,
@@ -12212,5 +12468,8 @@ export declare namespace Records {
     type RecordGetParams as RecordGetParams,
     type RecordImportParams as RecordImportParams,
     type RecordScanParams as RecordScanParams,
+    type RecordScanListParams as RecordScanListParams,
+    type RecordScanReviewParams as RecordScanReviewParams,
+    type RecordScanTriggerParams as RecordScanTriggerParams,
   };
 }