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

import { APIResource } from '../../../core/resource';
import * as SpeedAPI from '../speed';
import * as TestsAPI from './tests';
import {
  BaseTests,
  Test,
  TestCreateParams,
  TestDeleteParams,
  TestDeleteResponse,
  TestGetParams,
  TestListParams,
  Tests,
  TestsV4PagePaginationArray,
} from './tests';
import { APIPromise } from '../../../core/api-promise';
import { PagePromise, SinglePage } from '../../../core/pagination';
import { RequestOptions } from '../../../internal/request-options';
import { path } from '../../../internal/utils/path';

export class BasePages extends APIResource {
  static override readonly _key: readonly ['speed', 'pages'] = Object.freeze(['speed', 'pages'] as const);

  /**
   * Lists all webpages which have been tested.
   *
   * @example
   * ```ts
   * // Automatically fetches more pages as needed.
   * for await (const pageListResponse of client.speed.pages.list(
   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
   * )) {
   *   // ...
   * }
   * ```
   */
  list(
    params: PageListParams,
    options?: RequestOptions,
  ): PagePromise<PageListResponsesSinglePage, PageListResponse> {
    const { zone_id } = params;
    return this._client.getAPIList(
      path`/zones/${zone_id}/speed_api/pages`,
      SinglePage<PageListResponse>,
      options,
    );
  }

  /**
   * Lists the core web vital metrics trend over time for a specific page.
   *
   * @example
   * ```ts
   * const trend = await client.speed.pages.trend(
   *   'example.com',
   *   {
   *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
   *     deviceType: 'DESKTOP',
   *     metrics: 'performanceScore,ttfb,fcp,si,lcp,tti,tbt,cls',
   *     region: 'us-central1',
   *     start: '2014-01-01T05:20:00.12345Z',
   *     tz: 'tz',
   *   },
   * );
   * ```
   */
  trend(url: string, params: PageTrendParams, options?: RequestOptions): APIPromise<SpeedAPI.Trend> {
    const { zone_id, ...query } = params;
    return (
      this._client.get(path`/zones/${zone_id}/speed_api/pages/${url}/trend`, {
        query,
        ...options,
      }) as APIPromise<{ result: SpeedAPI.Trend }>
    )._thenUnwrap((obj) => obj.result);
  }
}
export class Pages extends BasePages {
  tests: TestsAPI.Tests = new TestsAPI.Tests(this._client);
}

export type PageListResponsesSinglePage = SinglePage<PageListResponse>;

export interface PageListResponse {
  /**
   * A test region with a label.
   */
  region?: SpeedAPI.LabeledRegion;

  /**
   * The frequency of the test.
   */
  scheduleFrequency?: 'DAILY' | 'WEEKLY';

  tests?: Array<TestsAPI.Test>;

  /**
   * A URL.
   */
  url?: string;
}

export interface PageListParams {
  /**
   * Identifier.
   */
  zone_id: string;
}

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

  /**
   * Query param: The type of device.
   */
  deviceType: 'DESKTOP' | 'MOBILE';

  /**
   * Query param: A comma-separated list of metrics to include in the results.
   */
  metrics: string;

  /**
   * Query param: A test region.
   */
  region:
    | 'asia-east1'
    | 'asia-northeast1'
    | 'asia-northeast2'
    | 'asia-south1'
    | 'asia-southeast1'
    | 'australia-southeast1'
    | 'europe-north1'
    | 'europe-southwest1'
    | 'europe-west1'
    | 'europe-west2'
    | 'europe-west3'
    | 'europe-west4'
    | 'europe-west8'
    | 'europe-west9'
    | 'me-west1'
    | 'southamerica-east1'
    | 'us-central1'
    | 'us-east1'
    | 'us-east4'
    | 'us-south1'
    | 'us-west1';

  /**
   * Query param
   */
  start: string;

  /**
   * Query param: The timezone of the start and end timestamps.
   */
  tz: string;

  /**
   * Query param
   */
  end?: string;
}

Pages.Tests = Tests;
Pages.BaseTests = BaseTests;

export declare namespace Pages {
  export {
    type PageListResponse as PageListResponse,
    type PageListResponsesSinglePage as PageListResponsesSinglePage,
    type PageListParams as PageListParams,
    type PageTrendParams as PageTrendParams,
  };

  export {
    Tests as Tests,
    BaseTests as BaseTests,
    type Test as Test,
    type TestDeleteResponse as TestDeleteResponse,
    type TestsV4PagePaginationArray as TestsV4PagePaginationArray,
    type TestCreateParams as TestCreateParams,
    type TestListParams as TestListParams,
    type TestDeleteParams as TestDeleteParams,
    type TestGetParams as TestGetParams,
  };
}