cloudflare 4.3.0 → 4.4.1

package/resources/radar/email/security/summary.d.ts

@@ -108,377 +108,689 @@ export declare class Summary extends APIResource {
     tlsVersion(options?: Core.RequestOptions): Core.APIPromise<SummaryTLSVersionResponse>;
 }
 export interface SummaryARCResponse {
+    /**
+     * Metadata for the results.
+     */
     meta: SummaryARCResponse.Meta;
     summary_0: EmailAPI.RadarEmailSummary;
 }
 export declare namespace SummaryARCResponse {
+    /**
+     * Metadata for the results.
+     */
     interface Meta {
+        confidenceInfo: Meta.ConfidenceInfo | null;
         dateRange: Array<Meta.DateRange>;
+        /**
+         * Timestamp of the last dataset update.
+         */
         lastUpdated: string;
-        normalization: string;
-        confidenceInfo?: Meta.ConfidenceInfo;
+        /**
+         * Normalization method applied to the results. Refer to
+         * [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
+         */
+        normalization: 'PERCENTAGE' | 'MIN0_MAX' | 'MIN_MAX' | 'RAW_VALUES' | 'PERCENTAGE_CHANGE' | 'ROLLING_AVERAGE' | 'OVERLAPPED_PERCENTAGE' | 'RATIO';
+        /**
+         * Measurement units for the results.
+         */
+        units: Array<Meta.Unit>;
     }
     namespace Meta {
-        interface DateRange {
-            /**
-             * Adjusted end of date range.
-             */
-            endTime: string;
+        interface ConfidenceInfo {
+            annotations: Array<ConfidenceInfo.Annotation>;
             /**
-             * Adjusted start of date range.
+             * Provides an indication of how much confidence Cloudflare has in the data.
              */
-            startTime: string;
-        }
-        interface ConfidenceInfo {
-            annotations?: Array<ConfidenceInfo.Annotation>;
-            level?: number;
+            level: number;
         }
         namespace ConfidenceInfo {
+            /**
+             * Annotation associated with the result (e.g. outage or other type of event).
+             */
             interface Annotation {
                 dataSource: string;
                 description: string;
+                endDate: string;
                 eventType: string;
+                /**
+                 * Whether event is a single point in time or a time range.
+                 */
                 isInstantaneous: boolean;
-                endTime?: string;
-                linkedUrl?: string;
-                startTime?: string;
+                linkedUrl: string;
+                startDate: string;
             }
         }
+        interface DateRange {
+            /**
+             * Adjusted end of date range.
+             */
+            endTime: string;
+            /**
+             * Adjusted start of date range.
+             */
+            startTime: string;
+        }
+        interface Unit {
+            name: string;
+            value: string;
+        }
     }
 }
 export interface SummaryDKIMResponse {
+    /**
+     * Metadata for the results.
+     */
     meta: SummaryDKIMResponse.Meta;
     summary_0: EmailAPI.RadarEmailSummary;
 }
 export declare namespace SummaryDKIMResponse {
+    /**
+     * Metadata for the results.
+     */
     interface Meta {
+        confidenceInfo: Meta.ConfidenceInfo | null;
         dateRange: Array<Meta.DateRange>;
+        /**
+         * Timestamp of the last dataset update.
+         */
         lastUpdated: string;
-        normalization: string;
-        confidenceInfo?: Meta.ConfidenceInfo;
+        /**
+         * Normalization method applied to the results. Refer to
+         * [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
+         */
+        normalization: 'PERCENTAGE' | 'MIN0_MAX' | 'MIN_MAX' | 'RAW_VALUES' | 'PERCENTAGE_CHANGE' | 'ROLLING_AVERAGE' | 'OVERLAPPED_PERCENTAGE' | 'RATIO';
+        /**
+         * Measurement units for the results.
+         */
+        units: Array<Meta.Unit>;
     }
     namespace Meta {
-        interface DateRange {
-            /**
-             * Adjusted end of date range.
-             */
-            endTime: string;
+        interface ConfidenceInfo {
+            annotations: Array<ConfidenceInfo.Annotation>;
             /**
-             * Adjusted start of date range.
+             * Provides an indication of how much confidence Cloudflare has in the data.
              */
-            startTime: string;
-        }
-        interface ConfidenceInfo {
-            annotations?: Array<ConfidenceInfo.Annotation>;
-            level?: number;
+            level: number;
         }
         namespace ConfidenceInfo {
+            /**
+             * Annotation associated with the result (e.g. outage or other type of event).
+             */
             interface Annotation {
                 dataSource: string;
                 description: string;
+                endDate: string;
                 eventType: string;
+                /**
+                 * Whether event is a single point in time or a time range.
+                 */
                 isInstantaneous: boolean;
-                endTime?: string;
-                linkedUrl?: string;
-                startTime?: string;
+                linkedUrl: string;
+                startDate: string;
             }
         }
+        interface DateRange {
+            /**
+             * Adjusted end of date range.
+             */
+            endTime: string;
+            /**
+             * Adjusted start of date range.
+             */
+            startTime: string;
+        }
+        interface Unit {
+            name: string;
+            value: string;
+        }
     }
 }
 export interface SummaryDMARCResponse {
+    /**
+     * Metadata for the results.
+     */
     meta: SummaryDMARCResponse.Meta;
     summary_0: EmailAPI.RadarEmailSummary;
 }
 export declare namespace SummaryDMARCResponse {
+    /**
+     * Metadata for the results.
+     */
     interface Meta {
+        confidenceInfo: Meta.ConfidenceInfo | null;
         dateRange: Array<Meta.DateRange>;
+        /**
+         * Timestamp of the last dataset update.
+         */
         lastUpdated: string;
-        normalization: string;
-        confidenceInfo?: Meta.ConfidenceInfo;
+        /**
+         * Normalization method applied to the results. Refer to
+         * [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
+         */
+        normalization: 'PERCENTAGE' | 'MIN0_MAX' | 'MIN_MAX' | 'RAW_VALUES' | 'PERCENTAGE_CHANGE' | 'ROLLING_AVERAGE' | 'OVERLAPPED_PERCENTAGE' | 'RATIO';
+        /**
+         * Measurement units for the results.
+         */
+        units: Array<Meta.Unit>;
     }
     namespace Meta {
-        interface DateRange {
-            /**
-             * Adjusted end of date range.
-             */
-            endTime: string;
+        interface ConfidenceInfo {
+            annotations: Array<ConfidenceInfo.Annotation>;
             /**
-             * Adjusted start of date range.
+             * Provides an indication of how much confidence Cloudflare has in the data.
              */
-            startTime: string;
-        }
-        interface ConfidenceInfo {
-            annotations?: Array<ConfidenceInfo.Annotation>;
-            level?: number;
+            level: number;
         }
         namespace ConfidenceInfo {
+            /**
+             * Annotation associated with the result (e.g. outage or other type of event).
+             */
             interface Annotation {
                 dataSource: string;
                 description: string;
+                endDate: string;
                 eventType: string;
+                /**
+                 * Whether event is a single point in time or a time range.
+                 */
                 isInstantaneous: boolean;
-                endTime?: string;
-                linkedUrl?: string;
-                startTime?: string;
+                linkedUrl: string;
+                startDate: string;
             }
         }
+        interface DateRange {
+            /**
+             * Adjusted end of date range.
+             */
+            endTime: string;
+            /**
+             * Adjusted start of date range.
+             */
+            startTime: string;
+        }
+        interface Unit {
+            name: string;
+            value: string;
+        }
     }
 }
 export interface SummaryMaliciousResponse {
+    /**
+     * Metadata for the results.
+     */
     meta: SummaryMaliciousResponse.Meta;
     summary_0: SummaryMaliciousResponse.Summary0;
 }
 export declare namespace SummaryMaliciousResponse {
+    /**
+     * Metadata for the results.
+     */
     interface Meta {
+        confidenceInfo: Meta.ConfidenceInfo | null;
         dateRange: Array<Meta.DateRange>;
+        /**
+         * Timestamp of the last dataset update.
+         */
         lastUpdated: string;
-        normalization: string;
-        confidenceInfo?: Meta.ConfidenceInfo;
+        /**
+         * Normalization method applied to the results. Refer to
+         * [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
+         */
+        normalization: 'PERCENTAGE' | 'MIN0_MAX' | 'MIN_MAX' | 'RAW_VALUES' | 'PERCENTAGE_CHANGE' | 'ROLLING_AVERAGE' | 'OVERLAPPED_PERCENTAGE' | 'RATIO';
+        /**
+         * Measurement units for the results.
+         */
+        units: Array<Meta.Unit>;
     }
     namespace Meta {
-        interface DateRange {
-            /**
-             * Adjusted end of date range.
-             */
-            endTime: string;
+        interface ConfidenceInfo {
+            annotations: Array<ConfidenceInfo.Annotation>;
             /**
-             * Adjusted start of date range.
+             * Provides an indication of how much confidence Cloudflare has in the data.
              */
-            startTime: string;
-        }
-        interface ConfidenceInfo {
-            annotations?: Array<ConfidenceInfo.Annotation>;
-            level?: number;
+            level: number;
         }
         namespace ConfidenceInfo {
+            /**
+             * Annotation associated with the result (e.g. outage or other type of event).
+             */
             interface Annotation {
                 dataSource: string;
                 description: string;
+                endDate: string;
                 eventType: string;
+                /**
+                 * Whether event is a single point in time or a time range.
+                 */
                 isInstantaneous: boolean;
-                endTime?: string;
-                linkedUrl?: string;
-                startTime?: string;
+                linkedUrl: string;
+                startDate: string;
             }
         }
+        interface DateRange {
+            /**
+             * Adjusted end of date range.
+             */
+            endTime: string;
+            /**
+             * Adjusted start of date range.
+             */
+            startTime: string;
+        }
+        interface Unit {
+            name: string;
+            value: string;
+        }
     }
     interface Summary0 {
+        /**
+         * A numeric string.
+         */
         MALICIOUS: string;
+        /**
+         * A numeric string.
+         */
         NOT_MALICIOUS: string;
     }
 }
 export interface SummarySpamResponse {
+    /**
+     * Metadata for the results.
+     */
     meta: SummarySpamResponse.Meta;
     summary_0: SummarySpamResponse.Summary0;
 }
 export declare namespace SummarySpamResponse {
+    /**
+     * Metadata for the results.
+     */
     interface Meta {
+        confidenceInfo: Meta.ConfidenceInfo | null;
         dateRange: Array<Meta.DateRange>;
+        /**
+         * Timestamp of the last dataset update.
+         */
         lastUpdated: string;
-        normalization: string;
-        confidenceInfo?: Meta.ConfidenceInfo;
+        /**
+         * Normalization method applied to the results. Refer to
+         * [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
+         */
+        normalization: 'PERCENTAGE' | 'MIN0_MAX' | 'MIN_MAX' | 'RAW_VALUES' | 'PERCENTAGE_CHANGE' | 'ROLLING_AVERAGE' | 'OVERLAPPED_PERCENTAGE' | 'RATIO';
+        /**
+         * Measurement units for the results.
+         */
+        units: Array<Meta.Unit>;
     }
     namespace Meta {
-        interface DateRange {
-            /**
-             * Adjusted end of date range.
-             */
-            endTime: string;
+        interface ConfidenceInfo {
+            annotations: Array<ConfidenceInfo.Annotation>;
             /**
-             * Adjusted start of date range.
+             * Provides an indication of how much confidence Cloudflare has in the data.
              */
-            startTime: string;
-        }
-        interface ConfidenceInfo {
-            annotations?: Array<ConfidenceInfo.Annotation>;
-            level?: number;
+            level: number;
         }
         namespace ConfidenceInfo {
+            /**
+             * Annotation associated with the result (e.g. outage or other type of event).
+             */
             interface Annotation {
                 dataSource: string;
                 description: string;
+                endDate: string;
                 eventType: string;
+                /**
+                 * Whether event is a single point in time or a time range.
+                 */
                 isInstantaneous: boolean;
-                endTime?: string;
-                linkedUrl?: string;
-                startTime?: string;
+                linkedUrl: string;
+                startDate: string;
             }
         }
+        interface DateRange {
+            /**
+             * Adjusted end of date range.
+             */
+            endTime: string;
+            /**
+             * Adjusted start of date range.
+             */
+            startTime: string;
+        }
+        interface Unit {
+            name: string;
+            value: string;
+        }
     }
     interface Summary0 {
+        /**
+         * A numeric string.
+         */
         NOT_SPAM: string;
+        /**
+         * A numeric string.
+         */
         SPAM: string;
     }
 }
 export interface SummarySPFResponse {
+    /**
+     * Metadata for the results.
+     */
     meta: SummarySPFResponse.Meta;
     summary_0: EmailAPI.RadarEmailSummary;
 }
 export declare namespace SummarySPFResponse {
+    /**
+     * Metadata for the results.
+     */
     interface Meta {
+        confidenceInfo: Meta.ConfidenceInfo | null;
         dateRange: Array<Meta.DateRange>;
+        /**
+         * Timestamp of the last dataset update.
+         */
         lastUpdated: string;
-        normalization: string;
-        confidenceInfo?: Meta.ConfidenceInfo;
+        /**
+         * Normalization method applied to the results. Refer to
+         * [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
+         */
+        normalization: 'PERCENTAGE' | 'MIN0_MAX' | 'MIN_MAX' | 'RAW_VALUES' | 'PERCENTAGE_CHANGE' | 'ROLLING_AVERAGE' | 'OVERLAPPED_PERCENTAGE' | 'RATIO';
+        /**
+         * Measurement units for the results.
+         */
+        units: Array<Meta.Unit>;
     }
     namespace Meta {
-        interface DateRange {
-            /**
-             * Adjusted end of date range.
-             */
-            endTime: string;
+        interface ConfidenceInfo {
+            annotations: Array<ConfidenceInfo.Annotation>;
             /**
-             * Adjusted start of date range.
+             * Provides an indication of how much confidence Cloudflare has in the data.
              */
-            startTime: string;
-        }
-        interface ConfidenceInfo {
-            annotations?: Array<ConfidenceInfo.Annotation>;
-            level?: number;
+            level: number;
         }
         namespace ConfidenceInfo {
+            /**
+             * Annotation associated with the result (e.g. outage or other type of event).
+             */
             interface Annotation {
                 dataSource: string;
                 description: string;
+                endDate: string;
                 eventType: string;
+                /**
+                 * Whether event is a single point in time or a time range.
+                 */
                 isInstantaneous: boolean;
-                endTime?: string;
-                linkedUrl?: string;
-                startTime?: string;
+                linkedUrl: string;
+                startDate: string;
             }
         }
+        interface DateRange {
+            /**
+             * Adjusted end of date range.
+             */
+            endTime: string;
+            /**
+             * Adjusted start of date range.
+             */
+            startTime: string;
+        }
+        interface Unit {
+            name: string;
+            value: string;
+        }
     }
 }
 export interface SummarySpoofResponse {
+    /**
+     * Metadata for the results.
+     */
     meta: SummarySpoofResponse.Meta;
     summary_0: SummarySpoofResponse.Summary0;
 }
 export declare namespace SummarySpoofResponse {
+    /**
+     * Metadata for the results.
+     */
     interface Meta {
+        confidenceInfo: Meta.ConfidenceInfo | null;
         dateRange: Array<Meta.DateRange>;
+        /**
+         * Timestamp of the last dataset update.
+         */
         lastUpdated: string;
-        normalization: string;
-        confidenceInfo?: Meta.ConfidenceInfo;
+        /**
+         * Normalization method applied to the results. Refer to
+         * [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
+         */
+        normalization: 'PERCENTAGE' | 'MIN0_MAX' | 'MIN_MAX' | 'RAW_VALUES' | 'PERCENTAGE_CHANGE' | 'ROLLING_AVERAGE' | 'OVERLAPPED_PERCENTAGE' | 'RATIO';
+        /**
+         * Measurement units for the results.
+         */
+        units: Array<Meta.Unit>;
     }
     namespace Meta {
-        interface DateRange {
-            /**
-             * Adjusted end of date range.
-             */
-            endTime: string;
+        interface ConfidenceInfo {
+            annotations: Array<ConfidenceInfo.Annotation>;
             /**
-             * Adjusted start of date range.
+             * Provides an indication of how much confidence Cloudflare has in the data.
              */
-            startTime: string;
-        }
-        interface ConfidenceInfo {
-            annotations?: Array<ConfidenceInfo.Annotation>;
-            level?: number;
+            level: number;
         }
         namespace ConfidenceInfo {
+            /**
+             * Annotation associated with the result (e.g. outage or other type of event).
+             */
             interface Annotation {
                 dataSource: string;
                 description: string;
+                endDate: string;
                 eventType: string;
+                /**
+                 * Whether event is a single point in time or a time range.
+                 */
                 isInstantaneous: boolean;
-                endTime?: string;
-                linkedUrl?: string;
-                startTime?: string;
+                linkedUrl: string;
+                startDate: string;
             }
         }
+        interface DateRange {
+            /**
+             * Adjusted end of date range.
+             */
+            endTime: string;
+            /**
+             * Adjusted start of date range.
+             */
+            startTime: string;
+        }
+        interface Unit {
+            name: string;
+            value: string;
+        }
     }
     interface Summary0 {
+        /**
+         * A numeric string.
+         */
         NOT_SPOOF: string;
+        /**
+         * A numeric string.
+         */
         SPOOF: string;
     }
 }
 export interface SummaryThreatCategoryResponse {
+    /**
+     * Metadata for the results.
+     */
     meta: SummaryThreatCategoryResponse.Meta;
     summary_0: SummaryThreatCategoryResponse.Summary0;
 }
 export declare namespace SummaryThreatCategoryResponse {
+    /**
+     * Metadata for the results.
+     */
     interface Meta {
+        confidenceInfo: Meta.ConfidenceInfo | null;
         dateRange: Array<Meta.DateRange>;
+        /**
+         * Timestamp of the last dataset update.
+         */
         lastUpdated: string;
-        normalization: string;
-        confidenceInfo?: Meta.ConfidenceInfo;
+        /**
+         * Normalization method applied to the results. Refer to
+         * [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
+         */
+        normalization: 'PERCENTAGE' | 'MIN0_MAX' | 'MIN_MAX' | 'RAW_VALUES' | 'PERCENTAGE_CHANGE' | 'ROLLING_AVERAGE' | 'OVERLAPPED_PERCENTAGE' | 'RATIO';
+        /**
+         * Measurement units for the results.
+         */
+        units: Array<Meta.Unit>;
     }
     namespace Meta {
-        interface DateRange {
-            /**
-             * Adjusted end of date range.
-             */
-            endTime: string;
+        interface ConfidenceInfo {
+            annotations: Array<ConfidenceInfo.Annotation>;
             /**
-             * Adjusted start of date range.
+             * Provides an indication of how much confidence Cloudflare has in the data.
              */
-            startTime: string;
-        }
-        interface ConfidenceInfo {
-            annotations?: Array<ConfidenceInfo.Annotation>;
-            level?: number;
+            level: number;
         }
         namespace ConfidenceInfo {
+            /**
+             * Annotation associated with the result (e.g. outage or other type of event).
+             */
             interface Annotation {
                 dataSource: string;
                 description: string;
+                endDate: string;
                 eventType: string;
+                /**
+                 * Whether event is a single point in time or a time range.
+                 */
                 isInstantaneous: boolean;
-                endTime?: string;
-                linkedUrl?: string;
-                startTime?: string;
+                linkedUrl: string;
+                startDate: string;
             }
         }
+        interface DateRange {
+            /**
+             * Adjusted end of date range.
+             */
+            endTime: string;
+            /**
+             * Adjusted start of date range.
+             */
+            startTime: string;
+        }
+        interface Unit {
+            name: string;
+            value: string;
+        }
     }
     interface Summary0 {
+        /**
+         * A numeric string.
+         */
         BrandImpersonation: string;
+        /**
+         * A numeric string.
+         */
         CredentialHarvester: string;
+        /**
+         * A numeric string.
+         */
         IdentityDeception: string;
+        /**
+         * A numeric string.
+         */
         Link: string;
     }
 }
 export interface SummaryTLSVersionResponse {
+    /**
+     * Metadata for the results.
+     */
     meta: SummaryTLSVersionResponse.Meta;
     summary_0: SummaryTLSVersionResponse.Summary0;
 }
 export declare namespace SummaryTLSVersionResponse {
+    /**
+     * Metadata for the results.
+     */
     interface Meta {
+        confidenceInfo: Meta.ConfidenceInfo | null;
         dateRange: Array<Meta.DateRange>;
+        /**
+         * Timestamp of the last dataset update.
+         */
         lastUpdated: string;
-        normalization: string;
-        confidenceInfo?: Meta.ConfidenceInfo;
+        /**
+         * Normalization method applied to the results. Refer to
+         * [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
+         */
+        normalization: 'PERCENTAGE' | 'MIN0_MAX' | 'MIN_MAX' | 'RAW_VALUES' | 'PERCENTAGE_CHANGE' | 'ROLLING_AVERAGE' | 'OVERLAPPED_PERCENTAGE' | 'RATIO';
+        /**
+         * Measurement units for the results.
+         */
+        units: Array<Meta.Unit>;
     }
     namespace Meta {
-        interface DateRange {
-            /**
-             * Adjusted end of date range.
-             */
-            endTime: string;
+        interface ConfidenceInfo {
+            annotations: Array<ConfidenceInfo.Annotation>;
             /**
-             * Adjusted start of date range.
+             * Provides an indication of how much confidence Cloudflare has in the data.
              */
-            startTime: string;
-        }
-        interface ConfidenceInfo {
-            annotations?: Array<ConfidenceInfo.Annotation>;
-            level?: number;
+            level: number;
         }
         namespace ConfidenceInfo {
+            /**
+             * Annotation associated with the result (e.g. outage or other type of event).
+             */
             interface Annotation {
                 dataSource: string;
                 description: string;
+                endDate: string;
                 eventType: string;
+                /**
+                 * Whether event is a single point in time or a time range.
+                 */
                 isInstantaneous: boolean;
-                endTime?: string;
-                linkedUrl?: string;
-                startTime?: string;
+                linkedUrl: string;
+                startDate: string;
             }
         }
+        interface DateRange {
+            /**
+             * Adjusted end of date range.
+             */
+            endTime: string;
+            /**
+             * Adjusted start of date range.
+             */
+            startTime: string;
+        }
+        interface Unit {
+            name: string;
+            value: string;
+        }
     }
     interface Summary0 {
+        /**
+         * A numeric string.
+         */
         'TLS 1.0': string;
+        /**
+         * A numeric string.
+         */
         'TLS 1.1': string;
+        /**
+         * A numeric string.
+         */
         'TLS 1.2': string;
+        /**
+         * A numeric string.
+         */
         'TLS 1.3': string;
     }
 }