cloudflare/resources/speed/pages/pages.js

The official TypeScript library for the Cloudflare API

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Pages = exports.BasePages = void 0;
const tslib_1 = require("../../../internal/tslib.js");
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
const resource_1 = require("../../../core/resource.js");
const TestsAPI = tslib_1.__importStar(require("./tests.js"));
const tests_1 = require("./tests.js");
const pagination_1 = require("../../../core/pagination.js");
const path_1 = require("../../../internal/utils/path.js");
var BasePages = /* @__PURE__ */ (() => {
    class BasePages extends resource_1.APIResource {
        /**
         * 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, options) {
            const { zone_id } = params;
            return this._client.getAPIList((0, path_1.path) `/zones/${zone_id}/speed_api/pages`, (pagination_1.SinglePage), 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, params, options) {
            const { zone_id, ...query } = params;
            return this._client.get((0, path_1.path) `/zones/${zone_id}/speed_api/pages/${url}/trend`, {
                query,
                ...options,
            })._thenUnwrap((obj) => obj.result);
        }
    }
    BasePages._key = Object.freeze(['speed', 'pages']);
    return BasePages;
})();
exports.BasePages = BasePages;
var Pages = /* @__PURE__ */ (() => {
    class Pages extends BasePages {
        constructor() {
            super(...arguments);
            this.tests = new TestsAPI.Tests(this._client);
        }
    }
    Pages.Tests = tests_1.Tests;
    Pages.BaseTests = tests_1.BaseTests;
    return Pages;
})();
exports.Pages = Pages;
//# sourceMappingURL=pages.js.map