cloudflare
Version:
The official TypeScript library for the Cloudflare API
120 lines • 3.89 kB
TypeScript
import { APIResource } from "../../../core/resource.js";
import { APIPromise } from "../../../core/api-promise.js";
import { PagePromise, SinglePage } from "../../../core/pagination.js";
import { RequestOptions } from "../../../internal/request-options.js";
export declare class BaseDelegations extends APIResource {
static readonly _key: readonly ['addressing', 'prefixes', 'delegations'];
/**
* Create a new account delegation for a given IP prefix.
*
* @example
* ```ts
* const delegations =
* await client.addressing.prefixes.delegations.create(
* '2af39739cc4e3b5910c918468bb89828',
* {
* account_id: '258def64c72dae45f3e4c8516e2111f2',
* cidr: '192.0.2.0/24',
* delegated_account_id:
* 'b1946ac92492d2347c6235b4d2611184',
* },
* );
* ```
*/
create(prefixID: string, params: DelegationCreateParams, options?: RequestOptions): APIPromise<Delegations>;
/**
* List all delegations for a given account IP prefix.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const delegations of client.addressing.prefixes.delegations.list(
* '2af39739cc4e3b5910c918468bb89828',
* { account_id: '258def64c72dae45f3e4c8516e2111f2' },
* )) {
* // ...
* }
* ```
*/
list(prefixID: string, params: DelegationListParams, options?: RequestOptions): PagePromise<DelegationsSinglePage, Delegations>;
/**
* Delete an account delegation for a given IP prefix.
*
* @example
* ```ts
* const delegation =
* await client.addressing.prefixes.delegations.delete(
* 'd933b1530bc56c9953cf8ce166da8004',
* {
* account_id: '258def64c72dae45f3e4c8516e2111f2',
* prefix_id: '2af39739cc4e3b5910c918468bb89828',
* },
* );
* ```
*/
delete(delegationID: string, params: DelegationDeleteParams, options?: RequestOptions): APIPromise<DelegationDeleteResponse>;
}
export declare class Delegations extends BaseDelegations {
}
export type DelegationsSinglePage = SinglePage<Delegations>;
export interface Delegations {
/**
* Identifier of a Delegation.
*/
id?: string;
/**
* IP Prefix in Classless Inter-Domain Routing format.
*/
cidr?: string;
created_at?: string;
/**
* Account identifier for the account to which prefix is being delegated.
*/
delegated_account_id?: string;
modified_at?: string;
/**
* Identifier of an IP Prefix.
*/
parent_prefix_id?: string;
}
export interface DelegationDeleteResponse {
/**
* Identifier of a Delegation.
*/
id?: string;
}
export interface DelegationCreateParams {
/**
* Path param: Identifier of a Cloudflare account.
*/
account_id: string;
/**
* Body param: IP Prefix in Classless Inter-Domain Routing format.
*/
cidr: string;
/**
* Body param: Account identifier for the account to which prefix is being
* delegated.
*/
delegated_account_id: string;
}
export interface DelegationListParams {
/**
* Identifier of a Cloudflare account.
*/
account_id: string;
}
export interface DelegationDeleteParams {
/**
* Identifier of a Cloudflare account.
*/
account_id: string;
/**
* Identifier of an IP Prefix.
*/
prefix_id: string;
}
export declare namespace Delegations {
export { type Delegations as Delegations, type DelegationDeleteResponse as DelegationDeleteResponse, type DelegationsSinglePage as DelegationsSinglePage, type DelegationCreateParams as DelegationCreateParams, type DelegationListParams as DelegationListParams, type DelegationDeleteParams as DelegationDeleteParams, };
}
//# sourceMappingURL=delegations.d.ts.map