cloudflare 2.8.0 → 3.0.0-beta.1

package/src/resources/spectrum/analytics/events/summaries.ts

@@ -0,0 +1,114 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../../../../core";
+import { APIResource } from "../../../../resource";
+import { isRequestOptions } from "../../../../core";
+import * as SummariesAPI from "./summaries";
+
+export class Summaries extends APIResource {
+  /**
+   * Retrieves a list of summarised aggregate metrics over a given time period.
+   */
+  get(
+    zone: string,
+    query?: SummaryGetParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<SummaryGetResponse | null>;
+  get(zone: string, options?: Core.RequestOptions): Core.APIPromise<SummaryGetResponse | null>;
+  get(
+    zone: string,
+    query: SummaryGetParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<SummaryGetResponse | null> {
+    if (isRequestOptions(query)) {
+      return this.get(zone, {}, query);
+    }
+    return (
+      this._client.get(`/zones/${zone}/spectrum/analytics/events/summary`, {
+        query,
+        ...options,
+      }) as Core.APIPromise<{ result: SummaryGetResponse | null }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export type SummaryGetResponse = unknown | string;
+
+export interface SummaryGetParams {
+  /**
+   * Can be used to break down the data by given attributes. Options are:
+   *
+   * | Dimension | Name                          | Example                                                    |
+   * | --------- | ----------------------------- | ---------------------------------------------------------- |
+   * | event     | Connection Event              | connect, progress, disconnect, originError, clientFiltered |
+   * | appID     | Application ID                | 40d67c87c6cd4b889a4fd57805225e85                           |
+   * | coloName  | Colo Name                     | SFO                                                        |
+   * | ipVersion | IP version used by the client | 4, 6.                                                      |
+   */
+  dimensions?: Array<'event' | 'appID' | 'coloName' | 'ipVersion'>;
+
+  /**
+   * Used to filter rows by one or more dimensions. Filters can be combined using OR
+   * and AND boolean logic. AND takes precedence over OR in all the expressions. The
+   * OR operator is defined using a comma (,) or OR keyword surrounded by whitespace.
+   * The AND operator is defined using a semicolon (;) or AND keyword surrounded by
+   * whitespace. Note that the semicolon is a reserved character in URLs (rfc1738)
+   * and needs to be percent-encoded as %3B. Comparison options are:
+   *
+   * | Operator | Name                     | URL Encoded |
+   * | -------- | ------------------------ | ----------- |
+   * | ==       | Equals                   | %3D%3D      |
+   * | !=       | Does not equals          | !%3D        |
+   * | >        | Greater Than             | %3E         |
+   * | <        | Less Than                | %3C         |
+   * | >=       | Greater than or equal to | %3E%3D      |
+   * | <=       | Less than or equal to    | %3C%3D .    |
+   */
+  filters?: string;
+
+  /**
+   * One or more metrics to compute. Options are:
+   *
+   * | Metric         | Name                                | Example | Unit                  |
+   * | -------------- | ----------------------------------- | ------- | --------------------- |
+   * | count          | Count of total events               | 1000    | Count                 |
+   * | bytesIngress   | Sum of ingress bytes                | 1000    | Sum                   |
+   * | bytesEgress    | Sum of egress bytes                 | 1000    | Sum                   |
+   * | durationAvg    | Average connection duration         | 1.0     | Time in milliseconds  |
+   * | durationMedian | Median connection duration          | 1.0     | Time in milliseconds  |
+   * | duration90th   | 90th percentile connection duration | 1.0     | Time in milliseconds  |
+   * | duration99th   | 99th percentile connection duration | 1.0     | Time in milliseconds. |
+   */
+  metrics?: Array<
+    | 'count'
+    | 'bytesIngress'
+    | 'bytesEgress'
+    | 'durationAvg'
+    | 'durationMedian'
+    | 'duration90th'
+    | 'duration99th'
+  >;
+
+  /**
+   * Start of time interval to query, defaults to `until` - 6 hours. Timestamp must
+   * be in RFC3339 format and uses UTC unless otherwise specified.
+   */
+  since?: string;
+
+  /**
+   * The sort order for the result set; sort fields must be included in `metrics` or
+   * `dimensions`.
+   */
+  sort?: Array<unknown>;
+
+  /**
+   * End of time interval to query, defaults to current time. Timestamp must be in
+   * RFC3339 format and uses UTC unless otherwise specified.
+   */
+  until?: string;
+}
+
+export namespace Summaries {
+  export import SummaryGetResponse = SummariesAPI.SummaryGetResponse;
+  export import SummaryGetParams = SummariesAPI.SummaryGetParams;
+}

package/src/resources/spectrum/analytics/index.ts

@@ -0,0 +1,5 @@
+// File generated from our OpenAPI spec by Stainless.
+
+export { Aggregates } from './aggregates/index';
+export { Analytics } from './analytics';
+export { Events } from './events/index';