diff --git a/src/resource_clients/actor_collection.ts b/src/resource_clients/actor_collection.ts index e9b0997c..0add7fa3 100644 --- a/src/resource_clients/actor_collection.ts +++ b/src/resource_clients/actor_collection.ts @@ -43,15 +43,11 @@ export class ActorCollectionClient extends ResourceCollectionClient { /** * Lists all Actors. * - * @param options - Pagination options. - * @returns A paginated iterator of Actors. - * @see https://docs.apify.com/api/v2/acts-get - * * 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. @@ -59,6 +55,10 @@ export class ActorCollectionClient extends ResourceCollectionClient { * ```javascript * for await (const singleItem of client.list(options)) {...} * ``` + * + * @param options - Pagination options. + * @returns A paginated iterator of Actors. + * @see https://docs.apify.com/api/v2/acts-get */ list(options: ActorCollectionListOptions = {}): PaginatedIterator { ow( diff --git a/src/resource_clients/actor_env_var_collection.ts b/src/resource_clients/actor_env_var_collection.ts index 9126fd9a..a215922c 100644 --- a/src/resource_clients/actor_env_var_collection.ts +++ b/src/resource_clients/actor_env_var_collection.ts @@ -45,15 +45,11 @@ export class ActorEnvVarCollectionClient extends ResourceCollectionClient { /** * Lists all environment variables of this Actor version. * - * @param options - Pagination options. - * @returns A paginated iterator of environment variables. - * @see https://docs.apify.com/api/v2/act-version-env-vars-get - * * 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. @@ -61,6 +57,10 @@ export class ActorEnvVarCollectionClient extends ResourceCollectionClient { * ```javascript * for await (const singleItem of client.list(options)) {...} * ``` + * + * @param options - Pagination options. + * @returns A paginated iterator of environment variables. + * @see https://docs.apify.com/api/v2/act-version-env-vars-get */ list( options: ActorEnvVarCollectionListOptions = {}, diff --git a/src/resource_clients/actor_version_collection.ts b/src/resource_clients/actor_version_collection.ts index 0479814c..f4b9d67f 100644 --- a/src/resource_clients/actor_version_collection.ts +++ b/src/resource_clients/actor_version_collection.ts @@ -43,15 +43,11 @@ export class ActorVersionCollectionClient extends ResourceCollectionClient { /** * Lists all Actor versions. * - * @param options - Pagination options. - * @returns A paginated iterator of Actor versions. - * @see https://docs.apify.com/api/v2/act-versions-get - * * 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. @@ -59,6 +55,10 @@ export class ActorVersionCollectionClient extends ResourceCollectionClient { * ```javascript * for await (const singleItem of client.list(options)) {...} * ``` + * + * @param options - Pagination options. + * @returns A paginated iterator of Actor versions. + * @see https://docs.apify.com/api/v2/act-versions-get */ list( options: ActorVersionCollectionListOptions = {}, diff --git a/src/resource_clients/build_collection.ts b/src/resource_clients/build_collection.ts index 71498552..bb7b0d58 100644 --- a/src/resource_clients/build_collection.ts +++ b/src/resource_clients/build_collection.ts @@ -40,15 +40,11 @@ export class BuildCollectionClient extends ResourceCollectionClient { /** * Lists all Actor builds. * - * @param options - Pagination and sorting options. - * @returns A paginated iterator of Actor builds. - * @see https://docs.apify.com/api/v2/actor-builds-get - * * 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. @@ -56,6 +52,10 @@ export class BuildCollectionClient extends ResourceCollectionClient { * ```javascript * for await (const singleItem of client.list(options)) {...} * ``` + * + * @param options - Pagination and sorting options. + * @returns A paginated iterator of Actor builds. + * @see https://docs.apify.com/api/v2/actor-builds-get */ list(options: BuildCollectionClientListOptions = {}): PaginatedIterator { ow( diff --git a/src/resource_clients/dataset_collection.ts b/src/resource_clients/dataset_collection.ts index b9d2faba..2d7fdf17 100644 --- a/src/resource_clients/dataset_collection.ts +++ b/src/resource_clients/dataset_collection.ts @@ -39,15 +39,11 @@ export class DatasetCollectionClient extends ResourceCollectionClient { /** * Lists all Datasets. * - * @param options - Pagination options. - * @returns A paginated iterator of Datasets. - * @see https://docs.apify.com/api/v2/datasets-get - * * 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. @@ -55,6 +51,10 @@ export class DatasetCollectionClient extends ResourceCollectionClient { * ```javascript * for await (const singleItem of client.list(options)) {...} * ``` + * + * @param options - Pagination options. + * @returns A paginated iterator of Datasets. + * @see https://docs.apify.com/api/v2/datasets-get */ list(options: DatasetCollectionClientListOptions = {}): PaginatedIterator { ow( diff --git a/src/resource_clients/key_value_store_collection.ts b/src/resource_clients/key_value_store_collection.ts index 902efcd9..c2fe0670 100644 --- a/src/resource_clients/key_value_store_collection.ts +++ b/src/resource_clients/key_value_store_collection.ts @@ -39,15 +39,11 @@ export class KeyValueStoreCollectionClient extends ResourceCollectionClient { /** * Lists all Key-value stores. * - * @param options - Pagination options. - * @returns A paginated iterator of Key-value stores. - * @see https://docs.apify.com/api/v2/key-value-stores-get - * * 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. @@ -55,6 +51,10 @@ export class KeyValueStoreCollectionClient extends ResourceCollectionClient { * ```javascript * for await (const singleItem of client.list(options)) {...} * ``` + * + * @param options - Pagination options. + * @returns A paginated iterator of Key-value stores. + * @see https://docs.apify.com/api/v2/key-value-stores-get */ list( options: KeyValueStoreCollectionClientListOptions = {}, diff --git a/src/resource_clients/request_queue_collection.ts b/src/resource_clients/request_queue_collection.ts index f73e323f..9bd422bc 100644 --- a/src/resource_clients/request_queue_collection.ts +++ b/src/resource_clients/request_queue_collection.ts @@ -39,15 +39,11 @@ export class RequestQueueCollectionClient extends ResourceCollectionClient { /** * Lists all Request queues. * - * @param options - Pagination options. - * @returns A paginated iterator of Request queues. - * @see https://docs.apify.com/api/v2/request-queues-get - * * 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. @@ -55,6 +51,10 @@ export class RequestQueueCollectionClient extends ResourceCollectionClient { * ```javascript * for await (const singleItem of client.list(options)) {...} * ``` + * + * @param options - Pagination options. + * @returns A paginated iterator of Request queues. + * @see https://docs.apify.com/api/v2/request-queues-get */ list( options: RequestQueueCollectionListOptions = {}, diff --git a/src/resource_clients/run_collection.ts b/src/resource_clients/run_collection.ts index 13efe734..1622dd04 100644 --- a/src/resource_clients/run_collection.ts +++ b/src/resource_clients/run_collection.ts @@ -42,15 +42,11 @@ export class RunCollectionClient extends ResourceCollectionClient { /** * Lists all Actor runs. * - * @param options - Pagination and filtering options. - * @returns A paginated iterator of Actor runs. - * @see https://docs.apify.com/api/v2/actor-runs-get - * * 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. @@ -58,6 +54,10 @@ export class RunCollectionClient extends ResourceCollectionClient { * ```javascript * for await (const singleItem of client.list(options)) {...} * ``` + * + * @param options - Pagination and filtering options. + * @returns A paginated iterator of Actor runs. + * @see https://docs.apify.com/api/v2/actor-runs-get */ list(options: RunCollectionListOptions = {}): PaginatedIterator { ow( diff --git a/src/resource_clients/schedule_collection.ts b/src/resource_clients/schedule_collection.ts index fa0d43fa..7b35397e 100644 --- a/src/resource_clients/schedule_collection.ts +++ b/src/resource_clients/schedule_collection.ts @@ -43,15 +43,11 @@ export class ScheduleCollectionClient extends ResourceCollectionClient { /** * Lists all schedules. * - * @param options - Pagination and sorting options. - * @returns A paginated iterator of schedules. - * @see https://docs.apify.com/api/v2/schedules-get - * * 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. @@ -59,6 +55,10 @@ export class ScheduleCollectionClient extends ResourceCollectionClient { * ```javascript * for await (const singleItem of client.list(options)) {...} * ``` + * + * @param options - Pagination and sorting options. + * @returns A paginated iterator of schedules. + * @see https://docs.apify.com/api/v2/schedules-get */ list(options: ScheduleCollectionListOptions = {}): PaginatedIterator { ow( diff --git a/src/resource_clients/store_collection.ts b/src/resource_clients/store_collection.ts index f5ecbc88..14365e68 100644 --- a/src/resource_clients/store_collection.ts +++ b/src/resource_clients/store_collection.ts @@ -39,15 +39,11 @@ export class StoreCollectionClient extends ResourceCollectionClient { /** * Lists Actors from the Apify Store. * - * @param options - Search and pagination options. - * @returns A paginated iterator of store Actors. - * @see https://docs.apify.com/api/v2/store-actors-get - * * 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. @@ -55,6 +51,10 @@ export class StoreCollectionClient extends ResourceCollectionClient { * ```javascript * for await (const singleItem of client.list(options)) {...} * ``` + * + * @param options - Search and pagination options. + * @returns A paginated iterator of store Actors. + * @see https://docs.apify.com/api/v2/store-actors-get */ list(options: StoreCollectionListOptions = {}): PaginatedIterator { ow( diff --git a/src/resource_clients/task_collection.ts b/src/resource_clients/task_collection.ts index 0e88780c..2c5a9833 100644 --- a/src/resource_clients/task_collection.ts +++ b/src/resource_clients/task_collection.ts @@ -43,15 +43,11 @@ export class TaskCollectionClient extends ResourceCollectionClient { /** * Lists all Tasks. * - * @param options - Pagination and sorting options. - * @returns A paginated iterator of tasks. - * @see https://docs.apify.com/api/v2/actor-tasks-get - * * 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. @@ -59,6 +55,10 @@ export class TaskCollectionClient extends ResourceCollectionClient { * ```javascript * for await (const singleItem of client.list(options)) {...} * ``` + * + * @param options - Pagination and sorting options. + * @returns A paginated iterator of tasks. + * @see https://docs.apify.com/api/v2/actor-tasks-get */ list(options: TaskCollectionListOptions = {}): PaginatedIterator { ow( diff --git a/src/resource_clients/webhook_collection.ts b/src/resource_clients/webhook_collection.ts index f5699d8d..1eaa6781 100644 --- a/src/resource_clients/webhook_collection.ts +++ b/src/resource_clients/webhook_collection.ts @@ -42,15 +42,11 @@ export class WebhookCollectionClient extends ResourceCollectionClient { /** * Lists all Webhooks. * - * @param options - Pagination and sorting options. - * @returns A paginated iterator of webhooks. - * @see https://docs.apify.com/api/v2/webhooks-get - * * 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. @@ -58,6 +54,10 @@ export class WebhookCollectionClient extends ResourceCollectionClient { * ```javascript * for await (const singleItem of client.list(options)) {...} * ``` + * + * @param options - Pagination and sorting options. + * @returns A paginated iterator of webhooks. + * @see https://docs.apify.com/api/v2/webhooks-get */ list( diff --git a/src/resource_clients/webhook_dispatch_collection.ts b/src/resource_clients/webhook_dispatch_collection.ts index 0ac947aa..73823ad7 100644 --- a/src/resource_clients/webhook_dispatch_collection.ts +++ b/src/resource_clients/webhook_dispatch_collection.ts @@ -37,15 +37,11 @@ export class WebhookDispatchCollectionClient extends ResourceCollectionClient { /** * Lists all webhook dispatches. * - * @param options - Pagination and sorting options. - * @returns A paginated iterator of webhook dispatches. - * @see https://docs.apify.com/api/v2/webhook-dispatches-get - * * 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. @@ -53,6 +49,10 @@ export class WebhookDispatchCollectionClient extends ResourceCollectionClient { * ```javascript * for await (const singleItem of client.list(options)) {...} * ``` + * + * @param options - Pagination and sorting options. + * @returns A paginated iterator of webhook dispatches. + * @see https://docs.apify.com/api/v2/webhook-dispatches-get */ list(options: WebhookDispatchCollectionListOptions = {}): PaginatedIterator { ow(