@yugabytedb/perf-advisor-client 0.0.0-stage → 0.0.1

package/dist/generated/model/customerInfo.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+export interface CustomerInfo {
+    readonly customer_uuid: string;
+}

package/dist/generated/model/customerPagedResp.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { Customer } from './customer';
+import type { Pagination } from './pagination';
+export type CustomerPagedResp = Pagination & {
+    entities: Customer[];
+};

package/dist/generated/model/customerSpec.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { Endpoint } from './endpoint';
+import type { ScrapedMetricsEndpoint } from './scrapedMetricsEndpoint';
+/**
+ * Properties of a customer registration that the caller sets. A `PUT` replaces the whole spec:
+ * an omitted property takes its default, and omitted credentials keep the stored ones.
+ */
+export interface CustomerSpec {
+    /**
+       * The YBA that manages the customer's universes, with `TOKEN` credentials (its API
+       * token). Not set for an external customer.
+       */
+    platform?: Endpoint;
+    metrics: ScrapedMetricsEndpoint;
+    /** Whether Perf Advisor collects data for the customer's universes. */
+    collection_enabled?: boolean;
+    /**
+       * Whether the customer's YBA is in other premises, so its universes are collected by another
+       * Perf Advisor and registered here with `collection_mode: EXTERNAL`.
+       */
+    external?: boolean;
+}

package/dist/generated/model/database.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { DatabaseInfo } from './databaseInfo';
+/**
+ * A YSQL database or YCQL keyspace of the universe.
+ */
+export interface Database {
+    info: DatabaseInfo;
+}

package/dist/generated/model/databaseInfo.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { DatabaseType } from './databaseType';
+export interface DatabaseInfo {
+    readonly name: string;
+    type: DatabaseType;
+}

package/dist/generated/model/databasePagedResp.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { Database } from './database';
+import type { Pagination } from './pagination';
+export type DatabasePagedResp = Pagination & {
+    entities: Database[];
+};

package/dist/generated/model/databaseSchema.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { DatabaseSchemaInfo } from './databaseSchemaInfo';
+/**
+ * A schema in a YSQL database.
+ */
+export interface DatabaseSchema {
+    info: DatabaseSchemaInfo;
+}

package/dist/generated/model/databaseSchemaInfo.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+export interface DatabaseSchemaInfo {
+    readonly name: string;
+}

package/dist/generated/model/databaseSchemaPagedResp.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { DatabaseSchema } from './databaseSchema';
+import type { Pagination } from './pagination';
+export type DatabaseSchemaPagedResp = Pagination & {
+    entities: DatabaseSchema[];
+};

package/dist/generated/model/databaseStats.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { DatabaseStatsInfo } from './databaseStatsInfo';
+/**
+ * Statistics of one database or keyspace over the requested time range.
+ */
+export interface DatabaseStats {
+    info: DatabaseStatsInfo;
+}

package/dist/generated/model/databaseStatsFilter.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { DatabaseType } from './databaseType';
+/**
+ * Which databases' statistics to list.
+ */
+export interface DatabaseStatsFilter {
+    /** Only the database or keyspace with this exact name. */
+    namespace_name?: string;
+    /** Only databases or keyspaces whose name contains this text, ignoring case. */
+    namespace_name_contains?: string;
+    /** Only databases or keyspaces with a statement whose text contains this text, ignoring case, run in the time range. A system database with such a statement is listed too, typed `SYSTEM`, whatever `exclude_system_dbs` says, as long as `types` includes `SQL`. */
+    query?: string;
+    /** Only these types: `SQL` databases, `CQL` keyspaces, or `SYSTEM` (the system databases, listed only when `exclude_system_dbs` is false). All types by default. */
+    types?: DatabaseType[];
+    /** Leave out system databases. */
+    exclude_system_dbs?: boolean;
+}

package/dist/generated/model/databaseStatsInfo.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { CpuStats } from './cpuStats';
+import type { DatabaseType } from './databaseType';
+import type { LoadStats } from './loadStats';
+import type { StorageSize } from './storageSize';
+import type { WaitEventLoad } from './waitEventLoad';
+export interface DatabaseStatsInfo {
+    readonly name: string;
+    type: DatabaseType;
+    load?: LoadStats;
+    cpu?: CpuStats;
+    storage?: StorageSize;
+    /** Number of tables. */
+    readonly total_tables?: number;
+    /** The load broken down by wait event type or wait event. Set when `group_events_by` is. */
+    readonly wait_events?: readonly WaitEventLoad[];
+}

package/dist/generated/model/databaseStatsPagedResp.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { DatabaseStats } from './databaseStats';
+import type { Pagination } from './pagination';
+import type { StatsSummary } from './statsSummary';
+export type DatabaseStatsPagedResp = Pagination & {
+    /** Set when `include_summary` is true. */
+    summary?: StatsSummary;
+    entities: DatabaseStats[];
+};

package/dist/generated/model/databaseStatsSortBy.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+export type DatabaseStatsSortBy = typeof DatabaseStatsSortBy[keyof typeof DatabaseStatsSortBy];
+export declare const DatabaseStatsSortBy: {
+    readonly NAMESPACE_NAME: "NAMESPACE_NAME";
+    readonly CONNECTIONS: "CONNECTIONS";
+    readonly EPS: "EPS";
+    readonly RPS: "RPS";
+    readonly CPU_RATIO: "CPU_RATIO";
+    readonly SIZE: "SIZE";
+    readonly AVG_CGROUP_CPU_RATIO: "AVG_CGROUP_CPU_RATIO";
+    readonly PEAK_CGROUP_CPU_RATIO: "PEAK_CGROUP_CPU_RATIO";
+    readonly CPU_THROTTLED_MS: "CPU_THROTTLED_MS";
+    readonly TOTAL_TABLES: "TOTAL_TABLES";
+};

package/dist/generated/model/databaseType.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+/**
+ * `SQL` - a YSQL database, `CQL` - a YCQL keyspace, `SYSTEM` - YugabyteDB's own system
+ * databases.
+ */
+export type DatabaseType = typeof DatabaseType[keyof typeof DatabaseType];
+export declare const DatabaseType: {
+    readonly SQL: "SQL";
+    readonly CQL: "CQL";
+    readonly SYSTEM: "SYSTEM";
+};

package/dist/generated/model/deleteSupportBundleParams.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+export type DeleteSupportBundleParams = {
+    /**
+     * Also delete the bundle file.
+     */
+    clean_data?: boolean;
+};

package/dist/generated/model/deleteUniverseParams.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+export type DeleteUniverseParams = {
+    /**
+     * Delete the data collected for the universe now. Without it the data is deleted too,
+     * once the retention backoff
+     * (`pa.task.historical_data_gc.universe_removal_backoff`) has passed.
+     */
+    clean_data?: boolean;
+};

package/dist/generated/model/endpoint.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { Credentials } from './credentials';
+/**
+ * Another system Perf Advisor connects to.
+ */
+export interface Endpoint {
+    url: string;
+    credentials?: Credentials;
+}

package/dist/generated/model/error.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { FieldError } from './fieldError';
+/**
+ * Error response, in the RFC 7807 problem details format with Perf Advisor extensions.
+ */
+export interface Error {
+    type?: string;
+    /** Short summary of the error class, for example `Not Found`. */
+    title?: string;
+    /** HTTP status code. */
+    status: number;
+    /** Human-readable explanation of this occurrence. */
+    detail?: string;
+    /** Request path. */
+    instance?: string;
+    /**
+       * Machine-readable error class: `VALIDATION`, `NOT_FOUND`, `FEATURE_DISABLED`,
+       * `STANDBY_READ_ONLY`, `SERVICE_ERROR`, `INTERNAL`, `UNAUTHENTICATED`, `FORBIDDEN`,
+       * `METHOD_NOT_ALLOWED`, `PAYLOAD_TOO_LARGE`, `RATE_LIMITED` or `SERVICE_UNAVAILABLE`. New
+       * values may be added.
+       */
+    code: string;
+    /** Error messages that are not about a single request field. */
+    errors?: string[];
+    /** Error messages about individual request fields. */
+    field_errors?: FieldError[];
+}

package/dist/generated/model/estimateSupportBundleSizeParams.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { SupportBundleMetricFormat } from './supportBundleMetricFormat';
+import type { TimeWindow } from './timeWindow';
+export type EstimateSupportBundleSizeParams = {
+    /**
+     * The time window: `start_time` and `end_time`, each a query parameter of its own. `end_time` defaults to now; each operation documents the default `start_time`.
+     */
+    window?: TimeWindow;
+    /**
+     * Format the metrics would be written in, `PROMQL_JSON` by default.
+     */
+    metric_format?: SupportBundleMetricFormat;
+};

package/dist/generated/model/exportConfig.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { ExportConfigInfo } from './exportConfigInfo';
+import type { ExportConfigSpec } from './exportConfigSpec';
+/**
+ * A destination Perf Advisor exports universe metrics and collected data to.
+ */
+export interface ExportConfig {
+    spec: ExportConfigSpec;
+    info: ExportConfigInfo;
+}

package/dist/generated/model/exportConfigCheck.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+export interface ExportConfigCheck {
+    /** The spec field the check is about, for example `metrics.url`. */
+    readonly field: string;
+    readonly ok: boolean;
+    /** Why the check failed. */
+    readonly message?: string;
+}

package/dist/generated/model/exportConfigInfo.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+export interface ExportConfigInfo {
+    readonly export_config_uuid: string;
+}

package/dist/generated/model/exportConfigMetrics.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { MetricsExportEndpoint } from './metricsExportEndpoint';
+/**
+ * Where universe metrics are exported, and whether Perf Advisor's own metrics go with them.
+ */
+export type ExportConfigMetrics = MetricsExportEndpoint & {
+    /** Whether Perf Advisor's own metrics are exported too. */
+    include_global_pa_metrics?: boolean;
+};

package/dist/generated/model/exportConfigPagedResp.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { ExportConfig } from './exportConfig';
+import type { Pagination } from './pagination';
+export type ExportConfigPagedResp = Pagination & {
+    entities: ExportConfig[];
+};

package/dist/generated/model/exportConfigSpec.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { Endpoint } from './endpoint';
+import type { ExportConfigMetrics } from './exportConfigMetrics';
+import type { YbmProject } from './ybmProject';
+/**
+ * Properties of an export configuration that the caller sets. A `PUT` replaces the whole spec.
+ * A password or key omitted on a `PUT` keeps the stored one, as long as the endpoint and username
+ * it belongs to are unchanged; otherwise it has to be sent again.
+ */
+export interface ExportConfigSpec {
+    /** Unique name. */
+    name: string;
+    metrics: ExportConfigMetrics;
+    /**
+       * Where collected data is sent. Its credentials are `NONE`, `BASIC`, or `CLUSTER_KEY` (with
+       * the key in `token`).
+       */
+    collection: Endpoint;
+    /**
+       * The YBM project the exported data belongs to, sent as the `YBM-Account-ID` and
+       * `YBM-Project-ID` headers.
+       */
+    ybm?: YbmProject;
+}

package/dist/generated/model/exportConfigValidation.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { ExportConfigCheck } from './exportConfigCheck';
+/**
+ * Result of checking an export configuration, including whether its endpoints are reachable.
+ */
+export interface ExportConfigValidation {
+    /** Whether every check passed. */
+    readonly valid: boolean;
+    readonly checks: readonly ExportConfigCheck[];
+}

package/dist/generated/model/exportConfigValidationSpec.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { ExportConfigSpec } from './exportConfigSpec';
+/**
+ * An export configuration to check before saving it.
+ */
+export interface ExportConfigValidationSpec {
+    /**
+       * The stored configuration this one edits. Its passwords are used for an omitted password,
+       * on the same terms as a `PUT`.
+       */
+    export_config_uuid?: string;
+    spec: ExportConfigSpec;
+}

package/dist/generated/model/fieldError.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+export interface FieldError {
+    /** The request field, for example `customer_uuid`. */
+    field: string;
+    messages: string[];
+}

package/dist/generated/model/forbiddenResponse.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { Error } from './error';
+/**
+ * The caller may not perform this operation.
+ */
+export type ForbiddenResponse = Error;

package/dist/generated/model/getAnomalyGroupParams.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { TimeWindow } from './timeWindow';
+export type GetAnomalyGroupParams = {
+    /**
+     * The time window: `start_time` and `end_time`, each a query parameter of its own. `end_time` defaults to now; each operation documents the default `start_time`.
+     */
+    window?: TimeWindow;
+};