cloudflare/resources/argo/tiered-caching.js

The official TypeScript library for the Cloudflare API

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.TieredCaching = exports.BaseTieredCaching = void 0;
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
const resource_1 = require("../../core/resource.js");
const path_1 = require("../../internal/utils/path.js");
var BaseTieredCaching = /* @__PURE__ */ (() => {
    class BaseTieredCaching extends resource_1.APIResource {
        /**
         * Tiered Cache works by dividing Cloudflare's data centers into a hierarchy of
         * lower-tiers and upper-tiers. If content is not cached in lower-tier data centers
         * (generally the ones closest to a visitor), the lower-tier must ask an upper-tier
         * to see if it has the content. If the upper-tier does not have the content, only
         * the upper-tier can ask the origin for content. This practice improves bandwidth
         * efficiency by limiting the number of data centers that can ask the origin for
         * content, which reduces origin load and makes websites more cost-effective to
         * operate. Additionally, Tiered Cache concentrates connections to origin servers
         * so they come from a small number of data centers rather than the full set of
         * network locations. This results in fewer open connections using server
         * resources.
         *
         * @example
         * ```ts
         * const response = await client.argo.tieredCaching.edit({
         *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
         *   value: 'on',
         * });
         * ```
         */
        edit(params, options) {
            const { zone_id, ...body } = params;
            return this._client.patch((0, path_1.path) `/zones/${zone_id}/argo/tiered_caching`, { body, ...options })._thenUnwrap((obj) => obj.result);
        }
        /**
         * Tiered Cache works by dividing Cloudflare's data centers into a hierarchy of
         * lower-tiers and upper-tiers. If content is not cached in lower-tier data centers
         * (generally the ones closest to a visitor), the lower-tier must ask an upper-tier
         * to see if it has the content. If the upper-tier does not have the content, only
         * the upper-tier can ask the origin for content. This practice improves bandwidth
         * efficiency by limiting the number of data centers that can ask the origin for
         * content, which reduces origin load and makes websites more cost-effective to
         * operate. Additionally, Tiered Cache concentrates connections to origin servers
         * so they come from a small number of data centers rather than the full set of
         * network locations. This results in fewer open connections using server
         * resources.
         *
         * @example
         * ```ts
         * const tieredCaching = await client.argo.tieredCaching.get({
         *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
         * });
         * ```
         */
        get(params, options) {
            const { zone_id } = params;
            return this._client.get((0, path_1.path) `/zones/${zone_id}/argo/tiered_caching`, options)._thenUnwrap((obj) => obj.result);
        }
    }
    BaseTieredCaching._key = Object.freeze([
        'argo',
        'tieredCaching',
    ]);
    return BaseTieredCaching;
})();
exports.BaseTieredCaching = BaseTieredCaching;
class TieredCaching extends BaseTieredCaching {
}
exports.TieredCaching = TieredCaching;
//# sourceMappingURL=tiered-caching.js.map