cloudflare
Version:
The official TypeScript library for the Cloudflare API
43 lines • 1.53 kB
text/typescript
import { APIResource } from "../../../core/resource.mjs";
import { PagePromise, SinglePage } from "../../../core/pagination.mjs";
import { RequestOptions } from "../../../internal/request-options.mjs";
export declare class BaseRegions extends APIResource {
static readonly _key: readonly ['addressing', 'regionalHostnames', 'regions'];
/**
* List all Regional Services regions available for use by this account.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const regionListResponse of client.addressing.regionalHostnames.regions.list(
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* )) {
* // ...
* }
* ```
*/
list(params: RegionListParams, options?: RequestOptions): PagePromise<RegionListResponsesSinglePage, RegionListResponse>;
}
export declare class Regions extends BaseRegions {
}
export type RegionListResponsesSinglePage = SinglePage<RegionListResponse>;
export interface RegionListResponse {
/**
* Identifying key for the region
*/
key?: string;
/**
* Human-readable text label for the region
*/
label?: string;
}
export interface RegionListParams {
/**
* Identifier.
*/
account_id: string;
}
export declare namespace Regions {
export { type RegionListResponse as RegionListResponse, type RegionListResponsesSinglePage as RegionListResponsesSinglePage, type RegionListParams as RegionListParams, };
}
//# sourceMappingURL=regions.d.mts.map