cloudflare 4.1.0 → 4.2.0

package/src/resources/radar/email/security/timeseries-groups.ts

@@ -7,7 +7,8 @@ import * as EmailAPI from '../email';
 
 export class TimeseriesGroups extends APIResource {
   /**
-   * Percentage distribution of emails classified by ARC validation over time.
+   * Retrieves the distribution of emails by ARC (Authenticated Received Chain)
+   * validation over time.
    */
   arc(
     query?: TimeseriesGroupARCParams,
@@ -30,7 +31,8 @@ export class TimeseriesGroups extends APIResource {
   }
 
   /**
-   * Percentage distribution of emails classified by DKIM validation over time.
+   * Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail)
+   * validation over time.
    */
   dkim(
     query?: TimeseriesGroupDKIMParams,
@@ -53,7 +55,8 @@ export class TimeseriesGroups extends APIResource {
   }
 
   /**
-   * Percentage distribution of emails classified by DMARC validation over time.
+   * Retrieves the distribution of emails by DMARC (Domain-based Message
+   * Authentication, Reporting and Conformance) validation over time.
    */
   dmarc(
     query?: TimeseriesGroupDMARCParams,
@@ -76,7 +79,7 @@ export class TimeseriesGroups extends APIResource {
   }
 
   /**
-   * Percentage distribution of emails classified as MALICIOUS over time.
+   * Retrieves the distribution of emails by malicious classification over time.
    */
   malicious(
     query?: TimeseriesGroupMaliciousParams,
@@ -99,7 +102,8 @@ export class TimeseriesGroups extends APIResource {
   }
 
   /**
-   * Percentage distribution of emails classified as SPAM over time.
+   * Retrieves the distribution of emails by spam classification (spam vs. non-spam)
+   * over time.
    */
   spam(
     query?: TimeseriesGroupSpamParams,
@@ -122,7 +126,8 @@ export class TimeseriesGroups extends APIResource {
   }
 
   /**
-   * Percentage distribution of emails classified by SPF validation over time.
+   * Retrieves the distribution of emails by SPF (Sender Policy Framework) validation
+   * over time.
    */
   spf(
     query?: TimeseriesGroupSPFParams,
@@ -145,7 +150,8 @@ export class TimeseriesGroups extends APIResource {
   }
 
   /**
-   * Percentage distribution of emails classified as SPOOF over time.
+   * Retrieves the distribution of emails by spoof classification (spoof vs.
+   * non-spoof) over time.
    */
   spoof(
     query?: TimeseriesGroupSpoofParams,
@@ -168,7 +174,7 @@ export class TimeseriesGroups extends APIResource {
   }
 
   /**
-   * Percentage distribution of emails classified by threat category over time.
+   * Retrieves the distribution of emails by threat category over time.
    */
   threatCategory(
     query?: TimeseriesGroupThreatCategoryParams,
@@ -191,7 +197,7 @@ export class TimeseriesGroups extends APIResource {
   }
 
   /**
-   * Percentage distribution of emails classified by TLS version over time.
+   * Retrieves the distribution of emails by TLS version over time.
    */
   tlsVersion(
     query?: TimeseriesGroupTLSVersionParams,
@@ -330,44 +336,45 @@ export interface TimeseriesGroupARCParams {
   dateEnd?: Array<string>;
 
   /**
-   * For example, use `7d` and `7dControl` to compare this week with the previous
-   * week. Use this parameter or set specific start and end dates (`dateStart` and
-   * `dateEnd` parameters).
+   * Filters results by the specified date range. For example, use `7d` and
+   * `7dcontrol` to compare this week with the previous week. Use this parameter or
+   * set specific start and end dates (`dateStart` and `dateEnd` parameters).
    */
   dateRange?: Array<string>;
 
   /**
-   * Array of datetimes to filter the start of a series.
+   * Start of the date range.
    */
   dateStart?: Array<string>;
 
   /**
-   * Filter for dkim.
+   * Filters results by DKIM (DomainKeys Identified Mail) validation status.
    */
   dkim?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
   /**
-   * Filter for dmarc.
+   * Filters results by DMARC (Domain-based Message Authentication, Reporting and
+   * Conformance) validation status.
    */
   dmarc?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
   /**
-   * Format results are returned in.
+   * Format in which results will be returned.
    */
   format?: 'JSON' | 'CSV';
 
   /**
-   * Array of names that will be used to name the series in responses.
+   * Array of names used to label the series in the response.
    */
   name?: Array<string>;
 
   /**
-   * Filter for spf.
+   * Filters results by SPF (Sender Policy Framework) validation status.
    */
   spf?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
   /**
-   * Filter for tls version.
+   * Filters results by TLS version.
    */
   tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3'>;
 }
@@ -381,7 +388,7 @@ export interface TimeseriesGroupDKIMParams {
   aggInterval?: '15m' | '1h' | '1d' | '1w';
 
   /**
-   * Filter for arc (Authenticated Received Chain).
+   * Filters results by ARC (Authenticated Received Chain) validation.
    */
   arc?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
@@ -391,39 +398,40 @@ export interface TimeseriesGroupDKIMParams {
   dateEnd?: Array<string>;
 
   /**
-   * For example, use `7d` and `7dControl` to compare this week with the previous
-   * week. Use this parameter or set specific start and end dates (`dateStart` and
-   * `dateEnd` parameters).
+   * Filters results by the specified date range. For example, use `7d` and
+   * `7dcontrol` to compare this week with the previous week. Use this parameter or
+   * set specific start and end dates (`dateStart` and `dateEnd` parameters).
    */
   dateRange?: Array<string>;
 
   /**
-   * Array of datetimes to filter the start of a series.
+   * Start of the date range.
    */
   dateStart?: Array<string>;
 
   /**
-   * Filter for dmarc.
+   * Filters results by DMARC (Domain-based Message Authentication, Reporting and
+   * Conformance) validation status.
    */
   dmarc?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
   /**
-   * Format results are returned in.
+   * Format in which results will be returned.
    */
   format?: 'JSON' | 'CSV';
 
   /**
-   * Array of names that will be used to name the series in responses.
+   * Array of names used to label the series in the response.
    */
   name?: Array<string>;
 
   /**
-   * Filter for spf.
+   * Filters results by SPF (Sender Policy Framework) validation status.
    */
   spf?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
   /**
-   * Filter for tls version.
+   * Filters results by TLS version.
    */
   tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3'>;
 }
@@ -437,7 +445,7 @@ export interface TimeseriesGroupDMARCParams {
   aggInterval?: '15m' | '1h' | '1d' | '1w';
 
   /**
-   * Filter for arc (Authenticated Received Chain).
+   * Filters results by ARC (Authenticated Received Chain) validation.
    */
   arc?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
@@ -447,39 +455,39 @@ export interface TimeseriesGroupDMARCParams {
   dateEnd?: Array<string>;
 
   /**
-   * For example, use `7d` and `7dControl` to compare this week with the previous
-   * week. Use this parameter or set specific start and end dates (`dateStart` and
-   * `dateEnd` parameters).
+   * Filters results by the specified date range. For example, use `7d` and
+   * `7dcontrol` to compare this week with the previous week. Use this parameter or
+   * set specific start and end dates (`dateStart` and `dateEnd` parameters).
    */
   dateRange?: Array<string>;
 
   /**
-   * Array of datetimes to filter the start of a series.
+   * Start of the date range.
    */
   dateStart?: Array<string>;
 
   /**
-   * Filter for dkim.
+   * Filters results by DKIM (DomainKeys Identified Mail) validation status.
    */
   dkim?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
   /**
-   * Format results are returned in.
+   * Format in which results will be returned.
    */
   format?: 'JSON' | 'CSV';
 
   /**
-   * Array of names that will be used to name the series in responses.
+   * Array of names used to label the series in the response.
    */
   name?: Array<string>;
 
   /**
-   * Filter for spf.
+   * Filters results by SPF (Sender Policy Framework) validation status.
    */
   spf?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
   /**
-   * Filter for tls version.
+   * Filters results by TLS version.
    */
   tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3'>;
 }
@@ -493,7 +501,7 @@ export interface TimeseriesGroupMaliciousParams {
   aggInterval?: '15m' | '1h' | '1d' | '1w';
 
   /**
-   * Filter for arc (Authenticated Received Chain).
+   * Filters results by ARC (Authenticated Received Chain) validation.
    */
   arc?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
@@ -503,44 +511,45 @@ export interface TimeseriesGroupMaliciousParams {
   dateEnd?: Array<string>;
 
   /**
-   * For example, use `7d` and `7dControl` to compare this week with the previous
-   * week. Use this parameter or set specific start and end dates (`dateStart` and
-   * `dateEnd` parameters).
+   * Filters results by the specified date range. For example, use `7d` and
+   * `7dcontrol` to compare this week with the previous week. Use this parameter or
+   * set specific start and end dates (`dateStart` and `dateEnd` parameters).
    */
   dateRange?: Array<string>;
 
   /**
-   * Array of datetimes to filter the start of a series.
+   * Start of the date range.
    */
   dateStart?: Array<string>;
 
   /**
-   * Filter for dkim.
+   * Filters results by DKIM (DomainKeys Identified Mail) validation status.
    */
   dkim?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
   /**
-   * Filter for dmarc.
+   * Filters results by DMARC (Domain-based Message Authentication, Reporting and
+   * Conformance) validation status.
    */
   dmarc?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
   /**
-   * Format results are returned in.
+   * Format in which results will be returned.
    */
   format?: 'JSON' | 'CSV';
 
   /**
-   * Array of names that will be used to name the series in responses.
+   * Array of names used to label the series in the response.
    */
   name?: Array<string>;
 
   /**
-   * Filter for spf.
+   * Filters results by SPF (Sender Policy Framework) validation status.
    */
   spf?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
   /**
-   * Filter for tls version.
+   * Filters results by TLS version.
    */
   tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3'>;
 }
@@ -554,7 +563,7 @@ export interface TimeseriesGroupSpamParams {
   aggInterval?: '15m' | '1h' | '1d' | '1w';
 
   /**
-   * Filter for arc (Authenticated Received Chain).
+   * Filters results by ARC (Authenticated Received Chain) validation.
    */
   arc?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
@@ -564,44 +573,45 @@ export interface TimeseriesGroupSpamParams {
   dateEnd?: Array<string>;
 
   /**
-   * For example, use `7d` and `7dControl` to compare this week with the previous
-   * week. Use this parameter or set specific start and end dates (`dateStart` and
-   * `dateEnd` parameters).
+   * Filters results by the specified date range. For example, use `7d` and
+   * `7dcontrol` to compare this week with the previous week. Use this parameter or
+   * set specific start and end dates (`dateStart` and `dateEnd` parameters).
    */
   dateRange?: Array<string>;
 
   /**
-   * Array of datetimes to filter the start of a series.
+   * Start of the date range.
    */
   dateStart?: Array<string>;
 
   /**
-   * Filter for dkim.
+   * Filters results by DKIM (DomainKeys Identified Mail) validation status.
    */
   dkim?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
   /**
-   * Filter for dmarc.
+   * Filters results by DMARC (Domain-based Message Authentication, Reporting and
+   * Conformance) validation status.
    */
   dmarc?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
   /**
-   * Format results are returned in.
+   * Format in which results will be returned.
    */
   format?: 'JSON' | 'CSV';
 
   /**
-   * Array of names that will be used to name the series in responses.
+   * Array of names used to label the series in the response.
    */
   name?: Array<string>;
 
   /**
-   * Filter for spf.
+   * Filters results by SPF (Sender Policy Framework) validation status.
    */
   spf?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
   /**
-   * Filter for tls version.
+   * Filters results by TLS version.
    */
   tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3'>;
 }
@@ -615,7 +625,7 @@ export interface TimeseriesGroupSPFParams {
   aggInterval?: '15m' | '1h' | '1d' | '1w';
 
   /**
-   * Filter for arc (Authenticated Received Chain).
+   * Filters results by ARC (Authenticated Received Chain) validation.
    */
   arc?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
@@ -625,39 +635,40 @@ export interface TimeseriesGroupSPFParams {
   dateEnd?: Array<string>;
 
   /**
-   * For example, use `7d` and `7dControl` to compare this week with the previous
-   * week. Use this parameter or set specific start and end dates (`dateStart` and
-   * `dateEnd` parameters).
+   * Filters results by the specified date range. For example, use `7d` and
+   * `7dcontrol` to compare this week with the previous week. Use this parameter or
+   * set specific start and end dates (`dateStart` and `dateEnd` parameters).
    */
   dateRange?: Array<string>;
 
   /**
-   * Array of datetimes to filter the start of a series.
+   * Start of the date range.
    */
   dateStart?: Array<string>;
 
   /**
-   * Filter for dkim.
+   * Filters results by DKIM (DomainKeys Identified Mail) validation status.
    */
   dkim?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
   /**
-   * Filter for dmarc.
+   * Filters results by DMARC (Domain-based Message Authentication, Reporting and
+   * Conformance) validation status.
    */
   dmarc?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
   /**
-   * Format results are returned in.
+   * Format in which results will be returned.
    */
   format?: 'JSON' | 'CSV';
 
   /**
-   * Array of names that will be used to name the series in responses.
+   * Array of names used to label the series in the response.
    */
   name?: Array<string>;
 
   /**
-   * Filter for tls version.
+   * Filters results by TLS version.
    */
   tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3'>;
 }
@@ -671,7 +682,7 @@ export interface TimeseriesGroupSpoofParams {
   aggInterval?: '15m' | '1h' | '1d' | '1w';
 
   /**
-   * Filter for arc (Authenticated Received Chain).
+   * Filters results by ARC (Authenticated Received Chain) validation.
    */
   arc?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
@@ -681,44 +692,45 @@ export interface TimeseriesGroupSpoofParams {
   dateEnd?: Array<string>;
 
   /**
-   * For example, use `7d` and `7dControl` to compare this week with the previous
-   * week. Use this parameter or set specific start and end dates (`dateStart` and
-   * `dateEnd` parameters).
+   * Filters results by the specified date range. For example, use `7d` and
+   * `7dcontrol` to compare this week with the previous week. Use this parameter or
+   * set specific start and end dates (`dateStart` and `dateEnd` parameters).
    */
   dateRange?: Array<string>;
 
   /**
-   * Array of datetimes to filter the start of a series.
+   * Start of the date range.
    */
   dateStart?: Array<string>;
 
   /**
-   * Filter for dkim.
+   * Filters results by DKIM (DomainKeys Identified Mail) validation status.
    */
   dkim?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
   /**
-   * Filter for dmarc.
+   * Filters results by DMARC (Domain-based Message Authentication, Reporting and
+   * Conformance) validation status.
    */
   dmarc?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
   /**
-   * Format results are returned in.
+   * Format in which results will be returned.
    */
   format?: 'JSON' | 'CSV';
 
   /**
-   * Array of names that will be used to name the series in responses.
+   * Array of names used to label the series in the response.
    */
   name?: Array<string>;
 
   /**
-   * Filter for spf.
+   * Filters results by SPF (Sender Policy Framework) validation status.
    */
   spf?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
   /**
-   * Filter for tls version.
+   * Filters results by TLS version.
    */
   tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3'>;
 }
@@ -732,7 +744,7 @@ export interface TimeseriesGroupThreatCategoryParams {
   aggInterval?: '15m' | '1h' | '1d' | '1w';
 
   /**
-   * Filter for arc (Authenticated Received Chain).
+   * Filters results by ARC (Authenticated Received Chain) validation.
    */
   arc?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
@@ -742,44 +754,45 @@ export interface TimeseriesGroupThreatCategoryParams {
   dateEnd?: Array<string>;
 
   /**
-   * For example, use `7d` and `7dControl` to compare this week with the previous
-   * week. Use this parameter or set specific start and end dates (`dateStart` and
-   * `dateEnd` parameters).
+   * Filters results by the specified date range. For example, use `7d` and
+   * `7dcontrol` to compare this week with the previous week. Use this parameter or
+   * set specific start and end dates (`dateStart` and `dateEnd` parameters).
    */
   dateRange?: Array<string>;
 
   /**
-   * Array of datetimes to filter the start of a series.
+   * Start of the date range.
    */
   dateStart?: Array<string>;
 
   /**
-   * Filter for dkim.
+   * Filters results by DKIM (DomainKeys Identified Mail) validation status.
    */
   dkim?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
   /**
-   * Filter for dmarc.
+   * Filters results by DMARC (Domain-based Message Authentication, Reporting and
+   * Conformance) validation status.
    */
   dmarc?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
   /**
-   * Format results are returned in.
+   * Format in which results will be returned.
    */
   format?: 'JSON' | 'CSV';
 
   /**
-   * Array of names that will be used to name the series in responses.
+   * Array of names used to label the series in the response.
    */
   name?: Array<string>;
 
   /**
-   * Filter for spf.
+   * Filters results by SPF (Sender Policy Framework) validation status.
    */
   spf?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
   /**
-   * Filter for tls version.
+   * Filters results by TLS version.
    */
   tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3'>;
 }
@@ -793,7 +806,7 @@ export interface TimeseriesGroupTLSVersionParams {
   aggInterval?: '15m' | '1h' | '1d' | '1w';
 
   /**
-   * Filter for arc (Authenticated Received Chain).
+   * Filters results by ARC (Authenticated Received Chain) validation.
    */
   arc?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
@@ -803,39 +816,40 @@ export interface TimeseriesGroupTLSVersionParams {
   dateEnd?: Array<string>;
 
   /**
-   * For example, use `7d` and `7dControl` to compare this week with the previous
-   * week. Use this parameter or set specific start and end dates (`dateStart` and
-   * `dateEnd` parameters).
+   * Filters results by the specified date range. For example, use `7d` and
+   * `7dcontrol` to compare this week with the previous week. Use this parameter or
+   * set specific start and end dates (`dateStart` and `dateEnd` parameters).
    */
   dateRange?: Array<string>;
 
   /**
-   * Array of datetimes to filter the start of a series.
+   * Start of the date range.
    */
   dateStart?: Array<string>;
 
   /**
-   * Filter for dkim.
+   * Filters results by DKIM (DomainKeys Identified Mail) validation status.
    */
   dkim?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
   /**
-   * Filter for dmarc.
+   * Filters results by DMARC (Domain-based Message Authentication, Reporting and
+   * Conformance) validation status.
    */
   dmarc?: Array<'PASS' | 'NONE' | 'FAIL'>;
 
   /**
-   * Format results are returned in.
+   * Format in which results will be returned.
    */
   format?: 'JSON' | 'CSV';
 
   /**
-   * Array of names that will be used to name the series in responses.
+   * Array of names used to label the series in the response.
    */
   name?: Array<string>;
 
   /**
-   * Filter for spf.
+   * Filters results by SPF (Sender Policy Framework) validation status.
    */
   spf?: Array<'PASS' | 'NONE' | 'FAIL'>;
 }