cloudflare/resources/speed/availabilities.d.mts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../core/resource.mjs";
import * as SpeedAPI from "./speed.mjs";
import { APIPromise } from "../../core/api-promise.mjs";
import { RequestOptions } from "../../internal/request-options.mjs";
export declare class BaseAvailabilities extends APIResource {
    static readonly _key: readonly ['speed', 'availabilities'];
    /**
     * Retrieves quota for all plans, as well as the current zone quota.
     *
     * @example
     * ```ts
     * const availability = await client.speed.availabilities.list(
     *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
     * );
     * ```
     */
    list(params: AvailabilityListParams, options?: RequestOptions): APIPromise<Availability>;
}
export declare class Availabilities extends BaseAvailabilities {
}
export interface Availability {
    quota?: Availability.Quota;
    regions?: Array<SpeedAPI.LabeledRegion>;
    /**
     * Available regions.
     */
    regionsPerPlan?: Availability.RegionsPerPlan;
}
export declare namespace Availability {
    interface Quota {
        /**
         * Cloudflare plan.
         */
        plan?: string;
        /**
         * The number of tests available per plan.
         */
        quotasPerPlan?: Quota.QuotasPerPlan;
        /**
         * The number of remaining schedules available.
         */
        remainingSchedules?: number;
        /**
         * The number of remaining tests available.
         */
        remainingTests?: number;
        /**
         * The number of schedules available per plan.
         */
        scheduleQuotasPerPlan?: Quota.ScheduleQuotasPerPlan;
    }
    namespace Quota {
        /**
         * The number of tests available per plan.
         */
        interface QuotasPerPlan {
            /**
             * Counts per account plan.
             */
            value?: QuotasPerPlan.Value;
        }
        namespace QuotasPerPlan {
            /**
             * Counts per account plan.
             */
            interface Value {
                business?: number;
                enterprise?: number;
                free?: number;
                pro?: number;
            }
        }
        /**
         * The number of schedules available per plan.
         */
        interface ScheduleQuotasPerPlan {
            /**
             * Counts per account plan.
             */
            value?: ScheduleQuotasPerPlan.Value;
        }
        namespace ScheduleQuotasPerPlan {
            /**
             * Counts per account plan.
             */
            interface Value {
                business?: number;
                enterprise?: number;
                free?: number;
                pro?: number;
            }
        }
    }
    /**
     * Available regions.
     */
    interface RegionsPerPlan {
        business?: Array<SpeedAPI.LabeledRegion>;
        enterprise?: Array<SpeedAPI.LabeledRegion>;
        free?: Array<SpeedAPI.LabeledRegion>;
        pro?: Array<SpeedAPI.LabeledRegion>;
    }
}
export interface AvailabilityListParams {
    /**
     * Identifier.
     */
    zone_id: string;
}
export declare namespace Availabilities {
    export { type Availability as Availability, type AvailabilityListParams as AvailabilityListParams };
}
//# sourceMappingURL=availabilities.d.mts.map