cloudflare
Version:
The official TypeScript library for the Cloudflare API
161 lines • 4.43 kB
text/typescript
import { APIResource } from "../../../../core/resource.mjs";
import { APIPromise } from "../../../../core/api-promise.mjs";
import { RequestOptions } from "../../../../internal/request-options.mjs";
export declare class BaseItems extends APIResource {
static readonly _key: readonly ['DDoSProtection', 'advancedTCPProtection', 'prefixes', 'items'];
/**
* Delete the prefix for an account given a UUID.
*
* @example
* ```ts
* const item =
* await client.DDoSProtection.advancedTCPProtection.prefixes.items.delete(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
delete(prefixID: string, params: ItemDeleteParams, options?: RequestOptions): APIPromise<ItemDeleteResponse>;
/**
* Update a prefix specified by the given UUID.
*
* @example
* ```ts
* const response =
* await client.DDoSProtection.advancedTCPProtection.prefixes.items.edit(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
edit(prefixID: string, params: ItemEditParams, options?: RequestOptions): APIPromise<ItemEditResponse>;
/**
* Get a prefix specified by the given UUID.
*
* @example
* ```ts
* const item =
* await client.DDoSProtection.advancedTCPProtection.prefixes.items.get(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
get(prefixID: string, params: ItemGetParams, options?: RequestOptions): APIPromise<ItemGetResponse>;
}
export declare class Items extends BaseItems {
}
export interface ItemDeleteResponse {
errors: Array<ItemDeleteResponse.Error>;
messages: Array<ItemDeleteResponse.Message>;
/**
* Whether the API call was successful.
*/
success: true;
}
export declare namespace ItemDeleteResponse {
interface Error {
code: number;
message: string;
documentation_url?: string;
source?: Error.Source;
}
namespace Error {
interface Source {
pointer?: string;
}
}
interface Message {
code: number;
message: string;
documentation_url?: string;
source?: Message.Source;
}
namespace Message {
interface Source {
pointer?: string;
}
}
}
export interface ItemEditResponse {
/**
* The unique ID of the prefix.
*/
id: string;
/**
* A comment describing the prefix.
*/
comment: string;
/**
* The creation timestamp of the prefix.
*/
created_on: string;
/**
* Whether to exclude the prefix from protection.
*/
excluded: boolean;
/**
* The last modification timestamp of the prefix.
*/
modified_on: string;
/**
* The prefix in CIDR format.
*/
prefix: string;
}
export interface ItemGetResponse {
/**
* The unique ID of the prefix.
*/
id: string;
/**
* A comment describing the prefix.
*/
comment: string;
/**
* The creation timestamp of the prefix.
*/
created_on: string;
/**
* Whether to exclude the prefix from protection.
*/
excluded: boolean;
/**
* The last modification timestamp of the prefix.
*/
modified_on: string;
/**
* The prefix in CIDR format.
*/
prefix: string;
}
export interface ItemDeleteParams {
/**
* The ID of the account.
*/
account_id: string;
}
export interface ItemEditParams {
/**
* Path param: The ID of the account.
*/
account_id: string;
/**
* Body param: A new comment for the prefix. Optional.
*/
comment?: string;
/**
* Body param: Whether to exclude the prefix from protection. Optional.
*/
excluded?: boolean;
}
export interface ItemGetParams {
/**
* The ID of the account.
*/
account_id: string;
}
export declare namespace Items {
export { type ItemDeleteResponse as ItemDeleteResponse, type ItemEditResponse as ItemEditResponse, type ItemGetResponse as ItemGetResponse, type ItemDeleteParams as ItemDeleteParams, type ItemEditParams as ItemEditParams, type ItemGetParams as ItemGetParams, };
}
//# sourceMappingURL=items.d.mts.map