cloudflare/src/resources/spectrum/analytics/aggregates/currents.ts

The official TypeScript library for the Cloudflare API

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../../../core/resource';
import { APIPromise } from '../../../../core/api-promise';
import { RequestOptions } from '../../../../internal/request-options';
import { path } from '../../../../internal/utils/path';

export class BaseCurrents extends APIResource {
  static override readonly _key: readonly ['spectrum', 'analytics', 'aggregates', 'currents'] = Object.freeze(
    ['spectrum', 'analytics', 'aggregates', 'currents'] as const,
  );

  /**
   * Retrieves analytics aggregated from the last minute of usage on Spectrum
   * applications underneath a given zone.
   */
  get(params: CurrentGetParams, options?: RequestOptions): APIPromise<CurrentGetResponse> {
    const { zone_id, ...query } = params;
    return (
      this._client.get(path`/zones/${zone_id}/spectrum/analytics/aggregate/current`, {
        query,
        ...options,
      }) as APIPromise<{ result: CurrentGetResponse }>
    )._thenUnwrap((obj) => obj.result);
  }
}
export class Currents extends BaseCurrents {}

export type CurrentGetResponse = Array<CurrentGetResponse.CurrentGetResponseItem>;

export namespace CurrentGetResponse {
  export interface CurrentGetResponseItem {
    /**
     * Application identifier.
     */
    appID: string;

    /**
     * Number of bytes sent.
     */
    bytesEgress: number;

    /**
     * Number of bytes received.
     */
    bytesIngress: number;

    /**
     * Number of connections.
     */
    connections: number;

    /**
     * Average duration of connections.
     */
    durationAvg: number;
  }
}

export interface CurrentGetParams {
  /**
   * Path param: Identifier.
   */
  zone_id: string;

  /**
   * Query param: Comma-delimited list of Spectrum Application Id(s). If provided,
   * the response will be limited to Spectrum Application Id(s) that match.
   */
  appID?: string;

  /**
   * Query param: Co-location identifier.
   */
  colo_name?: string;
}

export declare namespace Currents {
  export { type CurrentGetResponse as CurrentGetResponse, type CurrentGetParams as CurrentGetParams };
}