cloudflare 4.4.1 → 5.0.0

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

@@ -14,19 +14,21 @@ import {
   ItemGetResponse,
   ItemListParams,
   ItemListResponse,
+  ItemListResponsesCursorPaginationAfter,
   ItemUpdateParams,
   ItemUpdateResponse,
   Items,
   ListCursor,
   ListItem,
 } from './items';
+import { SinglePage } from '../../../pagination';
 
 export class Lists extends APIResource {
   bulkOperations: BulkOperationsAPI.BulkOperations = new BulkOperationsAPI.BulkOperations(this._client);
   items: ItemsAPI.Items = new ItemsAPI.Items(this._client);
 
   /**
-   * Creates a new list of the specified type.
+   * Creates a new list of the specified kind.
    *
    * @example
    * ```ts
@@ -76,18 +78,20 @@ export class Lists extends APIResource {
    *
    * @example
    * ```ts
-   * const lists = await client.rules.lists.list({
+   * // Automatically fetches more pages as needed.
+   * for await (const listsList of client.rules.lists.list({
    *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   * });
+   * })) {
+   *   // ...
+   * }
    * ```
    */
-  list(params: ListListParams, options?: Core.RequestOptions): Core.APIPromise<ListListResponse> {
+  list(
+    params: ListListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ListsListsSinglePage, ListsList> {
     const { account_id } = params;
-    return (
-      this._client.get(`/accounts/${account_id}/rules/lists`, options) as Core.APIPromise<{
-        result: ListListResponse;
-      }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(`/accounts/${account_id}/rules/lists`, ListsListsSinglePage, options);
   }
 
   /**
@@ -139,12 +143,21 @@ export class Lists extends APIResource {
   }
 }
 
+export class ListsListsSinglePage extends SinglePage<ListsList> {}
+
 /**
  * Valid characters for hostnames are ASCII(7) letters from a to z, the digits from
  * 0 to 9, wildcards (\*), and the hyphen (-).
  */
 export interface Hostname {
   url_hostname: string;
+
+  /**
+   * Only applies to wildcard hostnames (e.g., \*.example.com). When true (default),
+   * only subdomains are blocked. When false, both the root domain and subdomains are
+   * blocked.
+   */
+  exclude_exact_hostname?: boolean;
 }
 
 /**
@@ -153,49 +166,56 @@ export interface Hostname {
  */
 export interface HostnameParam {
   url_hostname: string;
+
+  /**
+   * Only applies to wildcard hostnames (e.g., \*.example.com). When true (default),
+   * only subdomains are blocked. When false, both the root domain and subdomains are
+   * blocked.
+   */
+  exclude_exact_hostname?: boolean;
 }
 
 export interface ListsList {
   /**
    * The unique ID of the list.
    */
-  id?: string;
+  id: string;
 
   /**
    * The RFC 3339 timestamp of when the list was created.
    */
-  created_on?: string;
-
-  /**
-   * An informative summary of the list.
-   */
-  description?: string;
+  created_on: string;
 
   /**
    * The type of the list. Each type supports specific list items (IP addresses,
    * ASNs, hostnames or redirects).
    */
-  kind?: 'ip' | 'redirect' | 'hostname' | 'asn';
+  kind: 'ip' | 'redirect' | 'hostname' | 'asn';
 
   /**
    * The RFC 3339 timestamp of when the list was last modified.
    */
-  modified_on?: string;
+  modified_on: string;
 
   /**
    * An informative name for the list. Use this name in filter and rule expressions.
    */
-  name?: string;
+  name: string;
 
   /**
    * The number of items in the list.
    */
-  num_items?: number;
+  num_items: number;
 
   /**
-   * The number of [filters](/operations/filters-list-filters) referencing the list.
+   * The number of [filters](/api/resources/filters/) referencing the list.
    */
-  num_referencing_filters?: number;
+  num_referencing_filters: number;
+
+  /**
+   * An informative summary of the list.
+   */
+  description?: string;
 }
 
 /**
@@ -236,299 +256,145 @@ export interface RedirectParam {
   subpath_matching?: boolean;
 }
 
-export type ListCreateResponse = ListCreateResponse.UnionMember0 | ListCreateResponse.UnionMember1;
-
-export namespace ListCreateResponse {
-  export interface UnionMember0 {
-    /**
-     * The unique ID of the list.
-     */
-    id?: string;
-
-    /**
-     * The RFC 3339 timestamp of when the list was created.
-     */
-    created_on?: string;
-
-    /**
-     * An informative summary of the list.
-     */
-    description?: string;
-
-    /**
-     * The type of the list. Each type supports specific list items (IP addresses,
-     * ASNs, hostnames or redirects).
-     */
-    kind?: 'ip' | 'redirect' | 'hostname' | 'asn';
-
-    /**
-     * The RFC 3339 timestamp of when the list was last modified.
-     */
-    modified_on?: string;
-
-    /**
-     * An informative name for the list. Use this name in filter and rule expressions.
-     */
-    name?: string;
-
-    /**
-     * The number of items in the list.
-     */
-    num_items?: number;
-
-    /**
-     * The number of [filters](/operations/filters-list-filters) referencing the list.
-     */
-    num_referencing_filters?: number;
-  }
+export interface ListCreateResponse {
+  /**
+   * The unique ID of the list.
+   */
+  id: string;
 
-  export interface UnionMember1 {
-    /**
-     * The unique ID of the list.
-     */
-    id?: string;
-
-    /**
-     * The RFC 3339 timestamp of when the list was created.
-     */
-    created_on?: string;
-
-    /**
-     * An informative summary of the list.
-     */
-    description?: string;
-
-    /**
-     * The type of the list. Each type supports specific list items (IP addresses,
-     * ASNs, hostnames or redirects).
-     */
-    kind?: 'ip' | 'redirect' | 'hostname' | 'asn';
-
-    /**
-     * The RFC 3339 timestamp of when the list was last modified.
-     */
-    modified_on?: string;
-
-    /**
-     * An informative name for the list. Use this name in filter and rule expressions.
-     */
-    name?: string;
-
-    /**
-     * The number of items in the list.
-     */
-    num_items?: number;
-
-    /**
-     * The number of [filters](/operations/filters-list-filters) referencing the list.
-     */
-    num_referencing_filters?: number;
-  }
-}
+  /**
+   * The RFC 3339 timestamp of when the list was created.
+   */
+  created_on: string;
 
-export type ListUpdateResponse = ListUpdateResponse.UnionMember0 | ListUpdateResponse.UnionMember1;
-
-export namespace ListUpdateResponse {
-  export interface UnionMember0 {
-    /**
-     * The unique ID of the list.
-     */
-    id?: string;
-
-    /**
-     * The RFC 3339 timestamp of when the list was created.
-     */
-    created_on?: string;
-
-    /**
-     * An informative summary of the list.
-     */
-    description?: string;
-
-    /**
-     * The type of the list. Each type supports specific list items (IP addresses,
-     * ASNs, hostnames or redirects).
-     */
-    kind?: 'ip' | 'redirect' | 'hostname' | 'asn';
-
-    /**
-     * The RFC 3339 timestamp of when the list was last modified.
-     */
-    modified_on?: string;
-
-    /**
-     * An informative name for the list. Use this name in filter and rule expressions.
-     */
-    name?: string;
-
-    /**
-     * The number of items in the list.
-     */
-    num_items?: number;
-
-    /**
-     * The number of [filters](/operations/filters-list-filters) referencing the list.
-     */
-    num_referencing_filters?: number;
-  }
+  /**
+   * The type of the list. Each type supports specific list items (IP addresses,
+   * ASNs, hostnames or redirects).
+   */
+  kind: 'ip' | 'redirect' | 'hostname' | 'asn';
 
-  export interface UnionMember1 {
-    /**
-     * The unique ID of the list.
-     */
-    id?: string;
-
-    /**
-     * The RFC 3339 timestamp of when the list was created.
-     */
-    created_on?: string;
-
-    /**
-     * An informative summary of the list.
-     */
-    description?: string;
-
-    /**
-     * The type of the list. Each type supports specific list items (IP addresses,
-     * ASNs, hostnames or redirects).
-     */
-    kind?: 'ip' | 'redirect' | 'hostname' | 'asn';
-
-    /**
-     * The RFC 3339 timestamp of when the list was last modified.
-     */
-    modified_on?: string;
-
-    /**
-     * An informative name for the list. Use this name in filter and rule expressions.
-     */
-    name?: string;
-
-    /**
-     * The number of items in the list.
-     */
-    num_items?: number;
-
-    /**
-     * The number of [filters](/operations/filters-list-filters) referencing the list.
-     */
-    num_referencing_filters?: number;
-  }
+  /**
+   * The RFC 3339 timestamp of when the list was last modified.
+   */
+  modified_on: string;
+
+  /**
+   * An informative name for the list. Use this name in filter and rule expressions.
+   */
+  name: string;
+
+  /**
+   * The number of items in the list.
+   */
+  num_items: number;
+
+  /**
+   * The number of [filters](/api/resources/filters/) referencing the list.
+   */
+  num_referencing_filters: number;
+
+  /**
+   * An informative summary of the list.
+   */
+  description?: string;
 }
 
-export type ListListResponse = unknown | Array<unknown>;
+export interface ListUpdateResponse {
+  /**
+   * The unique ID of the list.
+   */
+  id: string;
 
-export type ListDeleteResponse = ListDeleteResponse.ID | ListDeleteResponse.ID;
+  /**
+   * The RFC 3339 timestamp of when the list was created.
+   */
+  created_on: string;
 
-export namespace ListDeleteResponse {
-  export interface ID {
-    /**
-     * Defines the unique ID of the item in the List.
-     */
-    id?: string;
-  }
+  /**
+   * The type of the list. Each type supports specific list items (IP addresses,
+   * ASNs, hostnames or redirects).
+   */
+  kind: 'ip' | 'redirect' | 'hostname' | 'asn';
 
-  export interface ID {
-    /**
-     * Defines the unique ID of the item in the List.
-     */
-    id?: string;
-  }
+  /**
+   * The RFC 3339 timestamp of when the list was last modified.
+   */
+  modified_on: string;
+
+  /**
+   * An informative name for the list. Use this name in filter and rule expressions.
+   */
+  name: string;
+
+  /**
+   * The number of items in the list.
+   */
+  num_items: number;
+
+  /**
+   * The number of [filters](/api/resources/filters/) referencing the list.
+   */
+  num_referencing_filters: number;
+
+  /**
+   * An informative summary of the list.
+   */
+  description?: string;
 }
 
-export type ListGetResponse = ListGetResponse.UnionMember0 | ListGetResponse.UnionMember1;
-
-export namespace ListGetResponse {
-  export interface UnionMember0 {
-    /**
-     * The unique ID of the list.
-     */
-    id?: string;
-
-    /**
-     * The RFC 3339 timestamp of when the list was created.
-     */
-    created_on?: string;
-
-    /**
-     * An informative summary of the list.
-     */
-    description?: string;
-
-    /**
-     * The type of the list. Each type supports specific list items (IP addresses,
-     * ASNs, hostnames or redirects).
-     */
-    kind?: 'ip' | 'redirect' | 'hostname' | 'asn';
-
-    /**
-     * The RFC 3339 timestamp of when the list was last modified.
-     */
-    modified_on?: string;
-
-    /**
-     * An informative name for the list. Use this name in filter and rule expressions.
-     */
-    name?: string;
-
-    /**
-     * The number of items in the list.
-     */
-    num_items?: number;
-
-    /**
-     * The number of [filters](/operations/filters-list-filters) referencing the list.
-     */
-    num_referencing_filters?: number;
-  }
+export interface ListDeleteResponse {
+  /**
+   * The unique ID of the list.
+   */
+  id: string;
+}
 
-  export interface UnionMember1 {
-    /**
-     * The unique ID of the list.
-     */
-    id?: string;
-
-    /**
-     * The RFC 3339 timestamp of when the list was created.
-     */
-    created_on?: string;
-
-    /**
-     * An informative summary of the list.
-     */
-    description?: string;
-
-    /**
-     * The type of the list. Each type supports specific list items (IP addresses,
-     * ASNs, hostnames or redirects).
-     */
-    kind?: 'ip' | 'redirect' | 'hostname' | 'asn';
-
-    /**
-     * The RFC 3339 timestamp of when the list was last modified.
-     */
-    modified_on?: string;
-
-    /**
-     * An informative name for the list. Use this name in filter and rule expressions.
-     */
-    name?: string;
-
-    /**
-     * The number of items in the list.
-     */
-    num_items?: number;
-
-    /**
-     * The number of [filters](/operations/filters-list-filters) referencing the list.
-     */
-    num_referencing_filters?: number;
-  }
+export interface ListGetResponse {
+  /**
+   * The unique ID of the list.
+   */
+  id: string;
+
+  /**
+   * The RFC 3339 timestamp of when the list was created.
+   */
+  created_on: string;
+
+  /**
+   * The type of the list. Each type supports specific list items (IP addresses,
+   * ASNs, hostnames or redirects).
+   */
+  kind: 'ip' | 'redirect' | 'hostname' | 'asn';
+
+  /**
+   * The RFC 3339 timestamp of when the list was last modified.
+   */
+  modified_on: string;
+
+  /**
+   * An informative name for the list. Use this name in filter and rule expressions.
+   */
+  name: string;
+
+  /**
+   * The number of items in the list.
+   */
+  num_items: number;
+
+  /**
+   * The number of [filters](/api/resources/filters/) referencing the list.
+   */
+  num_referencing_filters: number;
+
+  /**
+   * An informative summary of the list.
+   */
+  description?: string;
 }
 
 export interface ListCreateParams {
   /**
-   * Path param: Defines an identifier.
+   * Path param: The Account ID for this resource.
    */
   account_id: string;
 
@@ -552,7 +418,7 @@ export interface ListCreateParams {
 
 export interface ListUpdateParams {
   /**
-   * Path param: Defines an identifier.
+   * Path param: The Account ID for this resource.
    */
   account_id: string;
 
@@ -564,27 +430,29 @@ export interface ListUpdateParams {
 
 export interface ListListParams {
   /**
-   * Defines an identifier.
+   * The Account ID for this resource.
    */
   account_id: string;
 }
 
 export interface ListDeleteParams {
   /**
-   * Defines an identifier.
+   * The Account ID for this resource.
    */
   account_id: string;
 }
 
 export interface ListGetParams {
   /**
-   * Defines an identifier.
+   * The Account ID for this resource.
    */
   account_id: string;
 }
 
+Lists.ListsListsSinglePage = ListsListsSinglePage;
 Lists.BulkOperations = BulkOperations;
 Lists.Items = Items;
+Lists.ItemListResponsesCursorPaginationAfter = ItemListResponsesCursorPaginationAfter;
 
 export declare namespace Lists {
   export {
@@ -593,9 +461,9 @@ export declare namespace Lists {
     type Redirect as Redirect,
     type ListCreateResponse as ListCreateResponse,
     type ListUpdateResponse as ListUpdateResponse,
-    type ListListResponse as ListListResponse,
     type ListDeleteResponse as ListDeleteResponse,
     type ListGetResponse as ListGetResponse,
+    ListsListsSinglePage as ListsListsSinglePage,
     type ListCreateParams as ListCreateParams,
     type ListUpdateParams as ListUpdateParams,
     type ListListParams as ListListParams,
@@ -618,6 +486,7 @@ export declare namespace Lists {
     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,

package/src/resources/rules/rules.ts

@@ -11,11 +11,11 @@ import {
   ListGetParams,
   ListGetResponse,
   ListListParams,
-  ListListResponse,
   ListUpdateParams,
   ListUpdateResponse,
   Lists,
   ListsList,
+  ListsListsSinglePage,
   Redirect,
 } from './lists/lists';
 
@@ -24,6 +24,7 @@ export class Rules extends APIResource {
 }
 
 Rules.Lists = Lists;
+Rules.ListsListsSinglePage = ListsListsSinglePage;
 
 export declare namespace Rules {
   export {
@@ -33,9 +34,9 @@ export declare namespace Rules {
     type Redirect as Redirect,
     type ListCreateResponse as ListCreateResponse,
     type ListUpdateResponse as ListUpdateResponse,
-    type ListListResponse as ListListResponse,
     type ListDeleteResponse as ListDeleteResponse,
     type ListGetResponse as ListGetResponse,
+    ListsListsSinglePage as ListsListsSinglePage,
     type ListCreateParams as ListCreateParams,
     type ListUpdateParams as ListUpdateParams,
     type ListListParams as ListListParams,

package/src/resources/rulesets/index.ts

@@ -20,7 +20,6 @@ export {
   type ManagedChallengeRule,
   type RedirectRule,
   type RewriteRule,
-  type RewriteURIPart,
   type RouteRule,
   type RulesetRule,
   type ScoreRule,