cloudflare
Version:
The official TypeScript library for the Cloudflare API
456 lines • 14.7 kB
TypeScript
import { APIResource } from "../../../resource.js";
import * as Core from "../../../core.js";
import * as ListsAPI from "./lists.js";
import { CursorPaginationAfter, type CursorPaginationAfterParams } from "../../../pagination.js";
export declare class Items extends APIResource {
/**
* Appends new items to the list.
*
* This operation is asynchronous. To get current the operation status, invoke the
* `Get bulk operation status` endpoint with the returned `operation_id`.
*
* There is a limit of 1 pending bulk operation per account. If an outstanding bulk
* operation is in progress, the request will be rejected.
*
* @example
* ```ts
* const item = await client.rules.lists.items.create(
* '2c0fc9fa937b11eaa1b71c4d701ab86e',
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* body: [{ ip: '10.0.0.1' }],
* },
* );
* ```
*/
create(listId: string, params: ItemCreateParams, options?: Core.RequestOptions): Core.APIPromise<ItemCreateResponse>;
/**
* Removes all existing items from the list and adds the provided items to the
* list.
*
* This operation is asynchronous. To get current the operation status, invoke the
* `Get bulk operation status` endpoint with the returned `operation_id`.
*
* There is a limit of 1 pending bulk operation per account. If an outstanding bulk
* operation is in progress, the request will be rejected.
*
* @example
* ```ts
* const item = await client.rules.lists.items.update(
* '2c0fc9fa937b11eaa1b71c4d701ab86e',
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* body: [{ ip: '10.0.0.1' }],
* },
* );
* ```
*/
update(listId: string, params: ItemUpdateParams, options?: Core.RequestOptions): Core.APIPromise<ItemUpdateResponse>;
/**
* Fetches all the items in the list.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const itemListResponse of client.rules.lists.items.list(
* '2c0fc9fa937b11eaa1b71c4d701ab86e',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* )) {
* // ...
* }
* ```
*/
list(listId: string, params: ItemListParams, options?: Core.RequestOptions): Core.PagePromise<ItemListResponsesCursorPaginationAfter, ItemListResponse>;
/**
* Removes one or more items from a list.
*
* This operation is asynchronous. To get current the operation status, invoke the
* `Get bulk operation status` endpoint with the returned `operation_id`.
*
* There is a limit of 1 pending bulk operation per account. If an outstanding bulk
* operation is in progress, the request will be rejected.
*
* @example
* ```ts
* const item = await client.rules.lists.items.delete(
* '2c0fc9fa937b11eaa1b71c4d701ab86e',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
delete(listId: string, params: ItemDeleteParams, options?: Core.RequestOptions): Core.APIPromise<ItemDeleteResponse>;
/**
* Fetches a list item in the list.
*
* @example
* ```ts
* const item = await client.rules.lists.items.get(
* '2c0fc9fa937b11eaa1b71c4d701ab86e',
* '34b12448945f11eaa1b71c4d701ab86e',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
get(listId: string, itemId: string, params: ItemGetParams, options?: Core.RequestOptions): Core.APIPromise<ItemGetResponse>;
}
export declare class ItemListResponsesCursorPaginationAfter extends CursorPaginationAfter<ItemListResponse> {
}
export interface ListCursor {
after?: string;
before?: string;
}
export interface ListItem {
/**
* The unique operation ID of the asynchronous action.
*/
operation_id: string;
}
export interface ItemCreateResponse {
/**
* The unique operation ID of the asynchronous action.
*/
operation_id: string;
}
export interface ItemUpdateResponse {
/**
* The unique operation ID of the asynchronous action.
*/
operation_id: string;
}
export type ItemListResponse = ItemListResponse.ListsListItemIPFull | ItemListResponse.ListsListItemHostnameFull | ItemListResponse.ListsListItemRedirectFull | ItemListResponse.ListsListItemASNFull;
export declare namespace ItemListResponse {
interface ListsListItemIPFull {
/**
* Defines the unique ID of the item in the List.
*/
id: string;
/**
* The RFC 3339 timestamp of when the list was created.
*/
created_on: string;
/**
* An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
*/
ip: string;
/**
* The RFC 3339 timestamp of when the list was last modified.
*/
modified_on: string;
/**
* Defines an informative summary of the list item.
*/
comment?: string;
}
interface ListsListItemHostnameFull {
/**
* Defines the unique ID of the item in the List.
*/
id: string;
/**
* The RFC 3339 timestamp of when the list was created.
*/
created_on: string;
/**
* Valid characters for hostnames are ASCII(7) letters from a to z, the digits from
* 0 to 9, wildcards (\*), and the hyphen (-).
*/
hostname: ListsAPI.Hostname;
/**
* The RFC 3339 timestamp of when the list was last modified.
*/
modified_on: string;
/**
* Defines an informative summary of the list item.
*/
comment?: string;
}
interface ListsListItemRedirectFull {
/**
* Defines the unique ID of the item in the List.
*/
id: string;
/**
* The RFC 3339 timestamp of when the list was created.
*/
created_on: string;
/**
* The RFC 3339 timestamp of when the list was last modified.
*/
modified_on: string;
/**
* The definition of the redirect.
*/
redirect: ListsAPI.Redirect;
/**
* Defines an informative summary of the list item.
*/
comment?: string;
}
interface ListsListItemASNFull {
/**
* Defines the unique ID of the item in the List.
*/
id: string;
/**
* Defines a non-negative 32 bit integer.
*/
asn: number;
/**
* The RFC 3339 timestamp of when the list was created.
*/
created_on: string;
/**
* The RFC 3339 timestamp of when the list was last modified.
*/
modified_on: string;
/**
* Defines an informative summary of the list item.
*/
comment?: string;
}
}
export interface ItemDeleteResponse {
/**
* The unique operation ID of the asynchronous action.
*/
operation_id: string;
}
export type ItemGetResponse = ItemGetResponse.ListsListItemIPFull | ItemGetResponse.ListsListItemHostnameFull | ItemGetResponse.ListsListItemRedirectFull | ItemGetResponse.ListsListItemASNFull;
export declare namespace ItemGetResponse {
interface ListsListItemIPFull {
/**
* Defines the unique ID of the item in the List.
*/
id: string;
/**
* The RFC 3339 timestamp of when the list was created.
*/
created_on: string;
/**
* An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
*/
ip: string;
/**
* The RFC 3339 timestamp of when the list was last modified.
*/
modified_on: string;
/**
* Defines an informative summary of the list item.
*/
comment?: string;
}
interface ListsListItemHostnameFull {
/**
* Defines the unique ID of the item in the List.
*/
id: string;
/**
* The RFC 3339 timestamp of when the list was created.
*/
created_on: string;
/**
* Valid characters for hostnames are ASCII(7) letters from a to z, the digits from
* 0 to 9, wildcards (\*), and the hyphen (-).
*/
hostname: ListsAPI.Hostname;
/**
* The RFC 3339 timestamp of when the list was last modified.
*/
modified_on: string;
/**
* Defines an informative summary of the list item.
*/
comment?: string;
}
interface ListsListItemRedirectFull {
/**
* Defines the unique ID of the item in the List.
*/
id: string;
/**
* The RFC 3339 timestamp of when the list was created.
*/
created_on: string;
/**
* The RFC 3339 timestamp of when the list was last modified.
*/
modified_on: string;
/**
* The definition of the redirect.
*/
redirect: ListsAPI.Redirect;
/**
* Defines an informative summary of the list item.
*/
comment?: string;
}
interface ListsListItemASNFull {
/**
* Defines the unique ID of the item in the List.
*/
id: string;
/**
* Defines a non-negative 32 bit integer.
*/
asn: number;
/**
* The RFC 3339 timestamp of when the list was created.
*/
created_on: string;
/**
* The RFC 3339 timestamp of when the list was last modified.
*/
modified_on: string;
/**
* Defines an informative summary of the list item.
*/
comment?: string;
}
}
export interface ItemCreateParams {
/**
* Path param: The Account ID for this resource.
*/
account_id: string;
/**
* Body param:
*/
body: Array<ItemCreateParams.ListsListItemIPComment | ItemCreateParams.ListsListItemRedirectComment | ItemCreateParams.ListsListItemHostnameComment | ItemCreateParams.ListsListItemASNComment>;
}
export declare namespace ItemCreateParams {
interface ListsListItemIPComment {
/**
* An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
*/
ip: string;
/**
* Defines an informative summary of the list item.
*/
comment?: string;
}
interface ListsListItemRedirectComment {
/**
* The definition of the redirect.
*/
redirect: ListsAPI.RedirectParam;
/**
* Defines an informative summary of the list item.
*/
comment?: string;
}
interface ListsListItemHostnameComment {
/**
* Valid characters for hostnames are ASCII(7) letters from a to z, the digits from
* 0 to 9, wildcards (\*), and the hyphen (-).
*/
hostname: ListsAPI.HostnameParam;
/**
* Defines an informative summary of the list item.
*/
comment?: string;
}
interface ListsListItemASNComment {
/**
* Defines a non-negative 32 bit integer.
*/
asn: number;
/**
* Defines an informative summary of the list item.
*/
comment?: string;
}
}
export interface ItemUpdateParams {
/**
* Path param: The Account ID for this resource.
*/
account_id: string;
/**
* Body param:
*/
body: Array<ItemUpdateParams.ListsListItemIPComment | ItemUpdateParams.ListsListItemRedirectComment | ItemUpdateParams.ListsListItemHostnameComment | ItemUpdateParams.ListsListItemASNComment>;
}
export declare namespace ItemUpdateParams {
interface ListsListItemIPComment {
/**
* An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
*/
ip: string;
/**
* Defines an informative summary of the list item.
*/
comment?: string;
}
interface ListsListItemRedirectComment {
/**
* The definition of the redirect.
*/
redirect: ListsAPI.RedirectParam;
/**
* Defines an informative summary of the list item.
*/
comment?: string;
}
interface ListsListItemHostnameComment {
/**
* Valid characters for hostnames are ASCII(7) letters from a to z, the digits from
* 0 to 9, wildcards (\*), and the hyphen (-).
*/
hostname: ListsAPI.HostnameParam;
/**
* Defines an informative summary of the list item.
*/
comment?: string;
}
interface ListsListItemASNComment {
/**
* Defines a non-negative 32 bit integer.
*/
asn: number;
/**
* Defines an informative summary of the list item.
*/
comment?: string;
}
}
export interface ItemListParams extends CursorPaginationAfterParams {
/**
* Path param: The Account ID for this resource.
*/
account_id: string;
/**
* Query param: Amount of results to include in each paginated response. A
* non-negative 32 bit integer.
*/
per_page?: number;
/**
* Query param: A search query to filter returned items. Its meaning depends on the
* list type: IP addresses must start with the provided string, hostnames and bulk
* redirects must contain the string, and ASNs must match the string exactly.
*/
search?: string;
}
export interface ItemDeleteParams {
/**
* Path param: The Account ID for this resource.
*/
account_id: string;
/**
* Body param:
*/
items?: Array<ItemDeleteParams.Item>;
}
export declare namespace ItemDeleteParams {
interface Item {
}
}
export interface ItemGetParams {
/**
* The Account ID for this resource.
*/
account_id: string;
}
export declare namespace Items {
export { type ListCursor as ListCursor, type ListItem as ListItem, type ItemCreateResponse as ItemCreateResponse, type ItemUpdateResponse as ItemUpdateResponse, type ItemListResponse as ItemListResponse, type ItemDeleteResponse as ItemDeleteResponse, type ItemGetResponse as ItemGetResponse, ItemListResponsesCursorPaginationAfter as ItemListResponsesCursorPaginationAfter, type ItemCreateParams as ItemCreateParams, type ItemUpdateParams as ItemUpdateParams, type ItemListParams as ItemListParams, type ItemDeleteParams as ItemDeleteParams, type ItemGetParams as ItemGetParams, };
}
//# sourceMappingURL=items.d.ts.map