cloudflare/resources/load-balancers/regions.d.mts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../core/resource.mjs";
import { APIPromise } from "../../core/api-promise.mjs";
import { RequestOptions } from "../../internal/request-options.mjs";
export declare class BaseRegions extends APIResource {
    static readonly _key: readonly ['loadBalancers', 'regions'];
    /**
     * List all region mappings.
     *
     * @example
     * ```ts
     * const regions = await client.loadBalancers.regions.list({
     *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
     * });
     * ```
     */
    list(params: RegionListParams, options?: RequestOptions): APIPromise<RegionListResponse>;
    /**
     * Get a single region mapping.
     *
     * @example
     * ```ts
     * const region = await client.loadBalancers.regions.get(
     *   'WNAM',
     *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
     * );
     * ```
     */
    get(regionID: 'WNAM' | 'ENAM' | 'WEU' | 'EEU' | 'NSAM' | 'SSAM' | 'OC' | 'ME' | 'NAF' | 'SAF' | 'SAS' | 'SEAS' | 'NEAS', params: RegionGetParams, options?: RequestOptions): APIPromise<RegionGetResponse>;
}
export declare class Regions extends BaseRegions {
}
export type RegionListResponse = unknown | string | null;
/**
 * A list of countries and subdivisions mapped to a region.
 */
export type RegionGetResponse = unknown | string | null;
export interface RegionListParams {
    /**
     * Path param: Identifier.
     */
    account_id: string;
    /**
     * Query param: Two-letter alpha-2 country code followed in ISO 3166-1.
     */
    country_code_a2?: string;
    /**
     * Query param: Two-letter subdivision code followed in ISO 3166-2.
     */
    subdivision_code?: string;
    /**
     * Query param: Two-letter subdivision code followed in ISO 3166-2.
     */
    subdivision_code_a2?: string;
}
export interface RegionGetParams {
    /**
     * Identifier.
     */
    account_id: string;
}
export declare namespace Regions {
    export { type RegionListResponse as RegionListResponse, type RegionGetResponse as RegionGetResponse, type RegionListParams as RegionListParams, type RegionGetParams as RegionGetParams, };
}
//# sourceMappingURL=regions.d.mts.map