cloudflare 4.4.1 → 4.5.0

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

@@ -14,12 +14,14 @@ import {
   ItemGetResponse,
   ItemListParams,
   ItemListResponse,
+  ItemListResponsesCursorPagination,
   ItemUpdateParams,
   ItemUpdateResponse,
   Items,
   ListCursor,
   ListItem,
 } from './items';
+import { SinglePage } from '../../../pagination';
 
 export class Lists extends APIResource {
   bulkOperations: BulkOperationsAPI.BulkOperations = new BulkOperationsAPI.BulkOperations(this._client);
@@ -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,6 +143,8 @@ 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 (-).
@@ -236,294 +242,140 @@ 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;
-  }
+  /**
+   * An informative summary of the list.
+   */
+  description?: 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 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 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;
-  }
+  /**
+   * An informative summary of the list.
+   */
+  description?: string;
 
-  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';
+
+  /**
+   * 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 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 {
+  /**
+   * Defines the unique ID of the item in 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;
+
+  /**
+   * 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 ListCreateParams {
@@ -583,8 +435,10 @@ export interface ListGetParams {
   account_id: string;
 }
 
+Lists.ListsListsSinglePage = ListsListsSinglePage;
 Lists.BulkOperations = BulkOperations;
 Lists.Items = Items;
+Lists.ItemListResponsesCursorPagination = ItemListResponsesCursorPagination;
 
 export declare namespace Lists {
   export {
@@ -593,9 +447,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 +472,7 @@ export declare namespace Lists {
     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,

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/rules.ts

@@ -3215,14 +3215,14 @@ export namespace RewriteRule {
     /**
      * Map of request headers to modify.
      */
-    headers?: Record<
-      string,
-      | ActionParameters.RemoveHeader
-      | ActionParameters.AddStaticHeader
-      | ActionParameters.SetStaticHeader
-      | ActionParameters.AddDynamicHeader
-      | ActionParameters.SetDynamicHeader
-    >;
+    headers?: {
+      [key: string]:
+        | ActionParameters.RemoveHeader
+        | ActionParameters.AddStaticHeader
+        | ActionParameters.SetStaticHeader
+        | ActionParameters.AddDynamicHeader
+        | ActionParameters.SetDynamicHeader;
+    };
 
     /**
      * URI to rewrite the request to.
@@ -3429,14 +3429,14 @@ export namespace RewriteRuleParam {
     /**
      * Map of request headers to modify.
      */
-    headers?: Record<
-      string,
-      | ActionParameters.RemoveHeader
-      | ActionParameters.AddStaticHeader
-      | ActionParameters.SetStaticHeader
-      | ActionParameters.AddDynamicHeader
-      | ActionParameters.SetDynamicHeader
-    >;
+    headers?: {
+      [key: string]:
+        | ActionParameters.RemoveHeader
+        | ActionParameters.AddStaticHeader
+        | ActionParameters.SetStaticHeader
+        | ActionParameters.AddDynamicHeader
+        | ActionParameters.SetDynamicHeader;
+    };
 
     /**
      * URI to rewrite the request to.
@@ -4930,7 +4930,7 @@ export namespace SetCacheSettingsRule {
            * whether any of the values provided are contained in the request header value is
            * used in building the cache key.
            */
-          contains?: Record<string, Array<string>>;
+          contains?: { [key: string]: Array<string> };
 
           /**
            * Whether or not to include the origin header. A value of true will exclude the
@@ -5446,7 +5446,7 @@ export namespace SetCacheSettingsRuleParam {
            * whether any of the values provided are contained in the request header value is
            * used in building the cache key.
            */
-          contains?: Record<string, Array<string>>;
+          contains?: { [key: string]: Array<string> };
 
           /**
            * Whether or not to include the origin header. A value of true will exclude the
@@ -6288,7 +6288,7 @@ export namespace SkipRule {
      * A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the
      * execution of. This option is incompatible with the ruleset option.
      */
-    rules?: Record<string, Array<string>>;
+    rules?: { [key: string]: Array<string> };
 
     /**
      * A ruleset to skip the execution of. This option is incompatible with the
@@ -6442,7 +6442,7 @@ export namespace SkipRuleParam {
      * A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the
      * execution of. This option is incompatible with the ruleset option.
      */
-    rules?: Record<string, Array<string>>;
+    rules?: { [key: string]: Array<string> };
 
     /**
      * A ruleset to skip the execution of. This option is incompatible with the
@@ -9233,14 +9233,14 @@ export declare namespace RuleCreateParams {
       /**
        * Map of request headers to modify.
        */
-      headers?: Record<
-        string,
-        | ActionParameters.RemoveHeader
-        | ActionParameters.AddStaticHeader
-        | ActionParameters.SetStaticHeader
-        | ActionParameters.AddDynamicHeader
-        | ActionParameters.SetDynamicHeader
-      >;
+      headers?: {
+        [key: string]:
+          | ActionParameters.RemoveHeader
+          | ActionParameters.AddStaticHeader
+          | ActionParameters.SetStaticHeader
+          | ActionParameters.AddDynamicHeader
+          | ActionParameters.SetDynamicHeader;
+      };
 
       /**
        * URI to rewrite the request to.
@@ -10374,7 +10374,7 @@ export declare namespace RuleCreateParams {
        * A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the
        * execution of. This option is incompatible with the ruleset option.
        */
-      rules?: Record<string, Array<string>>;
+      rules?: { [key: string]: Array<string> };
 
       /**
        * A ruleset to skip the execution of. This option is incompatible with the
@@ -10748,7 +10748,7 @@ export declare namespace RuleCreateParams {
              * whether any of the values provided are contained in the request header value is
              * used in building the cache key.
              */
-            contains?: Record<string, Array<string>>;
+            contains?: { [key: string]: Array<string> };
 
             /**
              * Whether or not to include the origin header. A value of true will exclude the
@@ -13375,14 +13375,14 @@ export declare namespace RuleEditParams {
       /**
        * Map of request headers to modify.
        */
-      headers?: Record<
-        string,
-        | ActionParameters.RemoveHeader
-        | ActionParameters.AddStaticHeader
-        | ActionParameters.SetStaticHeader
-        | ActionParameters.AddDynamicHeader
-        | ActionParameters.SetDynamicHeader
-      >;
+      headers?: {
+        [key: string]:
+          | ActionParameters.RemoveHeader
+          | ActionParameters.AddStaticHeader
+          | ActionParameters.SetStaticHeader
+          | ActionParameters.AddDynamicHeader
+          | ActionParameters.SetDynamicHeader;
+      };
 
       /**
        * URI to rewrite the request to.
@@ -14516,7 +14516,7 @@ export declare namespace RuleEditParams {
        * A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the
        * execution of. This option is incompatible with the ruleset option.
        */
-      rules?: Record<string, Array<string>>;
+      rules?: { [key: string]: Array<string> };
 
       /**
        * A ruleset to skip the execution of. This option is incompatible with the
@@ -14890,7 +14890,7 @@ export declare namespace RuleEditParams {
              * whether any of the values provided are contained in the request header value is
              * used in building the cache key.
              */
-            contains?: Record<string, Array<string>>;
+            contains?: { [key: string]: Array<string> };
 
             /**
              * Whether or not to include the origin header. A value of true will exclude the