cloudflare 4.3.0 → 4.4.1

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

@@ -109,56 +109,616 @@ export declare class TimeseriesGroups extends APIResource {
     tlsVersion(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupTLSVersionResponse>;
 }
 export interface TimeseriesGroupARCResponse {
-    meta: unknown;
+    /**
+     * Metadata for the results.
+     */
+    meta: TimeseriesGroupARCResponse.Meta;
     serie_0: EmailAPI.RadarEmailSeries;
 }
+export declare namespace TimeseriesGroupARCResponse {
+    /**
+     * Metadata for the results.
+     */
+    interface Meta {
+        /**
+         * Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
+         * Refer to
+         * [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
+         */
+        aggInterval: 'FIFTEEN_MINUTES' | 'ONE_HOUR' | 'ONE_DAY' | 'ONE_WEEK' | 'ONE_MONTH';
+        confidenceInfo: Meta.ConfidenceInfo;
+        dateRange: Array<Meta.DateRange>;
+        /**
+         * Timestamp of the last dataset update.
+         */
+        lastUpdated: string;
+        /**
+         * 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 ConfidenceInfo {
+            annotations: Array<ConfidenceInfo.Annotation>;
+            /**
+             * Provides an indication of how much confidence Cloudflare has in the data.
+             */
+            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;
+                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 TimeseriesGroupDKIMResponse {
-    meta: unknown;
+    /**
+     * Metadata for the results.
+     */
+    meta: TimeseriesGroupDKIMResponse.Meta;
     serie_0: EmailAPI.RadarEmailSeries;
 }
+export declare namespace TimeseriesGroupDKIMResponse {
+    /**
+     * Metadata for the results.
+     */
+    interface Meta {
+        /**
+         * Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
+         * Refer to
+         * [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
+         */
+        aggInterval: 'FIFTEEN_MINUTES' | 'ONE_HOUR' | 'ONE_DAY' | 'ONE_WEEK' | 'ONE_MONTH';
+        confidenceInfo: Meta.ConfidenceInfo;
+        dateRange: Array<Meta.DateRange>;
+        /**
+         * Timestamp of the last dataset update.
+         */
+        lastUpdated: string;
+        /**
+         * 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 ConfidenceInfo {
+            annotations: Array<ConfidenceInfo.Annotation>;
+            /**
+             * Provides an indication of how much confidence Cloudflare has in the data.
+             */
+            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;
+                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 TimeseriesGroupDMARCResponse {
-    meta: unknown;
+    /**
+     * Metadata for the results.
+     */
+    meta: TimeseriesGroupDMARCResponse.Meta;
     serie_0: EmailAPI.RadarEmailSeries;
 }
+export declare namespace TimeseriesGroupDMARCResponse {
+    /**
+     * Metadata for the results.
+     */
+    interface Meta {
+        /**
+         * Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
+         * Refer to
+         * [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
+         */
+        aggInterval: 'FIFTEEN_MINUTES' | 'ONE_HOUR' | 'ONE_DAY' | 'ONE_WEEK' | 'ONE_MONTH';
+        confidenceInfo: Meta.ConfidenceInfo;
+        dateRange: Array<Meta.DateRange>;
+        /**
+         * Timestamp of the last dataset update.
+         */
+        lastUpdated: string;
+        /**
+         * 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 ConfidenceInfo {
+            annotations: Array<ConfidenceInfo.Annotation>;
+            /**
+             * Provides an indication of how much confidence Cloudflare has in the data.
+             */
+            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;
+                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 TimeseriesGroupMaliciousResponse {
-    meta: unknown;
+    /**
+     * Metadata for the results.
+     */
+    meta: TimeseriesGroupMaliciousResponse.Meta;
     serie_0: TimeseriesGroupMaliciousResponse.Serie0;
 }
 export declare namespace TimeseriesGroupMaliciousResponse {
+    /**
+     * Metadata for the results.
+     */
+    interface Meta {
+        /**
+         * Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
+         * Refer to
+         * [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
+         */
+        aggInterval: 'FIFTEEN_MINUTES' | 'ONE_HOUR' | 'ONE_DAY' | 'ONE_WEEK' | 'ONE_MONTH';
+        confidenceInfo: Meta.ConfidenceInfo;
+        dateRange: Array<Meta.DateRange>;
+        /**
+         * Timestamp of the last dataset update.
+         */
+        lastUpdated: string;
+        /**
+         * 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 ConfidenceInfo {
+            annotations: Array<ConfidenceInfo.Annotation>;
+            /**
+             * Provides an indication of how much confidence Cloudflare has in the data.
+             */
+            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;
+                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 Serie0 {
         MALICIOUS: Array<string>;
         NOT_MALICIOUS: Array<string>;
     }
 }
 export interface TimeseriesGroupSpamResponse {
-    meta: unknown;
+    /**
+     * Metadata for the results.
+     */
+    meta: TimeseriesGroupSpamResponse.Meta;
     serie_0: TimeseriesGroupSpamResponse.Serie0;
 }
 export declare namespace TimeseriesGroupSpamResponse {
+    /**
+     * Metadata for the results.
+     */
+    interface Meta {
+        /**
+         * Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
+         * Refer to
+         * [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
+         */
+        aggInterval: 'FIFTEEN_MINUTES' | 'ONE_HOUR' | 'ONE_DAY' | 'ONE_WEEK' | 'ONE_MONTH';
+        confidenceInfo: Meta.ConfidenceInfo;
+        dateRange: Array<Meta.DateRange>;
+        /**
+         * Timestamp of the last dataset update.
+         */
+        lastUpdated: string;
+        /**
+         * 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 ConfidenceInfo {
+            annotations: Array<ConfidenceInfo.Annotation>;
+            /**
+             * Provides an indication of how much confidence Cloudflare has in the data.
+             */
+            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;
+                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 Serie0 {
         NOT_SPAM: Array<string>;
         SPAM: Array<string>;
     }
 }
 export interface TimeseriesGroupSPFResponse {
-    meta: unknown;
+    /**
+     * Metadata for the results.
+     */
+    meta: TimeseriesGroupSPFResponse.Meta;
     serie_0: EmailAPI.RadarEmailSeries;
 }
+export declare namespace TimeseriesGroupSPFResponse {
+    /**
+     * Metadata for the results.
+     */
+    interface Meta {
+        /**
+         * Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
+         * Refer to
+         * [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
+         */
+        aggInterval: 'FIFTEEN_MINUTES' | 'ONE_HOUR' | 'ONE_DAY' | 'ONE_WEEK' | 'ONE_MONTH';
+        confidenceInfo: Meta.ConfidenceInfo;
+        dateRange: Array<Meta.DateRange>;
+        /**
+         * Timestamp of the last dataset update.
+         */
+        lastUpdated: string;
+        /**
+         * 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 ConfidenceInfo {
+            annotations: Array<ConfidenceInfo.Annotation>;
+            /**
+             * Provides an indication of how much confidence Cloudflare has in the data.
+             */
+            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;
+                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 TimeseriesGroupSpoofResponse {
-    meta: unknown;
+    /**
+     * Metadata for the results.
+     */
+    meta: TimeseriesGroupSpoofResponse.Meta;
     serie_0: TimeseriesGroupSpoofResponse.Serie0;
 }
 export declare namespace TimeseriesGroupSpoofResponse {
+    /**
+     * Metadata for the results.
+     */
+    interface Meta {
+        /**
+         * Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
+         * Refer to
+         * [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
+         */
+        aggInterval: 'FIFTEEN_MINUTES' | 'ONE_HOUR' | 'ONE_DAY' | 'ONE_WEEK' | 'ONE_MONTH';
+        confidenceInfo: Meta.ConfidenceInfo;
+        dateRange: Array<Meta.DateRange>;
+        /**
+         * Timestamp of the last dataset update.
+         */
+        lastUpdated: string;
+        /**
+         * 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 ConfidenceInfo {
+            annotations: Array<ConfidenceInfo.Annotation>;
+            /**
+             * Provides an indication of how much confidence Cloudflare has in the data.
+             */
+            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;
+                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 Serie0 {
         NOT_SPOOF: Array<string>;
         SPOOF: Array<string>;
     }
 }
 export interface TimeseriesGroupThreatCategoryResponse {
-    meta: unknown;
+    /**
+     * Metadata for the results.
+     */
+    meta: TimeseriesGroupThreatCategoryResponse.Meta;
     serie_0: TimeseriesGroupThreatCategoryResponse.Serie0;
 }
 export declare namespace TimeseriesGroupThreatCategoryResponse {
+    /**
+     * Metadata for the results.
+     */
+    interface Meta {
+        /**
+         * Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
+         * Refer to
+         * [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
+         */
+        aggInterval: 'FIFTEEN_MINUTES' | 'ONE_HOUR' | 'ONE_DAY' | 'ONE_WEEK' | 'ONE_MONTH';
+        confidenceInfo: Meta.ConfidenceInfo;
+        dateRange: Array<Meta.DateRange>;
+        /**
+         * Timestamp of the last dataset update.
+         */
+        lastUpdated: string;
+        /**
+         * 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 ConfidenceInfo {
+            annotations: Array<ConfidenceInfo.Annotation>;
+            /**
+             * Provides an indication of how much confidence Cloudflare has in the data.
+             */
+            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;
+                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 Serie0 {
         BrandImpersonation: Array<string>;
         CredentialHarvester: Array<string>;
@@ -167,10 +727,79 @@ export declare namespace TimeseriesGroupThreatCategoryResponse {
     }
 }
 export interface TimeseriesGroupTLSVersionResponse {
-    meta: unknown;
+    /**
+     * Metadata for the results.
+     */
+    meta: TimeseriesGroupTLSVersionResponse.Meta;
     serie_0: TimeseriesGroupTLSVersionResponse.Serie0;
 }
 export declare namespace TimeseriesGroupTLSVersionResponse {
+    /**
+     * Metadata for the results.
+     */
+    interface Meta {
+        /**
+         * Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
+         * Refer to
+         * [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
+         */
+        aggInterval: 'FIFTEEN_MINUTES' | 'ONE_HOUR' | 'ONE_DAY' | 'ONE_WEEK' | 'ONE_MONTH';
+        confidenceInfo: Meta.ConfidenceInfo;
+        dateRange: Array<Meta.DateRange>;
+        /**
+         * Timestamp of the last dataset update.
+         */
+        lastUpdated: string;
+        /**
+         * 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 ConfidenceInfo {
+            annotations: Array<ConfidenceInfo.Annotation>;
+            /**
+             * Provides an indication of how much confidence Cloudflare has in the data.
+             */
+            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;
+                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 Serie0 {
         'TLS 1.0': Array<string>;
         'TLS 1.1': Array<string>;