cloudflare/resources/radar/datasets.js

The official TypeScript library for the Cloudflare API

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Datasets = exports.BaseDatasets = void 0;
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
const resource_1 = require("../../core/resource.js");
const headers_1 = require("../../internal/headers.js");
const path_1 = require("../../internal/utils/path.js");
var BaseDatasets = /* @__PURE__ */ (() => {
    class BaseDatasets extends resource_1.APIResource {
        /**
         * Retrieves a list of datasets.
         *
         * @example
         * ```ts
         * const datasets = await client.radar.datasets.list();
         * ```
         */
        list(query = {}, options) {
            return this._client.get('/radar/datasets', { query, ...options })._thenUnwrap((obj) => obj.result);
        }
        /**
         * Retrieves an URL to download a single dataset.
         *
         * @example
         * ```ts
         * const response = await client.radar.datasets.download({
         *   datasetId: 3,
         * });
         * ```
         */
        download(params, options) {
            const { format, ...body } = params;
            return this._client.post('/radar/datasets/download', { query: { format }, body, ...options })._thenUnwrap((obj) => obj.result);
        }
        /**
         * Retrieves the CSV content of a given dataset by alias or ID. When getting the
         * content by alias the latest dataset is returned, optionally filtered by the
         * latest available at a given date.
         *
         * @example
         * ```ts
         * const dataset = await client.radar.datasets.get(
         *   'ranking_top_1000',
         * );
         * ```
         */
        get(alias, options) {
            return this._client.get((0, path_1.path) `/radar/datasets/${alias}`, {
                ...options,
                headers: (0, headers_1.buildHeaders)([{ Accept: 'text/csv' }, options?.headers]),
            });
        }
    }
    BaseDatasets._key = Object.freeze([
        'radar',
        'datasets',
    ]);
    return BaseDatasets;
})();
exports.BaseDatasets = BaseDatasets;
class Datasets extends BaseDatasets {
}
exports.Datasets = Datasets;
//# sourceMappingURL=datasets.js.map