// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. import { APIResource } from '../../../../../resource'; import { isRequestOptions } from '../../../../../core'; import * as Core from '../../../../../core'; export class Summary extends APIResource { /** * Retrieves the distribution of unique accounts by model over time. */ model(query?: SummaryModelParams, options?: Core.RequestOptions): Core.APIPromise; model(options?: Core.RequestOptions): Core.APIPromise; model( query: SummaryModelParams | Core.RequestOptions = {}, options?: Core.RequestOptions, ): Core.APIPromise { if (isRequestOptions(query)) { return this.model({}, query); } return ( this._client.get('/radar/ai/inference/timeseries_groups/model', { query, ...options, }) as Core.APIPromise<{ result: SummaryModelResponse }> )._thenUnwrap((obj) => obj.result); } /** * Retrieves the distribution of unique accounts by task over time. */ task(query?: SummaryTaskParams, options?: Core.RequestOptions): Core.APIPromise; task(options?: Core.RequestOptions): Core.APIPromise; task( query: SummaryTaskParams | Core.RequestOptions = {}, options?: Core.RequestOptions, ): Core.APIPromise { if (isRequestOptions(query)) { return this.task({}, query); } return ( this._client.get('/radar/ai/inference/timeseries_groups/task', { query, ...options, }) as Core.APIPromise<{ result: SummaryTaskResponse }> )._thenUnwrap((obj) => obj.result); } } export interface SummaryModelResponse { meta: unknown; serie_0: SummaryModelResponse.Serie0; } export namespace SummaryModelResponse { export interface Serie0 { timestamps: Array; [k: string]: Array | undefined; } } export interface SummaryTaskResponse { meta: unknown; serie_0: SummaryTaskResponse.Serie0; } export namespace SummaryTaskResponse { export interface Serie0 { timestamps: Array; [k: string]: Array | undefined; } } export interface SummaryModelParams { /** * Aggregation interval results should be returned in (for example, in 15 minutes * or 1 hour intervals). Refer to * [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). */ aggInterval?: '15m' | '1h' | '1d' | '1w'; /** * End of the date range (inclusive). */ dateEnd?: Array; /** * 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; /** * Start of the date range. */ dateStart?: Array; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Limits the number of objects per group to the top items within the specified * time range. If there are more items than the limit, the response will include * the count of items, with any remaining items grouped together under an "other" * category. */ limitPerGroup?: number; /** * Array of names used to label the series in the response. */ name?: Array; } export interface SummaryTaskParams { /** * Aggregation interval results should be returned in (for example, in 15 minutes * or 1 hour intervals). Refer to * [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). */ aggInterval?: '15m' | '1h' | '1d' | '1w'; /** * End of the date range (inclusive). */ dateEnd?: Array; /** * 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; /** * Start of the date range. */ dateStart?: Array; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Limits the number of objects per group to the top items within the specified * time range. If there are more items than the limit, the response will include * the count of items, with any remaining items grouped together under an "other" * category. */ limitPerGroup?: number; /** * Array of names used to label the series in the response. */ name?: Array; } export declare namespace Summary { export { type SummaryModelResponse as SummaryModelResponse, type SummaryTaskResponse as SummaryTaskResponse, type SummaryModelParams as SummaryModelParams, type SummaryTaskParams as SummaryTaskParams, }; }