cloudflare 4.4.1 → 5.0.0

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 { CursorPaginationAfter, type CursorPaginationAfterParams } 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
@@ -18,7 +18,7 @@ export class Items extends APIResource {
    *   '2c0fc9fa937b11eaa1b71c4d701ab86e',
    *   {
    *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *     body: [{}],
+   *     body: [{ ip: '10.0.0.1' }],
    *   },
    * );
    * ```
@@ -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
@@ -51,7 +50,7 @@ export class Items extends APIResource {
    *   '2c0fc9fa937b11eaa1b71c4d701ab86e',
    *   {
    *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *     body: [{}],
+   *     body: [{ ip: '10.0.0.1' }],
    *   },
    * );
    * ```
@@ -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<ItemListResponsesCursorPaginationAfter, 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`,
+      ItemListResponsesCursorPaginationAfter,
+      { 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,278 +152,418 @@ export class Items extends APIResource {
   }
 }
 
+export class ItemListResponsesCursorPaginationAfter extends CursorPaginationAfter<ItemListResponse> {}
+
 export interface ListCursor {
   after?: string;
 
   before?: string;
 }
 
-export type ListItem = ListItem.OperationID | ListItem.OperationID;
+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 namespace ListItem {
-  export interface OperationID {
+export type ItemListResponse =
+  | ItemListResponse.ListsListItemIPFull
+  | ItemListResponse.ListsListItemHostnameFull
+  | ItemListResponse.ListsListItemRedirectFull
+  | ItemListResponse.ListsListItemASNFull;
+
+export namespace ItemListResponse {
+  export interface ListsListItemIPFull {
     /**
-     * The unique operation ID of the asynchronous action.
+     * Defines the unique ID of the item in the List.
      */
-    operation_id?: string;
-  }
+    id: string;
 
-  export interface OperationID {
     /**
-     * The unique operation ID of the asynchronous action.
+     * The RFC 3339 timestamp of when the list was created.
      */
-    operation_id?: string;
-  }
-}
+    created_on: string;
 
-export type ItemCreateResponse = ItemCreateResponse.OperationID | ItemCreateResponse.OperationID;
+    /**
+     * An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
+     */
+    ip: string;
 
-export namespace ItemCreateResponse {
-  export interface OperationID {
     /**
-     * The unique operation ID of the asynchronous action.
+     * The RFC 3339 timestamp of when the list was last modified.
      */
-    operation_id?: string;
-  }
+    modified_on: string;
 
-  export interface OperationID {
     /**
-     * The unique operation ID of the asynchronous action.
+     * Defines an informative summary of the list item.
      */
-    operation_id?: string;
+    comment?: string;
   }
-}
 
-export type ItemUpdateResponse = ItemUpdateResponse.OperationID | ItemUpdateResponse.OperationID;
+  export interface ListsListItemHostnameFull {
+    /**
+     * Defines the unique ID of the item in the List.
+     */
+    id: string;
 
-export namespace ItemUpdateResponse {
-  export interface OperationID {
     /**
-     * The unique operation ID of the asynchronous action.
+     * The RFC 3339 timestamp of when the list was created.
      */
-    operation_id?: string;
-  }
+    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;
 
-  export interface OperationID {
     /**
-     * The unique operation ID of the asynchronous action.
+     * Defines an informative summary of the list item.
      */
-    operation_id?: string;
+    comment?: string;
   }
-}
 
-export type ItemListResponse = unknown | Array<unknown>;
+  export 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;
 
-export type ItemDeleteResponse = ItemDeleteResponse.OperationID | ItemDeleteResponse.OperationID;
+    /**
+     * The definition of the redirect.
+     */
+    redirect: ListsAPI.Redirect;
 
-export namespace ItemDeleteResponse {
-  export interface OperationID {
     /**
-     * The unique operation ID of the asynchronous action.
+     * Defines an informative summary of the list item.
      */
-    operation_id?: string;
+    comment?: string;
   }
 
-  export interface OperationID {
+  export interface ListsListItemASNFull {
     /**
-     * The unique operation ID of the asynchronous action.
+     * Defines the unique ID of the item in the List.
+     */
+    id: string;
+
+    /**
+     * Defines a non-negative 32 bit integer.
      */
-    operation_id?: string;
+    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 type ItemGetResponse = ItemGetResponse.UnionMember0 | ItemGetResponse.UnionMember1;
+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 namespace ItemGetResponse {
-  export interface UnionMember0 {
+  export interface ListsListItemIPFull {
     /**
-     * The unique ID of the list.
+     * Defines the unique ID of the item in the List.
      */
-    id?: string;
+    id: string;
 
     /**
-     * Defines a non-negative 32 bit integer.
+     * 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.
      */
-    asn?: number;
+    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;
+  }
+
+  export interface ListsListItemHostnameFull {
+    /**
+     * Defines the unique ID of the item in the List.
+     */
+    id: string;
 
     /**
-     * The RFC 3339 timestamp of when the item was created.
+     * The RFC 3339 timestamp of when the list was created.
      */
-    created_on?: string;
+    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;
+    hostname: ListsAPI.Hostname;
+
+    /**
+     * The RFC 3339 timestamp of when the list was last modified.
+     */
+    modified_on: string;
 
     /**
-     * An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a
-     * maximum of /64.
+     * Defines an informative summary of the list item.
      */
-    ip?: string;
+    comment?: string;
+  }
 
+  export interface ListsListItemRedirectFull {
     /**
-     * The RFC 3339 timestamp of when the item was last modified.
+     * Defines the unique ID of the item in the List.
      */
-    modified_on?: string;
+    id: string;
 
     /**
-     * The definition of the redirect.
+     * The RFC 3339 timestamp of when the list was created.
      */
-    redirect?: ListsAPI.Redirect;
-  }
+    created_on: string;
 
-  export interface UnionMember1 {
     /**
-     * The unique ID of the list.
+     * The RFC 3339 timestamp of when the list was last modified.
      */
-    id?: string;
+    modified_on: string;
 
     /**
-     * Defines a non-negative 32 bit integer.
+     * The definition of the redirect.
      */
-    asn?: number;
+    redirect: ListsAPI.Redirect;
 
     /**
      * Defines an informative summary of the list item.
      */
     comment?: string;
+  }
 
+  export interface ListsListItemASNFull {
     /**
-     * The RFC 3339 timestamp of when the item was created.
+     * Defines the unique ID of the item in the List.
      */
-    created_on?: string;
+    id: string;
 
     /**
-     * Valid characters for hostnames are ASCII(7) letters from a to z, the digits from
-     * 0 to 9, wildcards (\*), and the hyphen (-).
+     * Defines a non-negative 32 bit integer.
      */
-    hostname?: ListsAPI.Hostname;
+    asn: number;
 
     /**
-     * An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a
-     * maximum of /64.
+     * The RFC 3339 timestamp of when the list was created.
      */
-    ip?: string;
+    created_on: string;
 
     /**
-     * The RFC 3339 timestamp of when the item was last modified.
+     * The RFC 3339 timestamp of when the list was last modified.
      */
-    modified_on?: string;
+    modified_on: string;
 
     /**
-     * The definition of the redirect.
+     * Defines an informative summary of the list item.
      */
-    redirect?: ListsAPI.Redirect;
+    comment?: string;
   }
 }
 
 export interface ItemCreateParams {
   /**
-   * Path param: Defines an identifier.
+   * Path param: The Account ID for this resource.
    */
   account_id: string;
 
   /**
    * Body param:
    */
-  body: Array<ItemCreateParams.Body>;
+  body: Array<
+    | ItemCreateParams.ListsListItemIPComment
+    | ItemCreateParams.ListsListItemRedirectComment
+    | ItemCreateParams.ListsListItemHostnameComment
+    | ItemCreateParams.ListsListItemASNComment
+  >;
 }
 
 export namespace ItemCreateParams {
-  export interface Body {
+  export interface ListsListItemIPComment {
     /**
-     * Defines a non-negative 32 bit integer.
+     * An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
      */
-    asn?: number;
+    ip: string;
 
     /**
      * Defines an informative summary of the list item.
      */
     comment?: string;
+  }
+
+  export interface ListsListItemRedirectComment {
+    /**
+     * The definition of the redirect.
+     */
+    redirect: ListsAPI.RedirectParam;
 
+    /**
+     * Defines an informative summary of the list item.
+     */
+    comment?: string;
+  }
+
+  export 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;
+    hostname: ListsAPI.HostnameParam;
+
+    /**
+     * Defines an informative summary of the list item.
+     */
+    comment?: string;
+  }
 
+  export interface ListsListItemASNComment {
     /**
-     * An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a
-     * maximum of /64.
+     * Defines a non-negative 32 bit integer.
      */
-    ip?: string;
+    asn: number;
 
     /**
-     * The definition of the redirect.
+     * Defines an informative summary of the list item.
      */
-    redirect?: ListsAPI.RedirectParam;
+    comment?: string;
   }
 }
 
 export interface ItemUpdateParams {
   /**
-   * Path param: Defines an identifier.
+   * Path param: The Account ID for this resource.
    */
   account_id: string;
 
   /**
    * Body param:
    */
-  body: Array<ItemUpdateParams.Body>;
+  body: Array<
+    | ItemUpdateParams.ListsListItemIPComment
+    | ItemUpdateParams.ListsListItemRedirectComment
+    | ItemUpdateParams.ListsListItemHostnameComment
+    | ItemUpdateParams.ListsListItemASNComment
+  >;
 }
 
 export namespace ItemUpdateParams {
-  export interface Body {
+  export interface ListsListItemIPComment {
     /**
-     * Defines a non-negative 32 bit integer.
+     * 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;
+  }
+
+  export interface ListsListItemRedirectComment {
+    /**
+     * The definition of the redirect.
      */
-    asn?: number;
+    redirect: ListsAPI.RedirectParam;
 
     /**
      * Defines an informative summary of the list item.
      */
     comment?: string;
+  }
 
+  export 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;
+    hostname: ListsAPI.HostnameParam;
 
     /**
-     * An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a
-     * maximum of /64.
+     * Defines an informative summary of the list item.
      */
-    ip?: string;
+    comment?: string;
+  }
 
+  export interface ListsListItemASNComment {
     /**
-     * The definition of the redirect.
+     * Defines a non-negative 32 bit integer.
+     */
+    asn: number;
+
+    /**
+     * Defines an informative summary of the list item.
      */
-    redirect?: ListsAPI.RedirectParam;
+    comment?: string;
   }
 }
 
-export interface ItemListParams {
+export interface ItemListParams extends CursorPaginationAfterParams {
   /**
-   * Path param: Defines an identifier.
+   * Path param: The Account ID for this resource.
    */
   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.
@@ -439,18 +580,29 @@ export interface ItemListParams {
 
 export interface ItemDeleteParams {
   /**
-   * Defines an identifier.
+   * Path param: The Account ID for this resource.
    */
   account_id: string;
+
+  /**
+   * Body param:
+   */
+  items?: Array<ItemDeleteParams.Item>;
+}
+
+export namespace ItemDeleteParams {
+  export interface Item {}
 }
 
 export interface ItemGetParams {
   /**
-   * Defines an identifier.
+   * The Account ID for this resource.
    */
   account_id: string;
 }
 
+Items.ItemListResponsesCursorPaginationAfter = ItemListResponsesCursorPaginationAfter;
+
 export declare namespace Items {
   export {
     type ListCursor as ListCursor,
@@ -460,6 +612,7 @@ export declare namespace Items {
     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,