cloudflare/src/resources/user/load-balancers/analytics/events.ts

The official TypeScript library for the Cloudflare API

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

import * as Core from "../../../../core";
import { APIResource } from "../../../../resource";
import { isRequestOptions } from "../../../../core";
import * as EventsAPI from "./events";
import { SinglePage } from "../../../../pagination";

export class Events extends APIResource {
  /**
   * List origin health changes.
   */
  list(
    query?: EventListParams,
    options?: Core.RequestOptions,
  ): Core.PagePromise<LoadBalancingAnalyticsSinglePage, LoadBalancingAnalytics>;
  list(
    options?: Core.RequestOptions,
  ): Core.PagePromise<LoadBalancingAnalyticsSinglePage, LoadBalancingAnalytics>;
  list(
    query: EventListParams | Core.RequestOptions = {},
    options?: Core.RequestOptions,
  ): Core.PagePromise<LoadBalancingAnalyticsSinglePage, LoadBalancingAnalytics> {
    if (isRequestOptions(query)) {
      return this.list({}, query);
    }
    return this._client.getAPIList(
      '/user/load_balancing_analytics/events',
      LoadBalancingAnalyticsSinglePage,
      { query, ...options },
    );
  }
}

export class LoadBalancingAnalyticsSinglePage extends SinglePage<LoadBalancingAnalytics> {}

export interface LoadBalancingAnalytics {
  id?: number;

  origins?: Array<unknown>;

  pool?: unknown;

  timestamp?: string;
}

export interface EventListParams {
  /**
   * If true, filter events where the origin status is healthy. If false, filter
   * events where the origin status is unhealthy.
   */
  origin_healthy?: boolean;

  /**
   * The name for the origin to filter.
   */
  origin_name?: string;

  /**
   * If true, filter events where the pool status is healthy. If false, filter events
   * where the pool status is unhealthy.
   */
  pool_healthy?: boolean;

  pool_id?: string;

  /**
   * The name for the pool to filter.
   */
  pool_name?: string;

  /**
   * Start date and time of requesting data period in the ISO8601 format.
   */
  since?: string;

  /**
   * End date and time of requesting data period in the ISO8601 format.
   */
  until?: string;
}

export namespace Events {
  export import LoadBalancingAnalytics = EventsAPI.LoadBalancingAnalytics;
  export import LoadBalancingAnalyticsSinglePage = EventsAPI.LoadBalancingAnalyticsSinglePage;
  export import EventListParams = EventsAPI.EventListParams;
}