cloudflare 4.4.0 → 4.5.0

package/src/resources/rules/lists/bulk-operations.ts

@@ -35,54 +35,26 @@ export class BulkOperations extends APIResource {
   }
 }
 
-export type BulkOperationGetResponse =
-  | BulkOperationGetResponse.UnionMember0
-  | BulkOperationGetResponse.UnionMember1;
-
-export namespace BulkOperationGetResponse {
-  export interface UnionMember0 {
-    /**
-     * The unique operation ID of the asynchronous action.
-     */
-    id?: string;
-
-    /**
-     * The RFC 3339 timestamp of when the operation was completed.
-     */
-    completed?: string;
-
-    /**
-     * A message describing the error when the status is `failed`.
-     */
-    error?: string;
-
-    /**
-     * The current status of the asynchronous operation.
-     */
-    status?: 'pending' | 'running' | 'completed' | 'failed';
-  }
-
-  export interface UnionMember1 {
-    /**
-     * The unique operation ID of the asynchronous action.
-     */
-    id?: string;
+export interface BulkOperationGetResponse {
+  /**
+   * The unique operation ID of the asynchronous action.
+   */
+  id: string;
 
-    /**
-     * The RFC 3339 timestamp of when the operation was completed.
-     */
-    completed?: string;
+  /**
+   * The current status of the asynchronous operation.
+   */
+  status: 'pending' | 'running' | 'completed' | 'failed';
 
-    /**
-     * A message describing the error when the status is `failed`.
-     */
-    error?: string;
+  /**
+   * The RFC 3339 timestamp of when the operation was completed.
+   */
+  completed?: string;
 
-    /**
-     * The current status of the asynchronous operation.
-     */
-    status?: 'pending' | 'running' | 'completed' | 'failed';
-  }
+  /**
+   * A message describing the error when the status is `failed`.
+   */
+  error?: string;
 }
 
 export interface BulkOperationGetParams {

package/src/resources/rules/lists/index.ts

@@ -6,6 +6,7 @@ export {
   type BulkOperationGetParams,
 } from './bulk-operations';
 export {
+  ItemListResponsesCursorPagination,
   Items,
   type ListCursor,
   type ListItem,
@@ -21,13 +22,13 @@ export {
   type ItemGetParams,
 } from './items';
 export {
+  ListsListsSinglePage,
   Lists,
   type Hostname,
   type ListsList,
   type Redirect,
   type ListCreateResponse,
   type ListUpdateResponse,
-  type ListListResponse,
   type ListDeleteResponse,
   type ListGetResponse,
   type ListCreateParams,

package/src/resources/rules/lists/items.ts

@@ -3,14 +3,14 @@
 import { APIResource } from '../../../resource';
 import * as Core from '../../../core';
 import * as ListsAPI from './lists';
+import { CursorPagination, type CursorPaginationParams } from '../../../pagination';
 
 export 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](/operations/lists-get-bulk-operation-status)
-   * endpoint with the returned `operation_id`.
+   * `Get bulk operation status` endpoint with the returned `operation_id`.
    *
    * @example
    * ```ts
@@ -42,8 +42,7 @@ export class Items extends APIResource {
    * list.
    *
    * This operation is asynchronous. To get current the operation status, invoke the
-   * [Get bulk operation status](/operations/lists-get-bulk-operation-status)
-   * endpoint with the returned `operation_id`.
+   * `Get bulk operation status` endpoint with the returned `operation_id`.
    *
    * @example
    * ```ts
@@ -75,32 +74,33 @@ export class Items extends APIResource {
    *
    * @example
    * ```ts
-   * const items = await client.rules.lists.items.list(
+   * // 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.APIPromise<ItemListResponse> {
+  ): Core.PagePromise<ItemListResponsesCursorPagination, ItemListResponse> {
     const { account_id, ...query } = params;
-    return (
-      this._client.get(`/accounts/${account_id}/rules/lists/${listId}/items`, {
-        query,
-        ...options,
-      }) as Core.APIPromise<{ result: ItemListResponse }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(
+      `/accounts/${account_id}/rules/lists/${listId}/items`,
+      ItemListResponsesCursorPagination,
+      { query, ...options },
+    );
   }
 
   /**
    * Removes one or more items from a list.
    *
    * This operation is asynchronous. To get current the operation status, invoke the
-   * [Get bulk operation status](/operations/lists-get-bulk-operation-status)
-   * endpoint with the returned `operation_id`.
+   * `Get bulk operation status` endpoint with the returned `operation_id`.
    *
    * @example
    * ```ts
@@ -115,11 +115,12 @@ export class Items extends APIResource {
     params: ItemDeleteParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<ItemDeleteResponse> {
-    const { account_id } = params;
+    const { account_id, ...body } = params;
     return (
-      this._client.delete(`/accounts/${account_id}/rules/lists/${listId}/items`, options) as Core.APIPromise<{
-        result: ItemDeleteResponse;
-      }>
+      this._client.delete(`/accounts/${account_id}/rules/lists/${listId}/items`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: ItemDeleteResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -151,176 +152,126 @@ export class Items extends APIResource {
   }
 }
 
+export class ItemListResponsesCursorPagination extends CursorPagination<ItemListResponse> {}
+
 export interface ListCursor {
   after?: string;
 
   before?: string;
 }
 
-export type ListItem = ListItem.OperationID | ListItem.OperationID;
-
-export namespace ListItem {
-  export interface OperationID {
-    /**
-     * The unique operation ID of the asynchronous action.
-     */
-    operation_id?: string;
-  }
-
-  export interface OperationID {
-    /**
-     * The unique operation ID of the asynchronous action.
-     */
-    operation_id?: string;
-  }
-}
-
-export type ItemCreateResponse = ItemCreateResponse.OperationID | ItemCreateResponse.OperationID;
-
-export namespace ItemCreateResponse {
-  export interface OperationID {
-    /**
-     * The unique operation ID of the asynchronous action.
-     */
-    operation_id?: string;
-  }
-
-  export interface OperationID {
-    /**
-     * The unique operation ID of the asynchronous action.
-     */
-    operation_id?: string;
-  }
+export interface ListItem {
+  /**
+   * The unique operation ID of the asynchronous action.
+   */
+  operation_id?: string;
 }
 
-export type ItemUpdateResponse = ItemUpdateResponse.OperationID | ItemUpdateResponse.OperationID;
-
-export namespace ItemUpdateResponse {
-  export interface OperationID {
-    /**
-     * The unique operation ID of the asynchronous action.
-     */
-    operation_id?: string;
-  }
-
-  export interface OperationID {
-    /**
-     * 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 type ItemListResponse = unknown | Array<unknown>;
-
-export type ItemDeleteResponse = ItemDeleteResponse.OperationID | ItemDeleteResponse.OperationID;
-
-export namespace ItemDeleteResponse {
-  export interface OperationID {
-    /**
-     * The unique operation ID of the asynchronous action.
-     */
-    operation_id?: string;
-  }
-
-  export interface OperationID {
-    /**
-     * 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 ItemGetResponse = ItemGetResponse.UnionMember0 | ItemGetResponse.UnionMember1;
+export interface ItemListResponse {
+  /**
+   * The unique ID of the list.
+   */
+  id?: string;
 
-export namespace ItemGetResponse {
-  export interface UnionMember0 {
-    /**
-     * The unique ID of the list.
-     */
-    id?: string;
+  /**
+   * Defines a non-negative 32 bit integer.
+   */
+  asn?: number;
 
-    /**
-     * Defines a non-negative 32 bit integer.
-     */
-    asn?: number;
+  /**
+   * Defines an informative summary of the list item.
+   */
+  comment?: string;
 
-    /**
-     * Defines an informative summary of the list item.
-     */
-    comment?: string;
+  /**
+   * The RFC 3339 timestamp of when the item was created.
+   */
+  created_on?: string;
 
-    /**
-     * The RFC 3339 timestamp of when the item 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;
 
-    /**
-     * 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;
+  /**
+   * An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
+   */
+  ip?: string;
 
-    /**
-     * An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a
-     * maximum of /64.
-     */
-    ip?: string;
+  /**
+   * The RFC 3339 timestamp of when the item was last modified.
+   */
+  modified_on?: string;
 
-    /**
-     * The RFC 3339 timestamp of when the item was last modified.
-     */
-    modified_on?: string;
+  /**
+   * The definition of the redirect.
+   */
+  redirect?: ListsAPI.Redirect;
+}
 
-    /**
-     * The definition of the redirect.
-     */
-    redirect?: ListsAPI.Redirect;
-  }
+export interface ItemDeleteResponse {
+  /**
+   * The unique operation ID of the asynchronous action.
+   */
+  operation_id?: string;
+}
 
-  export interface UnionMember1 {
-    /**
-     * The unique ID of the list.
-     */
-    id?: string;
+export interface ItemGetResponse {
+  /**
+   * The unique ID of the list.
+   */
+  id?: string;
 
-    /**
-     * Defines a non-negative 32 bit integer.
-     */
-    asn?: number;
+  /**
+   * Defines a non-negative 32 bit integer.
+   */
+  asn?: number;
 
-    /**
-     * Defines an informative summary of the list item.
-     */
-    comment?: string;
+  /**
+   * Defines an informative summary of the list item.
+   */
+  comment?: string;
 
-    /**
-     * The RFC 3339 timestamp of when the item was created.
-     */
-    created_on?: string;
+  /**
+   * The RFC 3339 timestamp of when the item 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;
+  /**
+   * 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;
 
-    /**
-     * An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a
-     * maximum of /64.
-     */
-    ip?: string;
+  /**
+   * An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
+   */
+  ip?: string;
 
-    /**
-     * The RFC 3339 timestamp of when the item was last modified.
-     */
-    modified_on?: string;
+  /**
+   * The RFC 3339 timestamp of when the item was last modified.
+   */
+  modified_on?: string;
 
-    /**
-     * The definition of the redirect.
-     */
-    redirect?: ListsAPI.Redirect;
-  }
+  /**
+   * The definition of the redirect.
+   */
+  redirect?: ListsAPI.Redirect;
 }
 
 export interface ItemCreateParams {
@@ -354,8 +305,7 @@ export namespace ItemCreateParams {
     hostname?: ListsAPI.HostnameParam;
 
     /**
-     * An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a
-     * maximum of /64.
+     * An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
      */
     ip?: string;
 
@@ -397,8 +347,7 @@ export namespace ItemUpdateParams {
     hostname?: ListsAPI.HostnameParam;
 
     /**
-     * An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a
-     * maximum of /64.
+     * An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
      */
     ip?: string;
 
@@ -409,26 +358,12 @@ export namespace ItemUpdateParams {
   }
 }
 
-export interface ItemListParams {
+export interface ItemListParams extends CursorPaginationParams {
   /**
    * Path param: Defines an identifier.
    */
   account_id: string;
 
-  /**
-   * Query param: The pagination cursor. An opaque string token indicating the
-   * position from which to continue when requesting the next/previous set of
-   * records. Cursor values are provided under `result_info.cursors` in the response.
-   * You should make no assumptions about a cursor's content or length.
-   */
-  cursor?: 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
@@ -439,9 +374,18 @@ export interface ItemListParams {
 
 export interface ItemDeleteParams {
   /**
-   * Defines an identifier.
+   * Path param: Defines an identifier.
    */
   account_id: string;
+
+  /**
+   * Body param:
+   */
+  items?: Array<ItemDeleteParams.Item>;
+}
+
+export namespace ItemDeleteParams {
+  export interface Item {}
 }
 
 export interface ItemGetParams {
@@ -451,6 +395,8 @@ export interface ItemGetParams {
   account_id: string;
 }
 
+Items.ItemListResponsesCursorPagination = ItemListResponsesCursorPagination;
+
 export declare namespace Items {
   export {
     type ListCursor as ListCursor,
@@ -460,6 +406,7 @@ export declare namespace Items {
     type ItemListResponse as ItemListResponse,
     type ItemDeleteResponse as ItemDeleteResponse,
     type ItemGetResponse as ItemGetResponse,
+    ItemListResponsesCursorPagination as ItemListResponsesCursorPagination,
     type ItemCreateParams as ItemCreateParams,
     type ItemUpdateParams as ItemUpdateParams,
     type ItemListParams as ItemListParams,