cloudflare 5.1.0 → 5.2.0

package/src/resources/cloudforce-one/threat-events/threat-events.ts

@@ -21,7 +21,7 @@ import {
 import * as CountriesAPI from './countries';
 import { Countries, CountryListParams, CountryListResponse } from './countries';
 import * as CronsAPI from './crons';
-import { CronEditParams, CronEditResponse, CronListParams, CronListResponse, Crons } from './crons';
+import { Crons } from './crons';
 import * as EventTagsAPI from './event-tags';
 import {
   EventTagCreateParams,
@@ -87,6 +87,7 @@ export class ThreatEvents extends APIResource {
    *     category: 'Domain Resolution',
    *     date: '2022-04-01T00:00:00Z',
    *     event: 'An attacker registered the domain domain.com',
+   *     indicatorType: 'domain',
    *     raw: { data: { foo: 'bar' } },
    *     tlp: 'amber',
    *   });
@@ -164,6 +165,7 @@ export class ThreatEvents extends APIResource {
    *         date: '2022-04-01T00:00:00Z',
    *         event:
    *           'An attacker registered the domain domain.com',
+   *         indicatorType: 'domain',
    *         raw: { data: { foo: 'bar' } },
    *         tlp: 'amber',
    *       },
@@ -238,8 +240,12 @@ export interface ThreatEventCreateResponse {
 
   event: string;
 
+  indicator: string;
+
   indicatorType: string;
 
+  indicatorTypeId: number;
+
   killChain: number;
 
   mitreAttack: Array<string>;
@@ -248,6 +254,8 @@ export interface ThreatEventCreateResponse {
 
   numReferences: number;
 
+  rawId: string;
+
   referenced: Array<string>;
 
   referencedIds: Array<number>;
@@ -267,6 +275,8 @@ export interface ThreatEventCreateResponse {
   uuid: string;
 
   insight?: string;
+
+  releasabilityId?: string;
 }
 
 export type ThreatEventListResponse = Array<ThreatEventListResponse.ThreatEventListResponseItem>;
@@ -283,8 +293,12 @@ export namespace ThreatEventListResponse {
 
     event: string;
 
+    indicator: string;
+
     indicatorType: string;
 
+    indicatorTypeId: number;
+
     killChain: number;
 
     mitreAttack: Array<string>;
@@ -293,6 +307,8 @@ export namespace ThreatEventListResponse {
 
     numReferences: number;
 
+    rawId: string;
+
     referenced: Array<string>;
 
     referencedIds: Array<number>;
@@ -312,6 +328,8 @@ export namespace ThreatEventListResponse {
     uuid: string;
 
     insight?: string;
+
+    releasabilityId?: string;
   }
 }
 
@@ -335,8 +353,12 @@ export interface ThreatEventEditResponse {
 
   event: string;
 
+  indicator: string;
+
   indicatorType: string;
 
+  indicatorTypeId: number;
+
   killChain: number;
 
   mitreAttack: Array<string>;
@@ -345,6 +367,8 @@ export interface ThreatEventEditResponse {
 
   numReferences: number;
 
+  rawId: string;
+
   referenced: Array<string>;
 
   referencedIds: Array<number>;
@@ -364,6 +388,8 @@ export interface ThreatEventEditResponse {
   uuid: string;
 
   insight?: string;
+
+  releasabilityId?: string;
 }
 
 export interface ThreatEventGetResponse {
@@ -377,8 +403,12 @@ export interface ThreatEventGetResponse {
 
   event: string;
 
+  indicator: string;
+
   indicatorType: string;
 
+  indicatorTypeId: number;
+
   killChain: number;
 
   mitreAttack: Array<string>;
@@ -387,6 +417,8 @@ export interface ThreatEventGetResponse {
 
   numReferences: number;
 
+  rawId: string;
+
   referenced: Array<string>;
 
   referencedIds: Array<number>;
@@ -406,6 +438,8 @@ export interface ThreatEventGetResponse {
   uuid: string;
 
   insight?: string;
+
+  releasabilityId?: string;
 }
 
 export interface ThreatEventCreateParams {
@@ -429,6 +463,11 @@ export interface ThreatEventCreateParams {
    */
   event: string;
 
+  /**
+   * Body param:
+   */
+  indicatorType: string;
+
   /**
    * Body param:
    */
@@ -467,7 +506,7 @@ export interface ThreatEventCreateParams {
   /**
    * Body param:
    */
-  indicatorType?: string;
+  insight?: string;
 
   /**
    * Body param:
@@ -591,6 +630,8 @@ export namespace ThreatEventBulkCreateParams {
 
     event: string;
 
+    indicatorType: string;
+
     raw: Data.Raw;
 
     tlp: string;
@@ -605,7 +646,7 @@ export namespace ThreatEventBulkCreateParams {
 
     indicator?: string;
 
-    indicatorType?: string;
+    insight?: string;
 
     tags?: Array<string>;
 
@@ -764,13 +805,7 @@ export declare namespace ThreatEvents {
     type CountryListParams as CountryListParams,
   };
 
-  export {
-    Crons as Crons,
-    type CronListResponse as CronListResponse,
-    type CronEditResponse as CronEditResponse,
-    type CronListParams as CronListParams,
-    type CronEditParams as CronEditParams,
-  };
+  export { Crons as Crons };
 
   export {
     Datasets as Datasets,

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.
@@ -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,
   };
 }