cloudflare 5.0.0 → 5.2.0

package/resources/dns/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/dns/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,8CAA8C;AAArC,kGAAA,SAAS,OAAA;AAClB,gCAA4B;AAAnB,0FAAA,GAAG,OAAA;AACZ,sCAOkB;AANhB,wGAAA,cAAc,OAAA;AAOhB,wCA4CmB;AA3CjB,+HAAA,oCAAoC,OAAA;AACpC,kGAAA,OAAO,OAAA;AA2CT,6CAA6D;AAApD,iGAAA,QAAQ,OAAA;AACjB,mDAAuD;AAA9C,sGAAA,aAAa,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/dns/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,8CAA8C;AAArC,kGAAA,SAAS,OAAA;AAClB,gCAA4B;AAAnB,0FAAA,GAAG,OAAA;AACZ,sCAOkB;AANhB,wGAAA,cAAc,OAAA;AAOhB,wCAkDmB;AAjDjB,+HAAA,oCAAoC,OAAA;AACpC,oHAAA,yBAAyB,OAAA;AACzB,kGAAA,OAAO,OAAA;AAgDT,6CAA4C;AAAnC,iGAAA,QAAQ,OAAA;AACjB,mDAAuD;AAA9C,sGAAA,aAAa,OAAA"}

package/resources/dns/index.mjs

@@ -2,7 +2,7 @@
 export { Analytics } from "./analytics/index.mjs";
 export { DNS } from "./dns.mjs";
 export { DNSSECResource, } from "./dnssec.mjs";
-export { RecordResponsesV4PagePaginationArray, Records, } from "./records.mjs";
+export { RecordResponsesV4PagePaginationArray, RecordResponsesSinglePage, Records, } from "./records.mjs";
 export { Settings } from "./settings/index.mjs";
 export { ZoneTransfers } from "./zone-transfers/index.mjs";
 //# sourceMappingURL=index.mjs.map

package/resources/dns/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/dns/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,SAAS,EAAE;OACb,EAAE,GAAG,EAAE;OACP,EACL,cAAc,GAMf;OACM,EACL,oCAAoC,EACpC,OAAO,GA0CR;OACM,EAAE,QAAQ,EAAmB;OAC7B,EAAE,aAAa,EAAE"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/dns/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,SAAS,EAAE;OACb,EAAE,GAAG,EAAE;OACP,EACL,cAAc,GAMf;OACM,EACL,oCAAoC,EACpC,yBAAyB,EACzB,OAAO,GA+CR;OACM,EAAE,QAAQ,EAAE;OACZ,EAAE,aAAa,EAAE"}

package/resources/dns/records.d.ts

@@ -2,7 +2,7 @@ import { APIResource } from "../../resource.js";
 import * as Core from "../../core.js";
 import * as RecordsAPI from "./records.js";
 import * as Shared from "../shared.js";
-import { V4PagePaginationArray, type V4PagePaginationArrayParams } from "../../pagination.js";
+import { SinglePage, V4PagePaginationArray, type V4PagePaginationArrayParams } from "../../pagination.js";
 export declare class Records extends APIResource {
     /**
      * Create a new DNS record for a zone.
@@ -178,18 +178,58 @@ export declare 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.
      *
+     * @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>;
+    /**
+     * 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
-     * const response = await client.dns.records.scan({
+     * // 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>;
+    /**
+     * 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',
-     *   body: {},
      * });
      * ```
      */
-    scan(params: RecordScanParams, options?: Core.RequestOptions): Core.APIPromise<RecordScanResponse>;
+    scanReview(params: RecordScanReviewParams, options?: Core.RequestOptions): Core.APIPromise<RecordScanReviewResponse>;
+    /**
+     * 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>;
 }
 export declare class RecordResponsesV4PagePaginationArray extends V4PagePaginationArray<RecordResponse> {
 }
+export declare class RecordResponsesSinglePage extends SinglePage<RecordResponse> {
+}
 export interface ARecord {
     /**
      * Complete DNS record name, including the zone name, in Punycode.
@@ -4781,6 +4821,42 @@ 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 declare namespace RecordScanTriggerResponse {
+    interface Error {
+        code: number;
+        message: string;
+        documentation_url?: string;
+        source?: Error.Source;
+    }
+    namespace Error {
+        interface Source {
+            pointer?: string;
+        }
+    }
+    interface Message {
+        code: number;
+        message: string;
+        documentation_url?: string;
+        source?: Message.Source;
+    }
+    namespace Message {
+        interface Source {
+            pointer?: string;
+        }
+    }
+}
 export type RecordCreateParams = RecordCreateParams.ARecord | RecordCreateParams.AAAARecord | RecordCreateParams.CNAMERecord | RecordCreateParams.MXRecord | RecordCreateParams.NSRecord | RecordCreateParams.DNSRecordsOpenpgpkeyRecord | RecordCreateParams.PTRRecord | RecordCreateParams.TXTRecord | RecordCreateParams.CAARecord | RecordCreateParams.CERTRecord | RecordCreateParams.DNSKEYRecord | RecordCreateParams.DSRecord | RecordCreateParams.HTTPSRecord | RecordCreateParams.LOCRecord | RecordCreateParams.NAPTRRecord | RecordCreateParams.SMIMEARecord | RecordCreateParams.SRVRecord | RecordCreateParams.SSHFPRecord | RecordCreateParams.SVCBRecord | RecordCreateParams.TLSARecord | RecordCreateParams.URIRecord;
 export declare namespace RecordCreateParams {
     interface ARecord {
@@ -10060,7 +10136,100 @@ 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 declare namespace RecordScanReviewParams {
+    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>;
+    }
+    namespace DNSRecordsOpenpgpkeyRecord {
+        /**
+         * Settings for the DNS record.
+         */
+        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;
+        }
+    }
+    interface Reject {
+        /**
+         * Identifier.
+         */
+        id: string;
+    }
+}
+export interface RecordScanTriggerParams {
+    /**
+     * Identifier.
+     */
+    zone_id: string;
+}
 export declare namespace Records {
-    export { type ARecord as ARecord, type AAAARecord as AAAARecord, type BatchPatch as BatchPatch, type BatchPut as BatchPut, type CAARecord as CAARecord, type CERTRecord as CERTRecord, type CNAMERecord as CNAMERecord, type DNSKEYRecord as DNSKEYRecord, type DSRecord as DSRecord, type HTTPSRecord as HTTPSRecord, type LOCRecord as LOCRecord, type MXRecord as MXRecord, type NAPTRRecord as NAPTRRecord, type NSRecord as NSRecord, type PTRRecord as PTRRecord, type Record as Record, type RecordResponse as RecordResponse, type RecordTags as RecordTags, type SMIMEARecord as SMIMEARecord, type SRVRecord as SRVRecord, type SSHFPRecord as SSHFPRecord, type SVCBRecord as SVCBRecord, type TLSARecord as TLSARecord, type TTL as TTL, type TXTRecord as TXTRecord, type URIRecord as URIRecord, type RecordDeleteResponse as RecordDeleteResponse, type RecordBatchResponse as RecordBatchResponse, type RecordExportResponse as RecordExportResponse, type RecordImportResponse as RecordImportResponse, type RecordScanResponse as RecordScanResponse, RecordResponsesV4PagePaginationArray as RecordResponsesV4PagePaginationArray, type RecordCreateParams as RecordCreateParams, type RecordUpdateParams as RecordUpdateParams, type RecordListParams as RecordListParams, type RecordDeleteParams as RecordDeleteParams, type RecordBatchParams as RecordBatchParams, type RecordEditParams as RecordEditParams, type RecordExportParams as RecordExportParams, type RecordGetParams as RecordGetParams, type RecordImportParams as RecordImportParams, type RecordScanParams as RecordScanParams, };
+    export { type ARecord as ARecord, type AAAARecord as AAAARecord, type BatchPatch as BatchPatch, type BatchPut as BatchPut, type CAARecord as CAARecord, type CERTRecord as CERTRecord, type CNAMERecord as CNAMERecord, type DNSKEYRecord as DNSKEYRecord, type DSRecord as DSRecord, type HTTPSRecord as HTTPSRecord, type LOCRecord as LOCRecord, type MXRecord as MXRecord, type NAPTRRecord as NAPTRRecord, type NSRecord as NSRecord, type PTRRecord as PTRRecord, type Record as Record, type RecordResponse as RecordResponse, type RecordTags as RecordTags, type SMIMEARecord as SMIMEARecord, type SRVRecord as SRVRecord, type SSHFPRecord as SSHFPRecord, type SVCBRecord as SVCBRecord, type TLSARecord as TLSARecord, type TTL as TTL, type TXTRecord as TXTRecord, type URIRecord as URIRecord, type RecordDeleteResponse as RecordDeleteResponse, type RecordBatchResponse as RecordBatchResponse, 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, type RecordDeleteParams as RecordDeleteParams, type RecordBatchParams as RecordBatchParams, type RecordEditParams as RecordEditParams, type RecordExportParams as RecordExportParams, type RecordGetParams as RecordGetParams, type RecordImportParams as RecordImportParams, type RecordScanParams as RecordScanParams, type RecordScanListParams as RecordScanListParams, type RecordScanReviewParams as RecordScanReviewParams, type RecordScanTriggerParams as RecordScanTriggerParams, };
 }
 //# sourceMappingURL=records.d.ts.map