apify-client 2.20.1-beta.3 → 2.20.1-beta.4

package/dist/base/resource_collection_client.d.ts

@@ -1,3 +1,4 @@
+import type { PaginatedResponse, PaginationOptions } from '../utils';
 import { ApiClient } from './api_client';
 /**
  * Resource collection client.
@@ -8,6 +9,10 @@ export declare class ResourceCollectionClient extends ApiClient {
      * @private
      */
     protected _list<T, R>(options?: T): Promise<R>;
+    /**
+     * Returns async iterator to iterate through all items and Promise that can be awaited to get first page of results.
+     */
+    protected _listPaginated<T extends PaginationOptions, Data, R extends PaginatedResponse<Data>>(options?: T): AsyncIterable<Data> & Promise<R>;
     protected _create<D, R>(resource: D): Promise<R>;
     protected _getOrCreate<D, R>(name?: string, resource?: D): Promise<R>;
 }

package/dist/base/resource_collection_client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resource_collection_client.d.ts","sourceRoot":"","sources":["../../src/base/resource_collection_client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC;;;GAGG;AACH,qBAAa,wBAAyB,SAAQ,SAAS;IACnD;;OAEG;cACa,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,GAAE,CAAW,GAAG,OAAO,CAAC,CAAC,CAAC;cAS7C,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;cAUtC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CAS9E"}
+{"version":3,"file":"resource_collection_client.d.ts","sourceRoot":"","sources":["../../src/base/resource_collection_client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAErE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC;;;GAGG;AACH,qBAAa,wBAAyB,SAAQ,SAAS;IACnD;;OAEG;cACa,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,GAAE,CAAW,GAAG,OAAO,CAAC,CAAC,CAAC;IAS7D;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,iBAAiB,EAAE,IAAI,EAAE,CAAC,SAAS,iBAAiB,CAAC,IAAI,CAAC,EACzF,OAAO,GAAE,CAAW,GACrB,aAAa,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;cA8BnB,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;cAUtC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CAS9E"}

package/dist/base/resource_collection_client.js

@@ -19,6 +19,33 @@ class ResourceCollectionClient extends api_client_1.ApiClient {
         });
         return (0, utils_1.parseDateFields)((0, utils_1.pluckData)(response.data));
     }
+    /**
+     * Returns async iterator to iterate through all items and Promise that can be awaited to get first page of results.
+     */
+    _listPaginated(options = {}) {
+        const getPaginatedList = this._list.bind(this);
+        const paginatedListPromise = getPaginatedList(options);
+        async function* asyncGenerator() {
+            var _a;
+            let currentPage = await paginatedListPromise;
+            yield* currentPage.items;
+            const offset = (_a = options.offset) !== null && _a !== void 0 ? _a : 0;
+            const limit = Math.min(options.limit || currentPage.total, currentPage.total);
+            let currentOffset = offset + currentPage.items.length;
+            let remainingItems = Math.min(currentPage.total - offset, limit) - currentPage.items.length;
+            while (currentPage.items.length > 0 && // Continue only if at least some items were returned in the last page.
+                remainingItems > 0) {
+                const newOptions = { ...options, limit: remainingItems, offset: currentOffset };
+                currentPage = await getPaginatedList(newOptions);
+                yield* currentPage.items;
+                currentOffset += currentPage.items.length;
+                remainingItems -= currentPage.items.length;
+            }
+        }
+        return Object.defineProperty(paginatedListPromise, Symbol.asyncIterator, {
+            value: asyncGenerator,
+        });
+    }
     async _create(resource) {
         const response = await this.httpClient.call({
             url: this._url(),

package/dist/base/resource_collection_client.js.map

@@ -1 +1 @@
-{"version":3,"file":"resource_collection_client.js","sourceRoot":"","sources":["../../src/base/resource_collection_client.ts"],"names":[],"mappings":";;;AAAA,oCAAsD;AACtD,6CAAyC;AAEzC;;;GAGG;AACH,MAAa,wBAAyB,SAAQ,sBAAS;IACnD;;OAEG;IACO,KAAK,CAAC,KAAK,CAAO,UAAa,EAAO;QAC5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE;YAChB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;SAChC,CAAC,CAAC;QACH,OAAO,IAAA,uBAAe,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAM,CAAC;IAC1D,CAAC;IAES,KAAK,CAAC,OAAO,CAAO,QAAW;QACrC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE;YAChB,MAAM,EAAE,MAAM;YACd,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE;YACtB,IAAI,EAAE,QAAQ;SACjB,CAAC,CAAC;QACH,OAAO,IAAA,uBAAe,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAM,CAAC;IAC1D,CAAC;IAES,KAAK,CAAC,YAAY,CAAO,IAAa,EAAE,QAAY;QAC1D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE;YAChB,MAAM,EAAE,MAAM;YACd,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC;YAC9B,IAAI,EAAE,QAAQ;SACjB,CAAC,CAAC;QACH,OAAO,IAAA,uBAAe,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAM,CAAC;IAC1D,CAAC;CACJ;AAhCD,4DAgCC"}
+{"version":3,"file":"resource_collection_client.js","sourceRoot":"","sources":["../../src/base/resource_collection_client.ts"],"names":[],"mappings":";;;AACA,oCAAsD;AACtD,6CAAyC;AAEzC;;;GAGG;AACH,MAAa,wBAAyB,SAAQ,sBAAS;IACnD;;OAEG;IACO,KAAK,CAAC,KAAK,CAAO,UAAa,EAAO;QAC5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE;YAChB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;SAChC,CAAC,CAAC;QACH,OAAO,IAAA,uBAAe,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAM,CAAC;IAC1D,CAAC;IAED;;OAEG;IACO,cAAc,CACpB,UAAa,EAAO;QAEpB,MAAM,gBAAgB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/C,MAAM,oBAAoB,GAAG,gBAAgB,CAAO,OAAO,CAAC,CAAC;QAE7D,KAAK,SAAS,CAAC,CAAC,cAAc;;YAC1B,IAAI,WAAW,GAAG,MAAM,oBAAoB,CAAC;YAC7C,KAAK,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC;YACzB,MAAM,MAAM,GAAG,MAAA,OAAO,CAAC,MAAM,mCAAI,CAAC,CAAC;YACnC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,WAAW,CAAC,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;YAE9E,IAAI,aAAa,GAAG,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC;YACtD,IAAI,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,KAAK,GAAG,MAAM,EAAE,KAAK,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC;YAE5F,OACI,WAAW,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,uEAAuE;gBACvG,cAAc,GAAG,CAAC,EACpB,CAAC;gBACC,MAAM,UAAU,GAAG,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC;gBAChF,WAAW,GAAG,MAAM,gBAAgB,CAAO,UAAU,CAAC,CAAC;gBACvD,KAAK,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC;gBACzB,aAAa,IAAI,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC;gBAC1C,cAAc,IAAI,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC;YAC/C,CAAC;QACL,CAAC;QAED,OAAO,MAAM,CAAC,cAAc,CAAC,oBAAoB,EAAE,MAAM,CAAC,aAAa,EAAE;YACrE,KAAK,EAAE,cAAc;SACxB,CAAgD,CAAC;IACtD,CAAC;IAES,KAAK,CAAC,OAAO,CAAO,QAAW;QACrC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE;YAChB,MAAM,EAAE,MAAM;YACd,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE;YACtB,IAAI,EAAE,QAAQ;SACjB,CAAC,CAAC;QACH,OAAO,IAAA,uBAAe,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAM,CAAC;IAC1D,CAAC;IAES,KAAK,CAAC,YAAY,CAAO,IAAa,EAAE,QAAY;QAC1D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE;YAChB,MAAM,EAAE,MAAM;YACd,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC;YAC9B,IAAI,EAAE,QAAQ;SACjB,CAAC,CAAC;QACH,OAAO,IAAA,uBAAe,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAM,CAAC;IAC1D,CAAC;CACJ;AAnED,4DAmEC"}

package/dist/bundle.js

@@ -56851,6 +56851,36 @@ __webpack_require__.d(__webpack_exports__, {
         });
         return (0,_utils__WEBPACK_IMPORTED_MODULE_0__.parseDateFields)((0,_utils__WEBPACK_IMPORTED_MODULE_0__.pluckData)(response.data));
     }
+    /**
+     * Returns async iterator to iterate through all items and Promise that can be awaited to get first page of results.
+     */ _listPaginated() {
+        let options = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
+        const getPaginatedList = this._list.bind(this);
+        const paginatedListPromise = getPaginatedList(options);
+        async function* asyncGenerator() {
+            let currentPage = await paginatedListPromise;
+            yield* currentPage.items;
+            const offset = options.offset ?? 0;
+            const limit = Math.min(options.limit || currentPage.total, currentPage.total);
+            let currentOffset = offset + currentPage.items.length;
+            let remainingItems = Math.min(currentPage.total - offset, limit) - currentPage.items.length;
+            while(currentPage.items.length > 0 && // Continue only if at least some items were returned in the last page.
+            remainingItems > 0){
+                const newOptions = {
+                    ...options,
+                    limit: remainingItems,
+                    offset: currentOffset
+                };
+                currentPage = await getPaginatedList(newOptions);
+                yield* currentPage.items;
+                currentOffset += currentPage.items.length;
+                remainingItems -= currentPage.items.length;
+            }
+        }
+        return Object.defineProperty(paginatedListPromise, Symbol.asyncIterator, {
+            value: asyncGenerator
+        });
+    }
     async _create(resource) {
         const response = await this.httpClient.call({
             url: this._url(),
@@ -57766,7 +57796,20 @@ __webpack_require__.d(__webpack_exports__, {
 class ActorCollectionClient extends _base_resource_collection_client__WEBPACK_IMPORTED_MODULE_0__.ResourceCollectionClient {
     /**
      * https://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors
-     */ async list() {
+     *
+     * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
+     * items in a single API call is limited.
+     * ```javascript
+     * const paginatedList = await client.list(options);
+     *```
+     *
+     * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
+     * retrieved.
+     *
+     * ```javascript
+     * for await (const singleItem of client.list(options)) {...}
+     * ```
+     */ list() {
         let options = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
         ow__WEBPACK_IMPORTED_MODULE_1___default()(options, ow__WEBPACK_IMPORTED_MODULE_1___default().object.exactShape({
             my: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.boolean),
@@ -57775,7 +57818,7 @@ class ActorCollectionClient extends _base_resource_collection_client__WEBPACK_IM
             desc: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.boolean),
             sortBy: ow__WEBPACK_IMPORTED_MODULE_1___default().optional.string.oneOf(Object.values(ActorListSortBy))
         }));
-        return this._list(options);
+        return this._listPaginated(options);
     }
     /**
      * https://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor
@@ -57854,14 +57897,27 @@ __webpack_require__.d(__webpack_exports__, {
 class ActorEnvVarCollectionClient extends _base_resource_collection_client__WEBPACK_IMPORTED_MODULE_0__.ResourceCollectionClient {
     /**
      * https://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables
-     */ async list() {
+     *
+     * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
+     * items in a single API call is limited.
+     * ```javascript
+     * const paginatedList = await client.list(options);
+     *```
+     *
+     * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
+     * retrieved.
+     *
+     * ```javascript
+     * for await (const singleItem of client.list(options)) {...}
+     * ```
+     */ list() {
         let options = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
         ow__WEBPACK_IMPORTED_MODULE_1___default()(options, ow__WEBPACK_IMPORTED_MODULE_1___default().object.exactShape({
             limit: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.number),
             offset: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.number),
             desc: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.boolean)
         }));
-        return this._list(options);
+        return this._listPaginated(options);
     }
     /**
      * https://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable
@@ -57961,14 +58017,27 @@ __webpack_require__.d(__webpack_exports__, {
 class ActorVersionCollectionClient extends _base_resource_collection_client__WEBPACK_IMPORTED_MODULE_0__.ResourceCollectionClient {
     /**
      * https://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions
-     */ async list() {
+     *
+     * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
+     * items in a single API call is limited.
+     * ```javascript
+     * const paginatedList = await client.list(options);
+     *```
+     *
+     * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
+     * retrieved.
+     *
+     * ```javascript
+     * for await (const singleItem of client.list(options)) {...}
+     * ```
+     */ list() {
         let options = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
         ow__WEBPACK_IMPORTED_MODULE_1___default()(options, ow__WEBPACK_IMPORTED_MODULE_1___default().object.exactShape({
             limit: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.number),
             offset: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.number),
             desc: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.boolean)
         }));
-        return this._list(options);
+        return this._listPaginated(options);
     }
     /**
      * https://docs.apify.com/api/v2#/reference/actors/version-collection/create-version
@@ -58088,14 +58157,27 @@ __webpack_require__.d(__webpack_exports__, {
 class BuildCollectionClient extends _base_resource_collection_client__WEBPACK_IMPORTED_MODULE_0__.ResourceCollectionClient {
     /**
      * https://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds
-     */ async list() {
+     *
+     * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
+     * items in a single API call is limited.
+     * ```javascript
+     * const paginatedList = await client.list(options);
+     *```
+     *
+     * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
+     * retrieved.
+     *
+     * ```javascript
+     * for await (const singleItem of client.list(options)) {...}
+     * ```
+     */ list() {
         let options = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
         ow__WEBPACK_IMPORTED_MODULE_1___default()(options, ow__WEBPACK_IMPORTED_MODULE_1___default().object.exactShape({
             limit: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.number),
             offset: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.number),
             desc: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.boolean)
         }));
-        return this._list(options);
+        return this._listPaginated(options);
     }
     /**
      * @hidden
@@ -58331,7 +58413,20 @@ __webpack_require__.d(__webpack_exports__, {
 class DatasetCollectionClient extends _base_resource_collection_client__WEBPACK_IMPORTED_MODULE_0__.ResourceCollectionClient {
     /**
      * https://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets
-     */ async list() {
+     *
+     * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
+     * items in a single API call is limited.
+     * ```javascript
+     * const paginatedList = await client.list(options);
+     *```
+     *
+     * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
+     * retrieved.
+     *
+     * ```javascript
+     * for await (const singleItem of client.list(options)) {...}
+     * ```
+     */ list() {
         let options = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
         ow__WEBPACK_IMPORTED_MODULE_1___default()(options, ow__WEBPACK_IMPORTED_MODULE_1___default().object.exactShape({
             unnamed: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.boolean),
@@ -58339,7 +58434,7 @@ class DatasetCollectionClient extends _base_resource_collection_client__WEBPACK_
             offset: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.number),
             desc: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.boolean)
         }));
-        return this._list(options);
+        return this._listPaginated(options);
     }
     /**
      * https://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset
@@ -58609,7 +58704,20 @@ __webpack_require__.d(__webpack_exports__, {
 class KeyValueStoreCollectionClient extends _base_resource_collection_client__WEBPACK_IMPORTED_MODULE_0__.ResourceCollectionClient {
     /**
      * https://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores
-     */ async list() {
+     *
+     * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
+     * items in a single API call is limited.
+     * ```javascript
+     * const paginatedList = await client.list(options);
+     *```
+     *
+     * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
+     * retrieved.
+     *
+     * ```javascript
+     * for await (const singleItem of client.list(options)) {...}
+     * ```
+     */ list() {
         let options = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
         ow__WEBPACK_IMPORTED_MODULE_1___default()(options, ow__WEBPACK_IMPORTED_MODULE_1___default().object.exactShape({
             unnamed: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.boolean),
@@ -58617,7 +58725,7 @@ class KeyValueStoreCollectionClient extends _base_resource_collection_client__WE
             offset: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.number),
             desc: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.boolean)
         }));
-        return this._list(options);
+        return this._listPaginated(options);
     }
     /**
      * https://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store
@@ -59276,7 +59384,20 @@ __webpack_require__.d(__webpack_exports__, {
 class RequestQueueCollectionClient extends _base_resource_collection_client__WEBPACK_IMPORTED_MODULE_0__.ResourceCollectionClient {
     /**
      * https://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues
-     */ async list() {
+     *
+     * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
+     * items in a single API call is limited.
+     * ```javascript
+     * const paginatedList = await client.list(options);
+     *```
+     *
+     * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
+     * retrieved.
+     *
+     * ```javascript
+     * for await (const singleItem of client.list(options)) {...}
+     * ```
+     */ list() {
         let options = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
         ow__WEBPACK_IMPORTED_MODULE_1___default()(options, ow__WEBPACK_IMPORTED_MODULE_1___default().object.exactShape({
             unnamed: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.boolean),
@@ -59284,7 +59405,7 @@ class RequestQueueCollectionClient extends _base_resource_collection_client__WEB
             offset: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.number),
             desc: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.boolean)
         }));
-        return this._list(options);
+        return this._listPaginated(options);
     }
     /**
      * https://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue
@@ -59571,7 +59692,20 @@ __webpack_require__.d(__webpack_exports__, {
 class RunCollectionClient extends _base_resource_collection_client__WEBPACK_IMPORTED_MODULE_1__.ResourceCollectionClient {
     /**
      * https://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs
-     */ async list() {
+     *
+     * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
+     * items in a single API call is limited.
+     * ```javascript
+     * const paginatedList = await client.list(options);
+     *```
+     *
+     * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
+     * retrieved.
+     *
+     * ```javascript
+     * for await (const singleItem of client.list(options)) {...}
+     * ```
+     */ list() {
         let options = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
         ow__WEBPACK_IMPORTED_MODULE_2___default()(options, ow__WEBPACK_IMPORTED_MODULE_2___default().object.exactShape({
             limit: (ow__WEBPACK_IMPORTED_MODULE_2___default().optional.number),
@@ -59581,7 +59715,7 @@ class RunCollectionClient extends _base_resource_collection_client__WEBPACK_IMPO
             startedBefore: ow__WEBPACK_IMPORTED_MODULE_2___default().optional.any((ow__WEBPACK_IMPORTED_MODULE_2___default().optional.date), (ow__WEBPACK_IMPORTED_MODULE_2___default().optional.string)),
             startedAfter: ow__WEBPACK_IMPORTED_MODULE_2___default().optional.any((ow__WEBPACK_IMPORTED_MODULE_2___default().optional.date), (ow__WEBPACK_IMPORTED_MODULE_2___default().optional.string))
         }));
-        return this._list(options);
+        return this._listPaginated(options);
     }
     /**
      * @hidden
@@ -59673,14 +59807,27 @@ __webpack_require__.d(__webpack_exports__, {
 class ScheduleCollectionClient extends _base_resource_collection_client__WEBPACK_IMPORTED_MODULE_0__.ResourceCollectionClient {
     /**
      * https://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules
-     */ async list() {
+     *
+     * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
+     * items in a single API call is limited.
+     * ```javascript
+     * const paginatedList = await client.list(options);
+     *```
+     *
+     * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
+     * retrieved.
+     *
+     * ```javascript
+     * for await (const singleItem of client.list(options)) {...}
+     * ```
+     */ list() {
         let options = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
         ow__WEBPACK_IMPORTED_MODULE_1___default()(options, ow__WEBPACK_IMPORTED_MODULE_1___default().object.exactShape({
             limit: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.number),
             offset: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.number),
             desc: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.boolean)
         }));
-        return this._list(options);
+        return this._listPaginated(options);
     }
     /**
      * https://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule
@@ -59714,7 +59861,20 @@ __webpack_require__.d(__webpack_exports__, {
 class StoreCollectionClient extends _base_resource_collection_client__WEBPACK_IMPORTED_MODULE_0__.ResourceCollectionClient {
     /**
      * https://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store
-     */ async list() {
+     *
+     * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
+     * items in a single API call is limited.
+     * ```javascript
+     * const paginatedList = await client.list(options);
+     *```
+     *
+     * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
+     * retrieved.
+     *
+     * ```javascript
+     * for await (const singleItem of client.list(options)) {...}
+     * ```
+     */ list() {
         let options = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
         ow__WEBPACK_IMPORTED_MODULE_1___default()(options, ow__WEBPACK_IMPORTED_MODULE_1___default().object.exactShape({
             limit: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.number),
@@ -59725,7 +59885,7 @@ class StoreCollectionClient extends _base_resource_collection_client__WEBPACK_IM
             username: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.string),
             pricingModel: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.string)
         }));
-        return this._list(options);
+        return this._listPaginated(options);
     }
     /**
      * @hidden
@@ -59928,15 +60088,28 @@ class TaskCollectionClient extends _base_resource_collection_client__WEBPACK_IMP
      * @param {number} [options.limit]
      * @param {number} [options.offset]
      * @param {boolean} [options.desc]
-     * @return {Promise<PaginationList>}
-     */ async list() {
+     * @return {PaginatedIterator<TaskList>}
+     *
+     * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
+     * items in a single API call is limited.
+     * ```javascript
+     * const paginatedList = await client.list(options);
+     *```
+     *
+     * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
+     * retrieved.
+     *
+     * ```javascript
+     * for await (const singleItem of client.list(options)) {...}
+     * ```
+     */ list() {
         let options = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
         ow__WEBPACK_IMPORTED_MODULE_1___default()(options, ow__WEBPACK_IMPORTED_MODULE_1___default().object.exactShape({
             limit: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.number),
             offset: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.number),
             desc: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.boolean)
         }));
-        return this._list(options);
+        return this._listPaginated(options);
     }
     /**
      * https://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task
@@ -60122,14 +60295,27 @@ __webpack_require__.d(__webpack_exports__, {
 class WebhookCollectionClient extends _base_resource_collection_client__WEBPACK_IMPORTED_MODULE_0__.ResourceCollectionClient {
     /**
      * https://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks
-     */ async list() {
+     *
+     * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
+     * items in a single API call is limited.
+     * ```javascript
+     * const paginatedList = await client.list(options);
+     *```
+     *
+     * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
+     * retrieved.
+     *
+     * ```javascript
+     * for await (const singleItem of client.list(options)) {...}
+     * ```
+     */ list() {
         let options = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
         ow__WEBPACK_IMPORTED_MODULE_1___default()(options, ow__WEBPACK_IMPORTED_MODULE_1___default().object.exactShape({
             limit: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.number),
             offset: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.number),
             desc: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.boolean)
         }));
-        return this._list(options);
+        return this._listPaginated(options);
     }
     /**
      * https://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook
@@ -60196,14 +60382,27 @@ __webpack_require__.d(__webpack_exports__, {
 class WebhookDispatchCollectionClient extends _base_resource_collection_client__WEBPACK_IMPORTED_MODULE_0__.ResourceCollectionClient {
     /**
      * https://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches
-     */ async list() {
+     *
+     * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
+     * items in a single API call is limited.
+     * ```javascript
+     * const paginatedList = await client.list(options);
+     *```
+     *
+     * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
+     * retrieved.
+     *
+     * ```javascript
+     * for await (const singleItem of client.list(options)) {...}
+     * ```
+     */ list() {
         let options = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
         ow__WEBPACK_IMPORTED_MODULE_1___default()(options, ow__WEBPACK_IMPORTED_MODULE_1___default().object.exactShape({
             limit: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.number),
             offset: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.number),
             desc: (ow__WEBPACK_IMPORTED_MODULE_1___default().optional.boolean)
         }));
-        return this._list(options);
+        return this._listPaginated(options);
     }
     /**
      * @hidden
@@ -60417,7 +60616,7 @@ function isStream(value) {
 function getVersionData() {
     if (true) {
         return {
-            version: "2.20.1-beta.3"
+            version: "2.20.1-beta.4"
         };
     }
     // eslint-disable-next-line
@@ -70327,7 +70526,7 @@ module.exports = JSON.parse('{"name":"escodegen","description":"ECMAScript code
 }),
 "./package.json": (function (module) {
 "use strict";
-module.exports = JSON.parse('{"name":"apify-client","version":"2.20.1-beta.3","description":"Apify API client for JavaScript","main":"dist/index.js","module":"dist/index.mjs","types":"dist/index.d.ts","browser":"dist/bundle.js","unpkg":"dist/bundle.js","exports":{"./package.json":"./package.json",".":{"import":"./dist/index.mjs","require":"./dist/index.js","types":"./dist/index.d.ts","browser":"./dist/bundle.js"}},"keywords":["apify","api","apifier","crawler","scraper"],"author":{"name":"Apify","email":"support@apify.com","url":"https://apify.com"},"contributors":["Jan Curn <jan@apify.com>","Marek Trunkát <marek@apify.com>","Ondra Urban <ondra@apify.com>","Jakub Drobník <jakub.drobnik@apify.com>"],"license":"Apache-2.0","repository":{"type":"git","url":"git+https://github.com/apify/apify-client-js"},"bugs":{"url":"https://github.com/apify/apify-client-js/issues"},"homepage":"https://docs.apify.com/api/client/js/","files":["dist","!dist/*.tsbuildinfo"],"scripts":{"build":"npm run clean && npm run build:node && npm run build:browser","postbuild":"gen-esm-wrapper dist/index.js dist/index.mjs","prepublishOnly":"(test $CI || (echo \\"Publishing is reserved to CI!\\"; exit 1))","clean":"rimraf dist","test":"npm run build && jest","lint":"eslint","lint:fix":"eslint --fix","tsc-check-tests":"tsc --noEmit --project test/tsconfig.json","format":"prettier --write .","format:check":"prettier --check .","build:node":"tsc","build:browser":"rsbuild build"},"dependencies":{"@apify/consts":"^2.42.0","@apify/log":"^2.2.6","@apify/utilities":"^2.23.2","@crawlee/types":"^3.3.0","ansi-colors":"^4.1.1","async-retry":"^1.3.3","axios":"^1.6.7","content-type":"^1.0.5","ow":"^0.28.2","proxy-agent":"^6.5.0","tslib":"^2.5.0","type-fest":"^4.0.0"},"devDependencies":{"@apify/eslint-config":"^1.0.0","@apify/tsconfig":"^0.1.1","@babel/cli":"^7.21.0","@babel/core":"^7.21.0","@babel/preset-env":"^7.20.2","@babel/register":"^7.21.0","@crawlee/puppeteer":"^3.2.2","@rsbuild/core":"^1.3.6","@rsbuild/plugin-node-polyfill":"^1.3.0","@stylistic/eslint-plugin-ts":"^4.2.0","@types/async-retry":"^1.4.5","@types/content-type":"^1.1.5","@types/express":"^5.0.0","@types/fs-extra":"^11.0.1","@types/jest":"^29.4.0","@types/node":"^24.0.0","ajv":"^8.17.1","babel-loader":"^10.0.0","body-parser":"^1.20.3","compression":"^1.7.4","eslint":"^9.24.0","eslint-config-prettier":"^10.1.2","express":"^5.0.0","fs-extra":"^11.1.0","gen-esm-wrapper":"^1.1.2","globals":"^16.0.0","jest":"^29.4.3","prettier":"^3.5.3","process":"^0.11.10","puppeteer":"^24.0.0","rimraf":"^6.0.0","source-map-support":"^0.5.21","ts-jest":"^29.0.5","ts-loader":"^9.4.2","ts-node":"^10.9.1","typescript":"^5.8.3","typescript-eslint":"^8.29.1"},"packageManager":"npm@10.9.2"}')
+module.exports = JSON.parse('{"name":"apify-client","version":"2.20.1-beta.4","description":"Apify API client for JavaScript","main":"dist/index.js","module":"dist/index.mjs","types":"dist/index.d.ts","browser":"dist/bundle.js","unpkg":"dist/bundle.js","exports":{"./package.json":"./package.json",".":{"import":"./dist/index.mjs","require":"./dist/index.js","types":"./dist/index.d.ts","browser":"./dist/bundle.js"}},"keywords":["apify","api","apifier","crawler","scraper"],"author":{"name":"Apify","email":"support@apify.com","url":"https://apify.com"},"contributors":["Jan Curn <jan@apify.com>","Marek Trunkát <marek@apify.com>","Ondra Urban <ondra@apify.com>","Jakub Drobník <jakub.drobnik@apify.com>"],"license":"Apache-2.0","repository":{"type":"git","url":"git+https://github.com/apify/apify-client-js"},"bugs":{"url":"https://github.com/apify/apify-client-js/issues"},"homepage":"https://docs.apify.com/api/client/js/","files":["dist","!dist/*.tsbuildinfo"],"scripts":{"build":"npm run clean && npm run build:node && npm run build:browser","postbuild":"gen-esm-wrapper dist/index.js dist/index.mjs","prepublishOnly":"(test $CI || (echo \\"Publishing is reserved to CI!\\"; exit 1))","clean":"rimraf dist","test":"npm run build && jest","lint":"eslint","lint:fix":"eslint --fix","tsc-check-tests":"tsc --noEmit --project test/tsconfig.json","format":"prettier --write .","format:check":"prettier --check .","build:node":"tsc","build:browser":"rsbuild build"},"dependencies":{"@apify/consts":"^2.42.0","@apify/log":"^2.2.6","@apify/utilities":"^2.23.2","@crawlee/types":"^3.3.0","ansi-colors":"^4.1.1","async-retry":"^1.3.3","axios":"^1.6.7","content-type":"^1.0.5","ow":"^0.28.2","proxy-agent":"^6.5.0","tslib":"^2.5.0","type-fest":"^4.0.0"},"devDependencies":{"@apify/eslint-config":"^1.0.0","@apify/tsconfig":"^0.1.1","@babel/cli":"^7.21.0","@babel/core":"^7.21.0","@babel/preset-env":"^7.20.2","@babel/register":"^7.21.0","@crawlee/puppeteer":"^3.2.2","@rsbuild/core":"^1.3.6","@rsbuild/plugin-node-polyfill":"^1.3.0","@stylistic/eslint-plugin-ts":"^4.2.0","@types/async-retry":"^1.4.5","@types/content-type":"^1.1.5","@types/express":"^5.0.0","@types/fs-extra":"^11.0.1","@types/jest":"^29.4.0","@types/node":"^24.0.0","ajv":"^8.17.1","babel-loader":"^10.0.0","body-parser":"^1.20.3","compression":"^1.7.4","eslint":"^9.24.0","eslint-config-prettier":"^10.1.2","express":"^5.0.0","fs-extra":"^11.1.0","gen-esm-wrapper":"^1.1.2","globals":"^16.0.0","jest":"^29.4.3","prettier":"^3.5.3","process":"^0.11.10","puppeteer":"^24.0.0","rimraf":"^6.0.0","source-map-support":"^0.5.21","ts-jest":"^29.0.5","ts-loader":"^9.4.2","ts-node":"^10.9.1","typescript":"^5.8.3","typescript-eslint":"^8.29.1"},"packageManager":"npm@10.9.2"}')
 
 }),
 
@@ -70449,7 +70648,7 @@ __webpack_require__.hu = (chunkId) => ('' + chunkId + '.' + __webpack_require__.
 })();
 // webpack/runtime/get_full_hash
 (() => {
-__webpack_require__.h = () => ("d946192b3b1c6c58")
+__webpack_require__.h = () => ("8aa4c1862aa77587")
 })();
 // webpack/runtime/get_main_filename/update manifest
 (() => {